-
Notifications
You must be signed in to change notification settings - Fork 33
other types of comparisons for parameter based automatic query #892
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
njr-11
wants to merge
4
commits into
jakartaee:main
Choose a base branch
from
njr-11:857-allow-other-comparisons-for-parameter-based-automatic-queries
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
efe4f1e
Issue #857 more types of comparisons for parameter based automatic query
njr-11 e9e7e1c
Switch to String constants with capitalized names
njr-11 cd19343
Put the enumeration back, but keep the upper case, and shorten IGNORE…
njr-11 a55eeba
Reuse existing Operator enum
njr-11 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
/* | ||
* Copyright (c) 2024,2025 Contributors to the Eclipse Foundation | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
* | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
package jakarta.data.repository; | ||
|
||
import java.lang.annotation.ElementType; | ||
import java.lang.annotation.Retention; | ||
import java.lang.annotation.RetentionPolicy; | ||
import java.lang.annotation.Target; | ||
|
||
import jakarta.data.metamodel.restrict.Operator; | ||
|
||
/** | ||
* <p>Annotates a parameter of a repository {@link Find} or {@link Delete} method, | ||
* indicating that a persistent field should be compared ignoring case. | ||
* The {@link By} annotation can be used on the same parameter to identify the | ||
* persistent field. Otherwise, if the {@code -parameters} compile option is | ||
* enabled, the the persistent field is inferred by matching the name of the | ||
* method parameter. The {@link Operator#EQUAL EQUAL} comparison is assumed | ||
* unless the {@link Is} annotation is used on the same parameter to choose a | ||
* different type of comparison.</p> | ||
* | ||
* <p>For example,</p> | ||
* | ||
* <pre> | ||
* @Repository | ||
* public interface People extends BasicRepository<Person, Long> { | ||
* | ||
* // Find all Person entities where the lastName matches the respective value | ||
* // ignoring case. | ||
* @Find | ||
* List<Person> withSurname(@By(_Person.LASTNAME) @IgnoreCase String surname); | ||
* | ||
* // Find a page of Person entities where the lastName field begins with the | ||
* // supplied prefix, ignoring case. | ||
* @Find | ||
* Page<Person> withSurnamePrefix(@By(_Product.LASTNAME) @Is(PREFIXED) @IgnoreCase String prefix, | ||
* PageRequest pagination, | ||
* Order<Person> order); | ||
* } | ||
* </pre> | ||
*/ | ||
@Retention(RetentionPolicy.RUNTIME) | ||
@Target(ElementType.PARAMETER) | ||
public @interface IgnoreCase { | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
/* | ||
* Copyright (c) 2024,2025 Contributors to the Eclipse Foundation | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
* | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
package jakarta.data.repository; | ||
|
||
import java.lang.annotation.ElementType; | ||
import java.lang.annotation.Retention; | ||
import java.lang.annotation.RetentionPolicy; | ||
import java.lang.annotation.Target; | ||
|
||
import jakarta.data.metamodel.restrict.Operator; | ||
|
||
/** | ||
* <p>Annotates a parameter of a repository {@link Find} or {@link Delete} method, | ||
* indicating how a persistent field is compared against the parameter's value. | ||
* The {@link By} annotation can be used on the same parameter to identify the | ||
* persistent field. Otherwise, if the {@code -parameters} compile option is | ||
* enabled, the the persistent field is inferred by matching the name of the | ||
* method parameter.</p> | ||
* | ||
* <p>For example,</p> | ||
* | ||
* <pre> | ||
* @Repository | ||
* public interface Products extends CrudRepository<Product, Long> { | ||
* | ||
* // Find all Product entities where the price field is less than a maximum value. | ||
* @Find | ||
* List<Product> pricedBelow(@By(_Product.PRICE) @Is(LESS_THAN) float max); | ||
* | ||
* // Find a page of Product entities where the name field matches a pattern, ignoring case. | ||
* @Find | ||
* Page<Product> search(@By(_Product.NAME) @Is(LIKE) @IgnoreCase String pattern, | ||
* PageRequest pagination, | ||
* Order<Product> order); | ||
* | ||
* // Remove Product entities with any of the unique identifiers listed. | ||
* @Delete | ||
* void remove(@By(ID) @Is(IN) List<Long> productIds); | ||
* } | ||
* </pre> | ||
*/ | ||
@Retention(RetentionPolicy.RUNTIME) | ||
@Target(ElementType.PARAMETER) | ||
public @interface Is { | ||
|
||
/** | ||
* <p>The type of comparison operation to use when comparing a persistent | ||
* field against a value that is supplied to a repository method..</p> | ||
* | ||
* <p>The following example compares the year a person was born against | ||
* a minimum and maximum year that are supplied as parameters to a repository | ||
* method:</p> | ||
* | ||
* <pre> | ||
* @Find | ||
* @OrderBy(_Person.YEAR_BORN) | ||
* List<Person> bornWithin(@By(_Person.YEAR_BORN) @Is(GREATER_THAN_EQUAL) float minYear, | ||
* @By(_Person.YEAR_BORN) @Is(LESS_THAN_EQUAL) float maxYear); | ||
* </pre> | ||
* | ||
* <p>The default comparison operation is the {@linkplain Operator#EQUAL equality} | ||
* comparison.</p> | ||
* | ||
* <p>For concise code, it can be convenient for a repository interface to | ||
* statically import one or more constants from this class. For example:</p> | ||
* | ||
* <pre> | ||
* import static jakarta.data.metamodel.restrict.Operator.*; | ||
* </pre> | ||
* | ||
* @return the type of comparison operation. | ||
*/ | ||
Operator value() default Operator.EQUAL; | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW I would not add these unless we were also going to add equivalent operations to JDQL.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In JDQL, these are
LEFT
andRIGHT
(and substring/contains comes from usingLIKE
in a particular way - that one is less direct). I copied them over from theIs
annotation to avoid losing track of them. If this does go in, there will need to be discussion over what the exact list should be.