DATAMONGO-1854 - Remove collation annotation in favor of attributes of Query / Document.

christophstrobl · mp911de · commit 33c48d08a3f1 · 2019-04-10T13:54:10.000+02:00
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentEntity.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentEntity.java
@@ -82,21 +82,13 @@ public BasicMongoPersistentEntity(TypeInformation<T> typeInformation) {
 			this.collection = StringUtils.hasText(document.collection()) ? document.collection() : fallback;
 			this.language = StringUtils.hasText(document.language()) ? document.language() : "";
 			this.expression = detectExpression(document.collection());
+			this.collation = document.collation();
+			this.collationExpression = detectExpression(document.collation());
 		} else {
 
 			this.collection = fallback;
 			this.language = "";
 			this.expression = null;
-		}
-
-		if (this.isAnnotationPresent(Collation.class)) {
-
-			Collation collation = getRequiredAnnotation(Collation.class);
-
-			this.collation = collation.value();
-			this.collationExpression = detectExpression(collation.value());
-		} else {
-
 			this.collation = null;
 			this.collationExpression = null;
 		}
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Collation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Collation.java
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Document.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Document.java
@@ -60,9 +60,17 @@
 	/**
 	 * Defines the default language to be used with this document.
 	 *
-	 * @since 1.6
 	 * @return
+	 * @since 1.6
 	 */
 	String language() default "";
 
+	/**
+	 * Defines the collation to apply when executing a query or creating indexes.
+	 *
+	 * @return an empty {@link String} by default.
+	 * @since 2.2
+	 */
+	String collation() default "";
+
 }
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/Query.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/Query.java
@@ -95,4 +95,34 @@
 	 * @since 2.1
 	 */
 	String sort() default "";
+
+	/**
+	 * Defines the collation to apply when executing the query.
+	 *
+	 * <pre class="code">
+	 * // Fixed value
+	 * &#64;Query(collation = "en_US")
+	 * List<Entry> findAllByFixedCollation();
+	 *
+	 * // Fixed value as Document
+	 * &#64;Query(collation = "{ 'locale' :  'en_US' }")
+	 * List<Entry> findAllByFixedJsonCollation();
+	 *
+	 * // Dynamic value as String
+	 * &#64;Query(collation = "?0")
+	 * List<Entry> findAllByDynamicCollation(String collation);
+	 *
+	 * // Dynamic value as Document
+	 * &#64;Query(collation = "{ 'locale' :  ?0 }")
+	 * List<Entry> findAllByDynamicJsonCollation(String collation);
+	 *
+	 * // SpEL expression
+	 * &#64;Query(collation = "?#{[0]}")
+	 * List<Entry> findAllByDynamicSpElCollation(String collation);
+	 * </pre>
+	 *
+	 * @return an empty {@link String} by default.
+	 * @since 2.2
+	 */
+	String collation() default "";
 }
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoQueryMethod.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoQueryMethod.java
@@ -28,7 +28,6 @@
 import org.springframework.data.geo.GeoResult;
 import org.springframework.data.geo.GeoResults;
 import org.springframework.data.mapping.context.MappingContext;
-import org.springframework.data.mongodb.core.mapping.Collation;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
 import org.springframework.data.mongodb.repository.Meta;
@@ -324,34 +323,29 @@ public String getAnnotatedSort() {
 	}
 
 	/**
-	 * Check if the query method is decorated with an non empty {@link Collation#collation()}.
+	 * Check if the query method is decorated with an non empty {@link Query#collation()}.
 	 *
-	 * @return true if method annotated with {@link Collation} having an non empty collation attribute.
+	 * @return true if method annotated with {@link Query} having an non empty collation attribute.
 	 * @since 2.2
 	 */
 	public boolean hasAnnotatedCollation() {
-		return lookupCollationAnnotation().map(it -> !it.collation().isEmpty()).orElse(false);
+		return lookupQueryAnnotation().map(it -> !it.collation().isEmpty()).orElse(false);
 	}
 
 	/**
-	 * Get the collation value extracted from the {@link Collation} annotation.
+	 * Get the collation value extracted from the {@link Query} annotation.
 	 *
-	 * @return the {@link Collation#collation()} value.
-	 * @throws IllegalStateException if method not annotated with {@link Collation}. Make sure to check
+	 * @return the {@link Query#collation()} value.
+	 * @throws IllegalStateException if method not annotated with {@link Query}. Make sure to check
 	 *           {@link #hasAnnotatedQuery()} first.
 	 * @since 2.2
 	 */
 	public String getAnnotatedCollation() {
 
-		return lookupCollationAnnotation().map(Collation::collation).orElseThrow(() -> new IllegalStateException(
+		return lookupQueryAnnotation().map(Query::collation).orElseThrow(() -> new IllegalStateException(
 				"Expected to find @Query annotation but did not. Make sure to check hasAnnotatedCollation() before."));
 	}
 
-	Optional<Collation> lookupCollationAnnotation() {
-		return doFindAnnotation(Collation.class);
-	}
-
-
 	@SuppressWarnings("unchecked")
 	private <A extends Annotation> Optional<A> doFindAnnotation(Class<A> annotationType) {
 
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/DefaultIndexOperationsUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/DefaultIndexOperationsUnitTests.java
@@ -113,7 +113,7 @@ static class Jedi {
 		@Field("firstname") String name;
 	}
 
-	@org.springframework.data.mongodb.core.mapping.Collation("de_AT")
+	@org.springframework.data.mongodb.core.mapping.Document(collation = "de_AT")
 	static class Sith {
 		@Field("firstname") String name;
 	}
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/DefaultReactiveIndexOperationsUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/DefaultReactiveIndexOperationsUnitTests.java
@@ -118,7 +118,7 @@ static class Jedi {
 		@Field("firstname") String name;
 	}
 
-	@org.springframework.data.mongodb.core.mapping.Collation("de_AT")
+	@org.springframework.data.mongodb.core.mapping.Document(collation = "de_AT")
 	static class Sith {
 		@Field("firstname") String name;
 	}
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/MongoTemplateUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/MongoTemplateUnitTests.java
@@ -1467,7 +1467,7 @@ static class WithNamedFields {
 		@Field("custom-named-field") String customName;
 	}
 
-	@org.springframework.data.mongodb.core.mapping.Collation("de_AT")
+	@org.springframework.data.mongodb.core.mapping.Document(collation = "de_AT")
 	static class Sith {
 
 		@Field("firstname") String name;
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/ReactiveMongoTemplateUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/ReactiveMongoTemplateUnitTests.java
@@ -694,7 +694,7 @@ static class Jedi {
 		@Field("firstname") String name;
 	}
 
-	@org.springframework.data.mongodb.core.mapping.Collation("de_AT")
+	@org.springframework.data.mongodb.core.mapping.Document(collation = "de_AT")
 	static class Sith {
 
 		@Field("firstname") String name;
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentEntityUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentEntityUnitTests.java
@@ -304,13 +304,13 @@ static class DocumentWithComposedAnnotation {}
 	@Document("#{myProperty}")
 	class MappedWithExtension {}
 
-	@Collation("#{myCollation}")
+	@Document(collation = "#{myCollation}")
 	class WithCollationFromSpEL {}
 
-	@Collation("en_US")
+	@Document(collation = "en_US")
 	class WithSimpleCollation {}
 
-	@Collation("{ 'locale' : 'en_US' }")
+	@Document(collation = "{ 'locale' : 'en_US' }")
 	class WithDocumentCollation {}
 
 	static class SampleExtension implements EvaluationContextExtension {
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/query/AbstractMongoQueryUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/query/AbstractMongoQueryUnitTests.java
@@ -16,7 +16,9 @@
 package org.springframework.data.mongodb.repository.query;
 
 import static org.assertj.core.api.Assertions.*;
-import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.*;
 
 import java.lang.reflect.Method;
@@ -33,7 +35,6 @@
 import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.mockito.junit.MockitoJUnitRunner;
-
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Pageable;
@@ -524,21 +525,21 @@ private interface Repo extends MongoRepository<Person, Long> {
 		@org.springframework.data.mongodb.repository.Query(sort = "{ age : 1 }")
 		List<Person> findByAge(Integer age, Sort page);
 
-		@org.springframework.data.mongodb.core.mapping.Collation(collation = "en_US")
+		@org.springframework.data.mongodb.repository.Query(collation = "en_US")
 		List<Person> findWithCollationUsingSpimpleStringValueByFirstName(String firstname);
 
-		@org.springframework.data.mongodb.core.mapping.Collation(collation = "{ 'locale' : 'en_US' }")
+		@org.springframework.data.mongodb.repository.Query(collation = "{ 'locale' : 'en_US' }")
 		List<Person> findWithCollationUsingDocumentByFirstName(String firstname);
 
-		@org.springframework.data.mongodb.core.mapping.Collation(collation = "?1")
+		@org.springframework.data.mongodb.repository.Query(collation = "?1")
 		List<Person> findWithCollationUsingPlaceholderByFirstName(String firstname, Object collation);
 
-		@org.springframework.data.mongodb.core.mapping.Collation(collation = "{ 'locale' : '?1' }")
+		@org.springframework.data.mongodb.repository.Query(collation = "{ 'locale' : '?1' }")
 		List<Person> findWithCollationUsingPlaceholderInDocumentByFirstName(String firstname, String collation);
 
 		List<Person> findWithCollationParameterByFirstName(String firstname, Collation collation);
 
-		@org.springframework.data.mongodb.core.mapping.Collation(collation = "{ 'locale' : 'en_US' }")
+		@org.springframework.data.mongodb.repository.Query(collation = "{ 'locale' : 'en_US' }")
 		List<Person> findWithWithCollationParameterAndAnnotationByFirstName(String firstname, Collation collation);
 	}
 
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/query/AbstractReactiveMongoQueryUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/query/AbstractReactiveMongoQueryUnitTests.java
@@ -30,7 +30,6 @@
 import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.mockito.junit.MockitoJUnitRunner;
-
 import org.springframework.data.mongodb.core.Person;
 import org.springframework.data.mongodb.core.ReactiveFindOperation.FindWithQuery;
 import org.springframework.data.mongodb.core.ReactiveFindOperation.ReactiveFind;
@@ -281,25 +280,25 @@ public ReactiveMongoQueryFake setLimitingQuery(boolean limitingQuery) {
 
 	private interface Repo extends ReactiveMongoRepository<Person, Long> {
 
-		@org.springframework.data.mongodb.core.mapping.Collation("en_US")
+		@org.springframework.data.mongodb.repository.Query(collation = "en_US")
 		List<Person> findWithCollationUsingSpimpleStringValueByFirstName(String firstname);
 
-		@org.springframework.data.mongodb.core.mapping.Collation("{ 'locale' : 'en_US' }")
+		@org.springframework.data.mongodb.repository.Query(collation = "{ 'locale' : 'en_US' }")
 		List<Person> findWithCollationUsingDocumentByFirstName(String firstname);
 
-		@org.springframework.data.mongodb.core.mapping.Collation("?1")
+		@org.springframework.data.mongodb.repository.Query(collation = "?1")
 		List<Person> findWithCollationUsingPlaceholderByFirstName(String firstname, Object collation);
 
-		@org.springframework.data.mongodb.core.mapping.Collation("{ 'locale' : '?1' }")
+		@org.springframework.data.mongodb.repository.Query(collation = "{ 'locale' : '?1' }")
 		List<Person> findWithCollationUsingPlaceholderInDocumentByFirstName(String firstname, String collation);
 
-		@org.springframework.data.mongodb.core.mapping.Collation("{ 'locale' : '?1', 'strength' : ?#{[2]}}")
+		@org.springframework.data.mongodb.repository.Query(collation = "{ 'locale' : '?1', 'strength' : ?#{[2]}}")
 		List<Person> findWithCollationUsingPlaceholdersInDocumentByFirstName(String firstname, String collation,
 				int strength);
 
 		List<Person> findWithCollationParameterByFirstName(String firstname, Collation collation);
 
-		@org.springframework.data.mongodb.core.mapping.Collation("{ 'locale' : 'en_US' }")
+		@org.springframework.data.mongodb.repository.Query(collation = "{ 'locale' : 'en_US' }")
 		List<Person> findWithWithCollationParameterAndAnnotationByFirstName(String firstname, Collation collation);
 	}
 }
diff --git a/src/main/asciidoc/reference/mongodb.adoc b/src/main/asciidoc/reference/mongodb.adoc
@@ -1691,8 +1691,8 @@ Collations can be used to create collections and indexes. If you create a collec
 collation is applied to index creation and queries unless you specify a different collation. A collation is valid for a
 whole operation and cannot be specified on a per-field basis.
 
-Like other metadata, collations can be be derived from the domain type via the `@Collation` annotation and will be applied
-directly when executing queries, creating collections or indexes.
+Like other metadata, collations can be be derived from the domain type via the `collation` attribute of the `@Document`
+annotation and will be applied directly when executing queries, creating collections or indexes.
 
 NOTE: Annotated collations will not be used when a collection is auto created by MongoDB on first interaction. This would
 require additional store interaction delaying the entire process. Please use `MongoOperations.createCollection` for those cases.
@@ -1746,29 +1746,29 @@ WARNING: Indexes are only used if the collation used for the operation matches t
 
 include::./mongo-json-schema.adoc[leveloffset=+1]
 
-<<mongo.repositories>> support `Collations` via the `@org.springframework.data.mongodb.mapping.Collation` annotation.
+<<mongo.repositories>> support `Collations` via the `collation` attribute of the `@Query` annotation.
 
 .Collation support for Repositories
 ====
 [source,java]
 ----
 public interface PersonRepository extends MongoRepository<Person, String> {
 
-  @Collation("en_US")  <1>
+  @Query(collation = "en_US")  <1>
   List<Person> findByFirstname(String firstname);
 
-  @Collation("{ 'locale' : 'en_US' }") <2>
+  @Query(collation = "{ 'locale' : 'en_US' }") <2>
   List<Person> findPersonByFirstname(String firstname);
 
-  @Collation("?1") <3>
+  @Query(collation = "?1") <3>
   List<Person> findByFirstname(String firstname, Object collation);
 
-  @Collation("{ 'locale' : '?1' }") <4>
+  @Query(collation = "{ 'locale' : '?1' }") <4>
   List<Person> findByFirstname(String firstname, String collation);
 
   List<Person> findByFirstname(String firstname, Collation collation); <5>
 
-  @Collation("{ 'locale' : 'en_US' }")
+  @Query(collation = "{ 'locale' : 'en_US' }")
   List<Person> findByFirstname(String firstname, @Nullable Collation collation); <6>
 }
 ----

Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ static class Jedi {`
`113`	`113`	`@Field("firstname") String name;`
`114`	`114`	`}`
`115`	`115`
`116`		`- @org.springframework.data.mongodb.core.mapping.Collation("de_AT")`
	`116`	`+ @org.springframework.data.mongodb.core.mapping.Document(collation = "de_AT")`
`117`	`117`	`static class Sith {`
`118`	`118`	`@Field("firstname") String name;`
`119`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ static class Jedi {`
`118`	`118`	`@Field("firstname") String name;`
`119`	`119`	`}`
`120`	`120`
`121`		`- @org.springframework.data.mongodb.core.mapping.Collation("de_AT")`
	`121`	`+ @org.springframework.data.mongodb.core.mapping.Document(collation = "de_AT")`
`122`	`122`	`static class Sith {`
`123`	`123`	`@Field("firstname") String name;`
`124`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1467,7 +1467,7 @@ static class WithNamedFields {`
`1467`	`1467`	`@Field("custom-named-field") String customName;`
`1468`	`1468`	`}`
`1469`	`1469`
`1470`		`- @org.springframework.data.mongodb.core.mapping.Collation("de_AT")`
	`1470`	`+ @org.springframework.data.mongodb.core.mapping.Document(collation = "de_AT")`
`1471`	`1471`	`static class Sith {`
`1472`	`1472`
`1473`	`1473`	`@Field("firstname") String name;`
Original file line number	Diff line number	Diff line change
`@@ -694,7 +694,7 @@ static class Jedi {`
`694`	`694`	`@Field("firstname") String name;`
`695`	`695`	`}`
`696`	`696`
`697`		`- @org.springframework.data.mongodb.core.mapping.Collation("de_AT")`
	`697`	`+ @org.springframework.data.mongodb.core.mapping.Document(collation = "de_AT")`
`698`	`698`	`static class Sith {`
`699`	`699`
`700`	`700`	`@Field("firstname") String name;`