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 and Description
static interface	GraphLookupOperation.ConnectFromBuilder
static interface	GraphLookupOperation.ConnectToBuilder
static interface	GraphLookupOperation.FromBuilder
static 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 and Description
static GraphLookupOperation.FromBuilder	builder() Creates a new GraphLookupOperation.FromBuilder to build GraphLookupOperation.
ExposedFields	getFields() Returns the fields exposed by the 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.FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

inheritsFields

Method Detail

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

Returns:

the Document

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.