DATAMONGO-888 - Mapping should be applied to Sort.

Query.getSortObject() is passed through QueryMapper in order to retrieve mapped field values.

Original Pull Request: #162

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java

@@ -66,12 +66,10 @@
 import org.springframework.data.mongodb.core.aggregation.TypedAggregation;
 import org.springframework.data.mongodb.core.convert.DbRefResolver;
 import org.springframework.data.mongodb.core.convert.DefaultDbRefResolver;
-import org.springframework.data.mongodb.core.convert.EntityBackedSortConverter;
 import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
 import org.springframework.data.mongodb.core.convert.MongoConverter;
 import org.springframework.data.mongodb.core.convert.MongoWriter;
 import org.springframework.data.mongodb.core.convert.QueryMapper;
-import org.springframework.data.mongodb.core.convert.SortConverter;
 import org.springframework.data.mongodb.core.convert.UpdateMapper;
 import org.springframework.data.mongodb.core.geo.GeoResults;
 import org.springframework.data.mongodb.core.index.MongoMappingEventPublisher;
@@ -357,7 +355,7 @@ protected void logCommandExecutionError(final DBObject command, CommandResult re
 	}
 
 	public void executeQuery(Query query, String collectionName, DocumentCallbackHandler dch) {
-		executeQuery(query, collectionName, dch, new QueryCursorPreparer(query, new SortConverter()));
+		executeQuery(query, collectionName, dch, new QueryCursorPreparer(query, null));
 	}
 
 	/**
@@ -535,7 +533,7 @@ public <T> List<T> find(final Query query, Class<T> entityClass, String collecti
 		}
 
 		return doFind(collectionName, query.getQueryObject(), query.getFieldsObject(), entityClass,
-				new QueryCursorPreparer(query, new EntityBackedSortConverter(mappingContext.getPersistentEntity(entityClass))));
+				new QueryCursorPreparer(query, mappingContext.getPersistentEntity(entityClass)));
 	}
 
 	public <T> T findById(Object id, Class<T> entityClass) {
@@ -618,8 +616,7 @@ public <T> T findAndModify(Query query, Update update, FindAndModifyOptions opti
 	public <T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Class<T> entityClass,
 			String collectionName) {
 		return doFindAndModify(collectionName, query.getQueryObject(), query.getFieldsObject(),
-				new EntityBackedSortConverter(mappingContext.getPersistentEntity(entityClass)).convert(query.getSort()),
-				entityClass, update, options);
+				getMappedSortObject(query, mappingContext.getPersistentEntity(entityClass)), entityClass, update, options);
 	}
 
 	// Find methods that take a Query to express the query and that return a single object that is also removed from the
@@ -632,8 +629,7 @@ public <T> T findAndRemove(Query query, Class<T> entityClass) {
 	public <T> T findAndRemove(Query query, Class<T> entityClass, String collectionName) {
 
 		return doFindAndRemove(collectionName, query.getQueryObject(), query.getFieldsObject(),
-				new EntityBackedSortConverter(mappingContext.getPersistentEntity(entityClass)).convert(query.getSort()),
-				entityClass);
+				getMappedSortObject(query, mappingContext.getPersistentEntity(entityClass)), entityClass);
 	}
 
 	public long count(Query query, Class<?> entityClass) {
@@ -1947,6 +1943,15 @@ private static final MongoConverter getDefaultMongoConverter(MongoDbFactory fact
 		return converter;
 	}
 
+	private DBObject getMappedSortObject(Query query, MongoPersistentEntity<?> entity) {
+
+		if (query == null || query.getSortObject() == null) {
+			return null;
+		}
+
+		return queryMapper.getMappedObject(query.getSortObject(), entity);
+	}
+
 	// Callback implementations
 
 	/**
@@ -2140,13 +2145,12 @@ public WriteConcern resolve(MongoAction action) {
 	class QueryCursorPreparer implements CursorPreparer {
 
 		private final Query query;
-		private final SortConverter sortConverter;
+		private final MongoPersistentEntity<?> entity;
 
-		public QueryCursorPreparer(Query query, SortConverter sortConverter) {
+		public QueryCursorPreparer(Query query, MongoPersistentEntity<?> entity) {
 
-			Assert.notNull(sortConverter, "SortConverter must not be null");
 			this.query = query;
-			this.sortConverter = sortConverter;
+			this.entity = entity;
 		}
 
 		/*
@@ -2173,8 +2177,8 @@ public DBCursor prepare(DBCursor cursor) {
 				if (query.getLimit() > 0) {
 					cursorToUse = cursorToUse.limit(query.getLimit());
 				}
-				if (query.getSort() != null) {
-					cursorToUse = cursorToUse.sort(sortConverter.convert(query.getSort()));
+				if (query.getSortObject() != null) {
+					cursorToUse = cursorToUse.sort(getMappedSortObject(query, entity));
 				}
 				if (StringUtils.hasText(query.getHint())) {
 					cursorToUse = cursorToUse.hint(query.getHint());

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/EntityBackedSortConverter.java

@@ -39,7 +39,6 @@
  * @author Thomas Risberg
  * @author Oliver Gierke
  * @author Thomas Darimont
- * @author Christoph Strobl
  */
 public class Query {
 
@@ -229,12 +228,6 @@ public DBObject getFieldsObject() {
 		return this.fieldSpec == null ? null : fieldSpec.getFieldsObject();
 	}
 
-	/**
-	 * @return
-	 * @deprecated in 1.4.2. Use {@link org.springframework.data.mongodb.core.convert.SortConverter} and
-	 *             {@link #getSort()}.
-	 */
-	@Deprecated
 	public DBObject getSortObject() {
 
 		if (this.sort == null) {
@@ -250,14 +243,6 @@ public DBObject getSortObject() {
 		return dbo;
 	}
 
-	/**
-	 * @return
-	 * @since 1.4.2
-	 */
-	public Sort getSort() {
-		return this.sort;
-	}
-
 	/**
 	 * Get the number of documents to skip.
 	 * 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/SortConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2014 the original author or authors.
+ * Copyright 2011 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,6 @@
 import org.mockito.runners.MockitoJUnitRunner;
 import org.springframework.data.mongodb.MongoDbFactory;
 import org.springframework.data.mongodb.core.MongoTemplate.QueryCursorPreparer;
-import org.springframework.data.mongodb.core.convert.SortConverter;
 import org.springframework.data.mongodb.core.query.Query;
 
 import com.mongodb.DBCursor;
@@ -34,7 +33,6 @@
  * Unit tests for {@link QueryCursorPreparer}.
  * 
  * @author Oliver Gierke
- * @author Christoph Strobl
  */
 @RunWith(MockitoJUnitRunner.class)
 public class QueryCursorPreparerUnitTests {
@@ -50,7 +48,7 @@ public void appliesHintsCorrectly() {
 
 		Query query = query(where("foo").is("bar")).withHint("hint");
 
-		CursorPreparer preparer = new MongoTemplate(factory).new QueryCursorPreparer(query, new SortConverter());
+		CursorPreparer preparer = new MongoTemplate(factory).new QueryCursorPreparer(query, null);
 		preparer.prepare(cursor);
 
 		verify(cursor).hint("hint");