Module spring.data.mongodb

Package org.springframework.data.mongodb.core.aggregation

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 $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:

• https://docs.mongodb.org/manual/reference/aggregation/graphLookup/

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GraphLookupOperation.ConnectFromBuilder
static interface	GraphLookupOperation.ConnectToBuilder
static interface	GraphLookupOperation.FromBuilder
static final class	GraphLookupOperation.GraphLookupOperationBuilder
static interface	GraphLookupOperation.StartWithBuilder

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Method Summary

Modifier and Type	Method	Description
static GraphLookupOperation.FromBuilder	builder()	Creates a new GraphLookupOperation.FromBuilder to build GraphLookupOperation.
ExposedFields	getFields()	Returns the fields exposed by the AggregationOperation.
String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

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

public static GraphLookupOperation.FromBuilder builder()

Creates a new GraphLookupOperation.FromBuilder to build GraphLookupOperation.

Returns:

a new GraphLookupOperation.FromBuilder.

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

Return the MongoDB operator that is used for this AggregationOperation. Aggregation operations should implement this method to avoid document rendering.

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.

getFields

public ExposedFields getFields()

Description copied from interface: FieldsExposingAggregationOperation

Returns the fields exposed by the AggregationOperation.

Specified by:

getFields in interface FieldsExposingAggregationOperation

Returns:

will never be null.