This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository topia. See http://git.nuiton.org/topia.git commit 726c9181b59941c98c8e7bc224c002086ee00a3a Author: Brendan Le Ny <bleny@codelutin.com> Date: Tue Nov 25 14:40:14 2014 +0100 Trying a better documentation for addTopiaIdEquals --- .../topia/persistence/HqlAndParametersBuilder.java | 12 ++++++++++++ .../persistence/TopiaQueryBuilderAddCriteriaStep.java | 16 +++++++++++++++- 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/HqlAndParametersBuilder.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/HqlAndParametersBuilder.java index 6b8b1c5..137218d 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/HqlAndParametersBuilder.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/HqlAndParametersBuilder.java @@ -197,20 +197,32 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { } } + /** + * @see {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdEquals(String, String)} + */ public void addTopiaIdEquals(String property, String topiaId) { Preconditions.checkNotNull(topiaId); addEquals(property + "." + TopiaEntity.PROPERTY_TOPIA_ID, topiaId); } + /** + * @see {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdIn(String, java.util.Collection)} + */ public void addTopiaIdIn(String property, Collection<String> topiaIds) { addIn(property + "." + TopiaEntity.PROPERTY_TOPIA_ID, topiaIds); } + /** + * @see {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdNotEquals(String, String)} + */ public void addTopiaIdNotEquals(String property, String topiaId) { Preconditions.checkNotNull(topiaId); addNotEquals(property + "." + TopiaEntity.PROPERTY_TOPIA_ID, topiaId); } + /** + * @see {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdNotIn(String, java.util.Collection)} + */ public void addTopiaIdNotIn(String property, Collection<String> topiaIds) { addNotIn(property + "." + TopiaEntity.PROPERTY_TOPIA_ID, (Collection) topiaIds); } diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderAddCriteriaStep.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderAddCriteriaStep.java index 149c98f..af4c045 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderAddCriteriaStep.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderAddCriteriaStep.java @@ -28,7 +28,6 @@ import org.nuiton.util.pagination.PaginationOrder; import java.util.Collection; import java.util.LinkedHashSet; -import java.util.Set; /** * Represents a step when building a query to add a constraint. @@ -99,6 +98,21 @@ public interface TopiaQueryBuilderAddCriteriaStep<E extends TopiaEntity> { * This method has the same behavior as {@link #addEquals(String, Object)} but you don't need to have the entity but * only the topiaId. * + * This method is useful when you want to do a {@link #addEquals(String, Object)} but you don't + * have the entity you want to give as an argument, you only have the topiaId. + * + * <pre> + * // given that we want to find an entity that has a boat property valued to a + * // boat which topiaId is boatId, we could write: + * + * addEquals("boat.topiaId", boatId); // boatId is a topiaId + * + * // but instead, you can write + * + * addTopiaIdEquals("boat", boatId); // boat is a topia entity + * </pre> + * + * * @param property the name of a field of the queried entity, must be a one-to-one or a many-to-one property * @param topiaId the value the topiaId of the entity must be equals to * @return the current or next step for a fluent interface usage -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.