mindol1004/spring-data-mongodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

DATAMONGO-1551 - Polishing.

Browse Source 
Add startWith overload allowing to mix expressions, removed white spaces, updated doc.

Original Pull Request: #424
This commit is contained in:
Christoph Strobl
2016-12-13 14:21:33 +01:00
parent c6dae3c444
commit 204a0515c4
4 changed files with 120 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -320,11 +320,12 @@ public class Aggregation {
}
/**
* Creates a new {@link GraphLookupOperation.FromBuilder} to construct a {@link GraphLookupOperation} given
* {@literal fromCollection}.
* Creates a new {@link GraphLookupOperation.GraphLookupOperationFromBuilder} to construct a
* {@link GraphLookupOperation} given {@literal fromCollection}.
*
* @param fromCollection must not be {@literal null} or empty.
* @return
* @since 1.10
*/
public static StartWithBuilder graphLookup(String fromCollection) {
return GraphLookupOperation.builder().from(fromCollection);

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

@@ -17,32 +17,37 @@ package org.springframework.data.mongodb.core.aggregation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
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.springframework.util.ClassUtils;
import com.mongodb.BasicDBList;
import com.mongodb.BasicDBObject;
import com.mongodb.DBObject;
/**
* Encapsulates the aggregation framework {@code $graphLookup}-operation.
* <p>
* Encapsulates the aggregation framework {@code $graphLookup}-operation. <br />
* Performs a recursive search on a collection, with options for restricting the search by recursion depth and query
* filter.
* <p>
* filter. <br />
* 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/
* @see <a href=
* "http://docs.mongodb.org/manual/reference/aggregation/graphLookup/">http://docs.mongodb.org/manual/reference/aggregation/graphLookup/</a>
* @author Mark Paluch
* @author Christoph Strobl
* @since 1.10
*/
public class GraphLookupOperation implements InheritsFieldsAggregationOperation {
private static final Set<Class<?>> ALLOWED_START_TYPES = new HashSet<Class<?>>(
Arrays.<Class<?>> asList(AggregationExpression.class, String.class, Field.class, DBObject.class));
private final String from;
private final List<Object> startWith;
private final Field connectFrom;
@@ -67,7 +72,7 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
/**
* Creates a new {@link FromBuilder} to build {@link GraphLookupOperation}.
*
*
* @return a new {@link FromBuilder}.
*/
public static FromBuilder builder() {
@@ -84,24 +89,20 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
graphLookup.put("from", from);
BasicDBList list = new BasicDBList();
List<Object> mappedStartWith = new ArrayList<Object>(startWith.size());
for (Object startWithElement : startWith) {
if (startWithElement instanceof AggregationExpression) {
list.add(((AggregationExpression) startWithElement).toDbObject(context));
}
if (startWithElement instanceof Field) {
list.add(context.getReference((Field) startWithElement).toString());
mappedStartWith.add(((AggregationExpression) startWithElement).toDbObject(context));
} else if (startWithElement instanceof Field) {
mappedStartWith.add(context.getReference((Field) startWithElement).toString());
} else {
mappedStartWith.add(startWithElement);
}
}
if (list.size() == 1) {
graphLookup.put("startWith", list.get(0));
} else {
graphLookup.put("startWith", list);
}
graphLookup.put("startWith", mappedStartWith.size() == 1 ? mappedStartWith.iterator().next() : mappedStartWith);
graphLookup.put("connectFromField", connectFrom.getName());
graphLookup.put("connectToField", connectTo.getName());
@@ -147,6 +148,7 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
/**
* @author Mark Paluch
* @author Christoph Strobl
*/
public interface StartWithBuilder {
@@ -165,6 +167,16 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
* @return
*/
ConnectFromBuilder startWith(AggregationExpression... expressions);
/**
* Set the startWith as either {@literal fieldReferences}, {@link Fields}, {@link DBObject} or
* {@link AggregationExpression} to apply the {@code $graphLookup} to.
*
* @param expressions must not be {@literal null}.
* @return
* @throws IllegalArgumentException
*/
ConnectFromBuilder startWith(Object... expressions);
}
/**
@@ -198,7 +210,7 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
/**
* Builder to build the initial {@link GraphLookupOperationBuilder} that configures the initial mandatory set of
* {@link GraphLookupOperation} properties.
*
*
* @author Mark Paluch
*/
static final class GraphLookupOperationFromBuilder
@@ -217,7 +229,6 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
Assert.hasText(collectionName, "CollectionName must not be null or empty!");
this.from = collectionName;
return this;
}
@@ -237,7 +248,6 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
}
this.startWith = fields;
return this;
}
@@ -251,10 +261,50 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
Assert.noNullElements(expressions, "AggregationExpressions must not contain null elements!");
this.startWith = Arrays.asList(expressions);
return this;
}
@Override
public ConnectFromBuilder startWith(Object... expressions) {
Assert.notNull(expressions, "Expressions must not be null!");
Assert.noNullElements(expressions, "Expressions must not contain null elements!");
this.startWith = verifyAndPotentiallyTransformStartsWithTypes(expressions);
return this;
}
private List<Object> verifyAndPotentiallyTransformStartsWithTypes(Object... expressions) {
List<Object> expressionsToUse = new ArrayList<Object>(expressions.length);
for (Object expression : expressions) {
assertStartWithType(expression);
if (expression instanceof String) {
expressionsToUse.add(Fields.field((String) expression));
} else {
expressionsToUse.add(expression);
}
}
return expressionsToUse;
}
private void assertStartWithType(Object expression) {
for (Class<?> type : ALLOWED_START_TYPES) {
if (ClassUtils.isAssignable(type, expression.getClass())) {
return;
}
}
throw new IllegalArgumentException(
String.format("Expression must be any of %s but was %s", ALLOWED_START_TYPES, expression.getClass()));
}
/* (non-Javadoc)
* @see org.springframework.data.mongodb.core.aggregation.GraphLookupOperation.ConnectFromBuilder#connectFrom(java.lang.String)
*/
@@ -264,7 +314,6 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
Assert.hasText(fieldName, "ConnectFrom must not be null or empty!");
this.connectFrom = fieldName;
return this;
}
@@ -303,8 +352,8 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
}
/**
* Limit the number of recursions.
*
* Optionally limit the number of recursions.
*
* @param numberOfRecursions must be greater or equal to zero.
* @return
*/
@@ -313,13 +362,12 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
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.
*
* Optionally add a depth field {@literal fieldName} to each traversed document in the search path.
*
* @param fieldName must not be {@literal null} or empty.
* @return
*/
@@ -328,13 +376,12 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
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.
*
* Optionally add a query specifying conditions to the recursive search.
*
* @param criteriaDefinition must not be {@literal null}.
* @return
*/
@@ -343,14 +390,13 @@ public class GraphLookupOperation implements InheritsFieldsAggregationOperation
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}.
*/

38
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/GraphLookupOperationUnitTests.java
View File

@@ -20,6 +20,7 @@ import static org.junit.Assert.*;
import static org.springframework.data.mongodb.test.util.IsBsonObject.*;
import org.junit.Test;
import org.springframework.data.mongodb.core.Person;
import org.springframework.data.mongodb.core.aggregation.AggregationExpressions.Literal;
import org.springframework.data.mongodb.core.query.Criteria;
@@ -29,8 +30,9 @@ import com.mongodb.util.JSON;
/**
* Unit tests for {@link GraphLookupOperation}.
*
*
* @author Mark Paluch
* @author Christoph Strobl
*/
public class GraphLookupOperationUnitTests {
@@ -101,6 +103,40 @@ public class GraphLookupOperationUnitTests {
+ "connectFromField: \"reportsTo\", connectToField: \"name\", as: \"reportingHierarchy\" } }")));
}
/**
* @see DATAMONGO-1551
*/
@Test
public void shouldRenderMixedArrayOfStartsWithCorrectly() {
GraphLookupOperation graphLookupOperation = GraphLookupOperation.builder() //
.from("employees") //
.startWith("reportsTo", Literal.asLiteral("$boss")) //
.connectFrom("reportsTo") //
.connectTo("name") //
.as("reportingHierarchy");
DBObject dbObject = graphLookupOperation.toDBObject(Aggregation.DEFAULT_CONTEXT);
assertThat(dbObject,
is(JSON.parse("{ $graphLookup : { from: \"employees\", startWith: [\"$reportsTo\", { $literal: \"$boss\"}], "
+ "connectFromField: \"reportsTo\", connectToField: \"name\", as: \"reportingHierarchy\" } }")));
}
/**
* @see DATAMONGO-1551
*/
@Test(expected = IllegalArgumentException.class)
public void shouldRejectUnknownTypeInMixedArrayOfStartsWithCorrectly() {
GraphLookupOperation graphLookupOperation = GraphLookupOperation.builder() //
.from("employees") //
.startWith("reportsTo", new Person()) //
.connectFrom("reportsTo") //
.connectTo("name") //
.as("reportingHierarchy");
}
/**
* @see DATAMONGO-1551
*/

2
src/main/asciidoc/reference/mongodb.adoc
View File

@@ -1674,7 +1674,7 @@ At the time of this writing we provide support for the following Aggregation Ope
[cols="2*"]
|===
| Pipeline Aggregation Operators
| count, geoNear, group, limit, lookup, match, project, replaceRoot, skip, sort, unwind
| count, geoNear, graphLookup, group, limit, lookup, match, project, replaceRoot, skip, sort, unwind
| Set Aggregation Operators
| setEquals, setIntersection, setUnion, setDifference, setIsSubset, anyElementTrue, allElementsTrue