Class GraphLookupOperation
java.lang.Object
org.springframework.data.mongodb.core.aggregation.GraphLookupOperation
- All Implemented Interfaces:
AggregationOperation
,FieldsExposingAggregationOperation
,FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation
public class GraphLookupOperation
extends Object
implements FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation
Encapsulates the aggregation framework
Performs a recursive search on a collection, with options for restricting the search by recursion depth and query filter.
We recommend to use the static factory method
$graphLookup
-operation. Performs a recursive search on a collection, with options for restricting the search by recursion depth and query filter.
We recommend to use the static factory method
Aggregation.graphLookup(String)
instead of creating instances
of this class directly.- Since:
- 1.10
- Author:
- Mark Paluch, Christoph Strobl
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static interface
static interface
static final class
static interface
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation
FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Creates a newGraphLookupOperation.FromBuilder
to buildGraphLookupOperation
.Returns the fields exposed by theAggregationOperation
.Return the MongoDB operator that is used for thisAggregationOperation
.org.bson.Document
toDocument
(AggregationOperationContext context) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationOperation
toPipelineStages
Methods inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation
inheritsFields
-
Method Details
-
builder
Creates a newGraphLookupOperation.FromBuilder
to buildGraphLookupOperation
.- Returns:
- a new
GraphLookupOperation.FromBuilder
.
-
toDocument
Description copied from interface:AggregationOperation
- Specified by:
toDocument
in interfaceAggregationOperation
- Parameters:
context
- theAggregationOperationContext
to operate within. Must not be null.- Returns:
- the Document
-
getOperator
Description copied from interface:AggregationOperation
Return the MongoDB operator that is used for thisAggregationOperation
. Aggregation operations should implement this method to avoid document rendering.- Specified by:
getOperator
in interfaceAggregationOperation
- Returns:
- the operator used for this
AggregationOperation
.
-
getFields
Description copied from interface:FieldsExposingAggregationOperation
Returns the fields exposed by theAggregationOperation
.- Specified by:
getFields
in interfaceFieldsExposingAggregationOperation
- Returns:
- will never be null.
-