DATAMONGO-1188 - Add suport for findAndModify in query derivation.

We now support findAndModify operations on derived query methods.

Author: Thomas Darimont

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/AbstractMongoQuery.java

@@ -31,6 +31,7 @@
 import org.springframework.data.mongodb.core.MongoOperations;
 import org.springframework.data.mongodb.core.query.NearQuery;
 import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.repository.query.ParameterAccessor;
 import org.springframework.data.repository.query.RepositoryQuery;
 import org.springframework.data.util.CloseableIterator;
@@ -101,6 +102,11 @@ public Object execute(Object[] parameters) {
 		} else if (method.isSliceQuery()) {
 			return new SlicedExecution(accessor.getPageable()).execute(query);
 		} else if (method.isCollectionQuery()) {
+
+			if (method.isModifyingQuery()) {
+				return new UpdatingCollectionExecution(accessor.getPageable(), accessor.getUpdate()).execute(query);
+			}
+
 			return new CollectionExecution(accessor.getPageable()).execute(query);
 		} else if (method.isPageQuery()) {
 			return new PagedExecution(accessor.getPageable()).execute(query);
@@ -194,6 +200,30 @@ public Object execute(Query query) {
 		}
 	}
 
+	/**
+	 * {@link Execution} for collection returning find and update queries.
+	 * 
+	 * @author Thomas Darimont
+	 */
+	final class UpdatingCollectionExecution extends Execution {
+
+		private final Pageable pageable;
+		private final Update update;
+
+		UpdatingCollectionExecution(Pageable pageable, Update update) {
+			this.pageable = pageable;
+			this.update = update;
+		}
+
+		@Override
+		Object execute(Query query) {
+
+			MongoEntityMetadata<?> metadata = method.getEntityInformation();
+			return operations.findAndModify(query.with(pageable), update, metadata.getJavaType(),
+					metadata.getCollectionName());
+		}
+	}
+
 	/**
 	 * {@link Execution} for {@link Slice} query methods.
 	 * 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/ConvertingParameterAccessor.java

@@ -29,6 +29,7 @@
 import org.springframework.data.mongodb.core.convert.MongoWriter;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
 import org.springframework.data.mongodb.core.query.TextCriteria;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.repository.query.ParameterAccessor;
 import org.springframework.data.util.TypeInformation;
 import org.springframework.util.Assert;
@@ -255,4 +256,11 @@ public interface PotentiallyConvertingIterator extends Iterator<Object> {
 		Object nextConverted(MongoPersistentProperty property);
 	}
 
+	/* (non-Javadoc)
+	 * @see org.springframework.data.mongodb.repository.query.MongoParameterAccessor#getUpdate()
+	 */
+	@Override
+	public Update getUpdate() {
+		return delegate.getUpdate();
+	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoParameterAccessor.java

@@ -19,13 +19,15 @@
 import org.springframework.data.geo.Distance;
 import org.springframework.data.geo.Point;
 import org.springframework.data.mongodb.core.query.TextCriteria;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.repository.query.ParameterAccessor;
 
 /**
  * Mongo-specific {@link ParameterAccessor} exposing a maximum distance parameter.
  * 
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Thomas Darimont
  */
 public interface MongoParameterAccessor extends ParameterAccessor {
 
@@ -51,4 +53,12 @@ public interface MongoParameterAccessor extends ParameterAccessor {
 	 * @since 1.6
 	 */
 	TextCriteria getFullText();
+
+	/**
+	 * Returns the {@link Update} to be used for findAndUpdate query.
+	 * 
+	 * @return
+	 * @since 1.7
+	 */
+	Update getUpdate();
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoParameters.java

@@ -24,6 +24,7 @@
 import org.springframework.data.geo.Distance;
 import org.springframework.data.geo.Point;
 import org.springframework.data.mongodb.core.query.TextCriteria;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.mongodb.repository.Near;
 import org.springframework.data.mongodb.repository.query.MongoParameters.MongoParameter;
 import org.springframework.data.repository.query.Parameter;
@@ -36,12 +37,14 @@
  * 
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Thomas Darimont
  */
 public class MongoParameters extends Parameters<MongoParameters, MongoParameter> {
 
 	private final int rangeIndex;
 	private final int maxDistanceIndex;
 	private final Integer fullTextIndex;
+	private final int updateIndex;
 
 	private Integer nearIndex;
 
@@ -63,6 +66,7 @@ public MongoParameters(Method method, boolean isGeoNearMethod) {
 
 		this.rangeIndex = getTypeIndex(parameterTypeInfo, Range.class, Distance.class);
 		this.maxDistanceIndex = this.rangeIndex == -1 ? getTypeIndex(parameterTypeInfo, Distance.class, null) : -1;
+		this.updateIndex = parameterTypes.indexOf(Update.class);
 
 		if (this.nearIndex == null && isGeoNearMethod) {
 			this.nearIndex = getNearIndex(parameterTypes);
@@ -72,14 +76,15 @@ public MongoParameters(Method method, boolean isGeoNearMethod) {
 	}
 
 	private MongoParameters(List<MongoParameter> parameters, int maxDistanceIndex, Integer nearIndex,
-			Integer fullTextIndex, int rangeIndex) {
+			Integer fullTextIndex, int rangeIndex, int updateIndex) {
 
 		super(parameters);
 
 		this.nearIndex = nearIndex;
 		this.fullTextIndex = fullTextIndex;
 		this.maxDistanceIndex = maxDistanceIndex;
 		this.rangeIndex = rangeIndex;
+		this.updateIndex = updateIndex;
 	}
 
 	private final int getNearIndex(List<Class<?>> parameterTypes) {
@@ -188,7 +193,8 @@ public int getRangeIndex() {
 	 */
 	@Override
 	protected MongoParameters createFrom(List<MongoParameter> parameters) {
-		return new MongoParameters(parameters, this.maxDistanceIndex, this.nearIndex, this.fullTextIndex, this.rangeIndex);
+		return new MongoParameters(parameters, this.maxDistanceIndex, this.nearIndex, this.fullTextIndex, this.rangeIndex,
+				this.updateIndex);
 	}
 
 	private int getTypeIndex(List<TypeInformation<?>> parameterTypes, Class<?> type, Class<?> componentType) {
@@ -259,7 +265,9 @@ private boolean isPoint() {
 		private boolean hasNearAnnotation() {
 			return parameter.getParameterAnnotation(Near.class) != null;
 		}
-
 	}
 
+	public int getUpdateIndex() {
+		return updateIndex;
+	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoParametersParameterAccessor.java

@@ -20,6 +20,7 @@
 import org.springframework.data.geo.Point;
 import org.springframework.data.mongodb.core.query.Term;
 import org.springframework.data.mongodb.core.query.TextCriteria;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.repository.query.ParametersParameterAccessor;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
@@ -29,6 +30,7 @@
  * 
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Thomas Darimont
  */
 public class MongoParametersParameterAccessor extends ParametersParameterAccessor implements MongoParameterAccessor {
 
@@ -121,4 +123,11 @@ protected TextCriteria potentiallyConvertFullText(Object fullText) {
 				"Expected full text parameter to be one of String, Term or TextCriteria but found %s.",
 				ClassUtils.getShortName(fullText.getClass())));
 	}
+
+	@Override
+	public Update getUpdate() {
+
+		int updateIndex = method.getParameters().getUpdateIndex();
+		return updateIndex == -1 ? null : (Update) getValue(updateIndex);
+	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoQueryMethod.java

@@ -27,6 +27,7 @@
 import org.springframework.data.mapping.context.MappingContext;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.mongodb.repository.Meta;
 import org.springframework.data.mongodb.repository.Query;
 import org.springframework.data.repository.core.RepositoryMetadata;
@@ -233,4 +234,11 @@ public org.springframework.data.mongodb.core.query.Meta getQueryMetaAttributes()
 
 		return metaAttributes;
 	}
+
+	@Override
+	public boolean isModifyingQuery() {
+
+		Class<?>[] parameterTypes = this.method.getParameterTypes();
+		return parameterTypes.length > 0 && parameterTypes[parameterTypes.length - 1] == Update.class;
+	}
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/AbstractPersonRepositoryIntegrationTests.java

@@ -51,6 +51,7 @@
 import org.springframework.data.geo.Polygon;
 import org.springframework.data.mongodb.core.MongoOperations;
 import org.springframework.data.mongodb.core.query.BasicQuery;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.mongodb.repository.Person.Sex;
 import org.springframework.data.querydsl.QSort;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@@ -1183,4 +1184,20 @@ public void executesGeoNearQueryForResultsCorrectlyWhenGivenMinAndMaxDistance()
 		GeoResults<Person> results = repository.findPersonByLocationNear(new Point(-73.99, 40.73), range);
 		assertThat(results.getContent().isEmpty(), is(false));
 	}
+
+	/**
+	 * @see DATAMONGO-1188
+	 */
+	@Test
+	public void shouldSupportFindAndModfiyForQueryDerivation() {
+
+		List<Person> result = repository.findAndModifyByFirstname("Dave", new Update().inc("visits", 42));
+
+		assertThat(result.size(), is(1));
+		assertThat(result.get(0), is(dave));
+
+		Person dave = repository.findOne(result.get(0).getId());
+
+		assertThat(dave.visits, is(42));
+	}
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/Person.java

@@ -66,6 +66,8 @@ public enum Sex {
 
 	Credentials credentials;
 
+	int visits;
+
 	public Person() {
 
 		this(null, null);
@@ -245,6 +247,14 @@ public void setCoworker(User coworker) {
 		this.coworker = coworker;
 	}
 
+	public int getVisits() {
+		return visits;
+	}
+
+	public void setVisits(int visits) {
+		this.visits = visits;
+	}
+
 	/*
 	* (non-Javadoc)
 	*

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/PersonRepository.java

@@ -32,6 +32,7 @@
 import org.springframework.data.geo.GeoResults;
 import org.springframework.data.geo.Point;
 import org.springframework.data.geo.Polygon;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.mongodb.repository.Person.Sex;
 import org.springframework.data.querydsl.QueryDslPredicateExecutor;
 
@@ -333,4 +334,6 @@ public interface PersonRepository extends MongoRepository<Person, String>, Query
 	 */
 	@Query("{ firstname : { $in : ?0 }}")
 	Stream<Person> findByCustomQueryWithStreamingCursorByFirstnames(List<String> firstnames);
+
+	List<Person> findAndModifyByFirstname(String firstname, Update update);
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/query/StubParameterAccessor.java

@@ -25,13 +25,15 @@
 import org.springframework.data.geo.Point;
 import org.springframework.data.mongodb.core.convert.MongoWriter;
 import org.springframework.data.mongodb.core.query.TextCriteria;
+import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.repository.query.ParameterAccessor;
 
 /**
  * Simple {@link ParameterAccessor} that returns the given parameters unfiltered.
  * 
  * @author Oliver Gierke
  * @author Christoh Strobl
+ * @author Thomas Darimont
  */
 class StubParameterAccessor implements MongoParameterAccessor {
 
@@ -129,4 +131,9 @@ public Point getGeoNearLocation() {
 	public TextCriteria getFullText() {
 		return null;
 	}
+
+	@Override
+	public Update getUpdate() {
+		return null;
+	}
 }