Module spring.data.mongodb

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

Class GraphLookupOperation.GraphLookupOperationBuilder

java.lang.Object

org.springframework.data.mongodb.core.aggregation.GraphLookupOperation.GraphLookupOperationBuilder

Enclosing class:

GraphLookupOperation

public static final class GraphLookupOperation.GraphLookupOperationBuilder
extends Object

Author:

Mark Paluch

Method Summary

Modifier and Type	Method	Description
GraphLookupOperation	as(String fieldName)	Set the name of the array field added to each output document and return the final GraphLookupOperation.
GraphLookupOperation.GraphLookupOperationBuilder	depthField(String fieldName)	Optionally add a depth field fieldName to each traversed document in the search path.
GraphLookupOperation.GraphLookupOperationBuilder	maxDepth(long numberOfRecursions)	Optionally limit the number of recursions.
GraphLookupOperation.GraphLookupOperationBuilder	restrict(CriteriaDefinition criteriaDefinition)	Optionally add a query specifying conditions to the recursive search.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

maxDepth

public GraphLookupOperation.GraphLookupOperationBuilder maxDepth(long numberOfRecursions)

Optionally limit the number of recursions.

Parameters:

numberOfRecursions - must be greater or equal to zero.

Returns:

this.

depthField

public GraphLookupOperation.GraphLookupOperationBuilder depthField(String fieldName)

Optionally add a depth field fieldName to each traversed document in the search path.

Parameters:

fieldName - must not be null or empty.

Returns:

this.

restrict

public GraphLookupOperation.GraphLookupOperationBuilder restrict(CriteriaDefinition criteriaDefinition)

Optionally add a query specifying conditions to the recursive search.

Parameters:

criteriaDefinition - must not be null.

Returns:

as

public GraphLookupOperation as(String fieldName)

Set the name of the array field added to each output document and return the final GraphLookupOperation. Contains the documents traversed in the $graphLookup stage to reach the document.

Parameters:

fieldName - must not be null or empty.

Returns:

the final GraphLookupOperation.