DATAMONGO-1551 - Add $graphLookup aggregation stage.

We now support the $graphLookup aggregation pipeline stage via Aggregation to perform recursive lookup adding the lookup result as array to documents entering $graphLookup.

TypedAggregation<Employee> agg = Aggregation.newAggregation(Employee.class,
		graphLookup("employee")
			.startWith("reportsTo")
			.connectFrom("reportsTo")
			.connectTo("name")
			.depthField("depth")
			.maxDepth(5)
			.as("reportingHierarchy"));

Original Pull Request: #424

Author: mp911de

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

@@ -29,6 +29,7 @@
 import org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField;
 import org.springframework.data.mongodb.core.aggregation.ExposedFields.FieldReference;
 import org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation;
+import org.springframework.data.mongodb.core.aggregation.GraphLookupOperation.StartWithBuilder;
 import org.springframework.data.mongodb.core.aggregation.ReplaceRootOperation.ReplaceRootDocumentOperationBuilder;
 import org.springframework.data.mongodb.core.aggregation.ReplaceRootOperation.ReplaceRootOperationBuilder;
 import org.springframework.data.mongodb.core.aggregation.Fields.*;
@@ -316,6 +317,17 @@ public static GroupOperation group(Fields fields) {
 		return new GroupOperation(fields);
 	}
 
+	/**
+	 * Creates a new {@link GraphLookupOperation.FromBuilder} to construct a {@link GraphLookupOperation} given
+	 * {@literal fromCollection}.
+	 *
+	 * @param fromCollection must not be {@literal null} or empty.
+	 * @return
+	 */
+	public static StartWithBuilder graphLookup(String fromCollection) {
+		return GraphLookupOperation.builder().from(fromCollection);
+	}
+
 	/**
 	 * Factory method to create a new {@link SortOperation} for the given {@link Sort}.
 	 *

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

@@ -0,0 +1,363 @@
+/*
+ * Copyright 2016 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.
+ * 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.
+ */
+package org.springframework.data.mongodb.core.aggregation;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField;
+import org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation;
+import org.springframework.data.mongodb.core.query.CriteriaDefinition;
+import org.springframework.util.Assert;
+
+import org.bson.Document;
+
+/**
+ * Encapsulates the aggregation framework {@code $graphLookup}-operation.
+ * <p>
+ * Performs a recursive search on a collection, with options for restricting the search by recursion depth and query
+ * filter.
+ * <p>
+ * We recommend to use the static factory method {@link Aggregation#graphLookup(String)} instead of creating instances
+ * of this class directly.
+ *
+ * @see http://docs.mongodb.org/manual/reference/aggregation/graphLookup/
+ * @author Mark Paluch
+ * @since 1.10
+ */
+public class GraphLookupOperation implements InheritsFieldsAggregationOperation {
+
+	private final String from;
+	private final List<Object> startWith;
+	private final Field connectFrom;
+	private final Field connectTo;
+	private final Field as;
+	private final Long maxDepth;
+	private final Field depthField;
+	private final CriteriaDefinition restrictSearchWithMatch;
+
+	private GraphLookupOperation(String from, List<Object> startWith, Field connectFrom, Field connectTo, Field as,
+			Long maxDepth, Field depthField, CriteriaDefinition restrictSearchWithMatch) {
+
+		this.from = from;
+		this.startWith = startWith;
+		this.connectFrom = connectFrom;
+		this.connectTo = connectTo;
+		this.as = as;
+		this.maxDepth = maxDepth;
+		this.depthField = depthField;
+		this.restrictSearchWithMatch = restrictSearchWithMatch;
+	}
+
+	/**
+	 * Creates a new {@link FromBuilder} to build {@link GraphLookupOperation}.
+	 * 
+	 * @return a new {@link FromBuilder}.
+	 */
+	public static FromBuilder builder() {
+		return new GraphLookupOperationFromBuilder();
+	}
+
+	/* (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.aggregation.AggregationOperation#toDBObject(org.springframework.data.mongodb.core.aggregation.AggregationOperationContext)
+	 */
+	@Override
+	public Document toDocument(AggregationOperationContext context) {
+
+		Document graphLookup = new Document();
+
+		graphLookup.put("from", from);
+
+		List<Object> list = new ArrayList<>(startWith.size());
+
+		for (Object startWithElement : startWith) {
+
+			if (startWithElement instanceof AggregationExpression) {
+				list.add(((AggregationExpression) startWithElement).toDocument(context));
+			}
+
+			if (startWithElement instanceof Field) {
+				list.add(context.getReference((Field) startWithElement).toString());
+			}
+		}
+
+		if (list.size() == 1) {
+			graphLookup.put("startWith", list.get(0));
+		} else {
+			graphLookup.put("startWith", list);
+		}
+
+		graphLookup.put("connectFromField", connectFrom.getName());
+		graphLookup.put("connectToField", connectTo.getName());
+		graphLookup.put("as", as.getName());
+
+		if (maxDepth != null) {
+			graphLookup.put("maxDepth", maxDepth);
+		}
+
+		if (depthField != null) {
+			graphLookup.put("depthField", depthField.getName());
+		}
+
+		if (restrictSearchWithMatch != null) {
+			graphLookup.put("restrictSearchWithMatch", context.getMappedObject(restrictSearchWithMatch.getCriteriaObject()));
+		}
+
+		return new Document("$graphLookup", graphLookup);
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation#getFields()
+	 */
+	@Override
+	public ExposedFields getFields() {
+		return ExposedFields.from(new ExposedField(as, true));
+	}
+
+	/**
+	 * @author Mark Paluch
+	 */
+	public interface FromBuilder {
+
+		/**
+		 * Set the {@literal collectionName} to apply the {@code $graphLookup} to.
+		 *
+		 * @param collectionName must not be {@literal null} or empty.
+		 * @return
+		 */
+		StartWithBuilder from(String collectionName);
+	}
+
+	/**
+	 * @author Mark Paluch
+	 */
+	public interface StartWithBuilder {
+
+		/**
+		 * Set the startWith {@literal fieldReferences} to apply the {@code $graphLookup} to.
+		 *
+		 * @param fieldReferences must not be {@literal null}.
+		 * @return
+		 */
+		ConnectFromBuilder startWith(String... fieldReferences);
+
+		/**
+		 * Set the startWith {@literal expressions} to apply the {@code $graphLookup} to.
+		 *
+		 * @param expressions must not be {@literal null}.
+		 * @return
+		 */
+		ConnectFromBuilder startWith(AggregationExpression... expressions);
+	}
+
+	/**
+	 * @author Mark Paluch
+	 */
+	public interface ConnectFromBuilder {
+
+		/**
+		 * Set the connectFrom {@literal fieldName} to apply the {@code $graphLookup} to.
+		 *
+		 * @param fieldName must not be {@literal null} or empty.
+		 * @return
+		 */
+		ConnectToBuilder connectFrom(String fieldName);
+	}
+
+	/**
+	 * @author Mark Paluch
+	 */
+	public interface ConnectToBuilder {
+
+		/**
+		 * Set the connectTo {@literal fieldName} to apply the {@code $graphLookup} to.
+		 *
+		 * @param fieldName must not be {@literal null} or empty.
+		 * @return
+		 */
+		GraphLookupOperationBuilder connectTo(String fieldName);
+	}
+
+	/**
+	 * Builder to build the initial {@link GraphLookupOperationBuilder} that configures the initial mandatory set of
+	 * {@link GraphLookupOperation} properties.
+	 * 
+	 * @author Mark Paluch
+	 */
+	static final class GraphLookupOperationFromBuilder
+			implements FromBuilder, StartWithBuilder, ConnectFromBuilder, ConnectToBuilder {
+
+		private String from;
+		private List<? extends Object> startWith;
+		private String connectFrom;
+
+		/* (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.aggregation.GraphLookupOperation.FromBuilder#from(java.lang.String)
+		 */
+		@Override
+		public StartWithBuilder from(String collectionName) {
+
+			Assert.hasText(collectionName, "CollectionName must not be null or empty!");
+
+			this.from = collectionName;
+
+			return this;
+		}
+
+		/* (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.aggregation.GraphLookupOperation.StartWithBuilder#startWith(java.lang.String[])
+		 */
+		@Override
+		public ConnectFromBuilder startWith(String... fieldReferences) {
+
+			Assert.notNull(fieldReferences, "FieldReferences must not be null!");
+			Assert.noNullElements(fieldReferences, "FieldReferences must not contain null elements!");
+
+			List<Object> fields = new ArrayList<Object>(fieldReferences.length);
+
+			for (String fieldReference : fieldReferences) {
+				fields.add(Fields.field(fieldReference));
+			}
+
+			this.startWith = fields;
+
+			return this;
+		}
+
+		/* (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.aggregation.GraphLookupOperation.StartWithBuilder#startWith(org.springframework.data.mongodb.core.aggregation.AggregationExpression[])
+		 */
+		@Override
+		public ConnectFromBuilder startWith(AggregationExpression... expressions) {
+
+			Assert.notNull(expressions, "AggregationExpressions must not be null!");
+			Assert.noNullElements(expressions, "AggregationExpressions must not contain null elements!");
+
+			this.startWith = Arrays.asList(expressions);
+
+			return this;
+		}
+
+		/* (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.aggregation.GraphLookupOperation.ConnectFromBuilder#connectFrom(java.lang.String)
+		 */
+		@Override
+		public ConnectToBuilder connectFrom(String fieldName) {
+
+			Assert.hasText(fieldName, "ConnectFrom must not be null or empty!");
+
+			this.connectFrom = fieldName;
+
+			return this;
+		}
+
+		/* (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.aggregation.GraphLookupOperation.ConnectToBuilder#connectTo(java.lang.String)
+		 */
+		@Override
+		public GraphLookupOperationBuilder connectTo(String fieldName) {
+
+			Assert.hasText(fieldName, "ConnectTo must not be null or empty!");
+
+			return new GraphLookupOperationBuilder(from, startWith, connectFrom, fieldName);
+		}
+	}
+
+	/**
+	 * @author Mark Paluch
+	 */
+	static final class GraphLookupOperationBuilder {
+
+		private final String from;
+		private final List<Object> startWith;
+		private final Field connectFrom;
+		private final Field connectTo;
+		private Long maxDepth;
+		private Field depthField;
+		private CriteriaDefinition restrictSearchWithMatch;
+
+		protected GraphLookupOperationBuilder(String from, List<? extends Object> startWith, String connectFrom,
+				String connectTo) {
+
+			this.from = from;
+			this.startWith = new ArrayList<Object>(startWith);
+			this.connectFrom = Fields.field(connectFrom);
+			this.connectTo = Fields.field(connectTo);
+		}
+
+		/**
+		 * Limit the number of recursions.
+		 * 
+		 * @param numberOfRecursions must be greater or equal to zero.
+		 * @return
+		 */
+		public GraphLookupOperationBuilder maxDepth(long numberOfRecursions) {
+
+			Assert.isTrue(numberOfRecursions >= 0, "Max depth must be >= 0!");
+
+			this.maxDepth = numberOfRecursions;
+
+			return this;
+		}
+
+		/**
+		 * Add a depth field {@literal fieldName} to each traversed document in the search path.
+		 * 
+		 * @param fieldName must not be {@literal null} or empty.
+		 * @return
+		 */
+		public GraphLookupOperationBuilder depthField(String fieldName) {
+
+			Assert.hasText(fieldName, "Depth field name must not be null or empty!");
+
+			this.depthField = Fields.field(fieldName);
+
+			return this;
+		}
+
+		/**
+		 * Add a query specifying conditions to the recursive search.
+		 * 
+		 * @param criteriaDefinition must not be {@literal null}.
+		 * @return
+		 */
+		public GraphLookupOperationBuilder restrict(CriteriaDefinition criteriaDefinition) {
+
+			Assert.notNull(criteriaDefinition, "CriteriaDefinition must not be null!");
+
+			this.restrictSearchWithMatch = criteriaDefinition;
+
+			return this;
+		}
+
+		/**
+		 * Set the name of the array field added to each output document and return the final {@link GraphLookupOperation}.
+		 * Contains the documents traversed in the {@literal $graphLookup} stage to reach the document.
+		 * 
+		 * @param fieldName must not be {@literal null} or empty.
+		 * @return the final {@link GraphLookupOperation}.
+		 */
+		public GraphLookupOperation as(String fieldName) {
+
+			Assert.hasText(fieldName, "As field name must not be null or empty!");
+
+			return new GraphLookupOperation(from, startWith, connectFrom, connectTo, Fields.field(fieldName), maxDepth,
+					depthField, restrictSearchWithMatch);
+		}
+	}
+}