org.springframework.data.mongodb.core.aggregation

Class LookupOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.LookupOperation

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

public class LookupOperation
extends Object
implements FieldsExposingAggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Encapsulates the aggregation framework $lookup-operation. We recommend to use the static factory method Aggregation.lookup(String, String, String, String) instead of creating instances of this class directly.

Since:

1.9

Author:

Alessio Fachechi, Christoph Strobl, Mark Paluch

See Also:

MongoDB Aggregation Framework: $lookup

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LookupOperation.AsBuilder
static interface	LookupOperation.ForeignFieldBuilder
static interface	LookupOperation.FromBuilder
static interface	LookupOperation.LocalFieldBuilder
static class	LookupOperation.LookupOperationBuilder Builder for fluent LookupOperation creation.

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

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Constructor and Description
LookupOperation(Field from, Field localField, Field foreignField, Field as) Creates a new LookupOperation for the given Fields.

Method Summary

Modifier and Type	Method and Description
ExposedFields	getFields() Returns the fields exposed by the AggregationOperation.
static LookupOperation.FromBuilder	newLookup() Get a builder that allows creation of LookupOperation.
com.mongodb.DBObject	toDBObject(AggregationOperationContext context) Turns the AggregationOperation into a DBObject by using the given AggregationOperationContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupOperation

public LookupOperation(Field from,
                       Field localField,
                       Field foreignField,
                       Field as)

Creates a new LookupOperation for the given Fields.

Parameters:

from - must not be null.

localField - must not be null.

foreignField - must not be null.

as - must not be null.

Method Detail

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.

toDBObject

public com.mongodb.DBObject toDBObject(AggregationOperationContext context)

Description copied from interface: AggregationOperation

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

Specified by:

toDBObject in interface AggregationOperation

Returns:

the DBObject

newLookup

public static LookupOperation.FromBuilder newLookup()

Get a builder that allows creation of LookupOperation.

Returns: