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

Class LookupOperation.LookupOperationBuilder

java.lang.Object

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

All Implemented Interfaces:

LookupOperation.AsBuilder, LookupOperation.ForeignFieldBuilder, LookupOperation.FromBuilder, LookupOperation.LocalFieldBuilder

Enclosing class:

LookupOperation

public static final class LookupOperation.LookupOperationBuilder
extends Object
implements LookupOperation.FromBuilder, LookupOperation.LocalFieldBuilder, LookupOperation.ForeignFieldBuilder, LookupOperation.AsBuilder

Builder for fluent LookupOperation creation.

Since:

1.9

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
LookupOperationBuilder()

Method Summary

Modifier and Type	Method	Description
LookupOperation	as(String name)
LookupOperation.AsBuilder	foreignField(String name)
LookupOperation.LocalFieldBuilder	from(String name)
LookupOperation.ForeignFieldBuilder	localField(String name)
static LookupOperation.FromBuilder	newBuilder()	Creates new builder for LookupOperation.

Methods inherited from class java.lang.Object

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

Constructor Details

LookupOperationBuilder

public LookupOperationBuilder()

Method Details

newBuilder

public static LookupOperation.FromBuilder newBuilder()

Creates new builder for LookupOperation.

Returns:

never null.

from

public LookupOperation.LocalFieldBuilder from(String name)

Specified by:

from in interface LookupOperation.FromBuilder

Parameters:

name - the collection in the same database to perform the join with, must not be null or empty.

Returns:

never null.

as

public LookupOperation as(String name)

Specified by:

as in interface LookupOperation.AsBuilder

Parameters:

name - the name of the new array field to add to the input documents, must not be null or empty.

Returns:

new instance of LookupOperation.

foreignField

public LookupOperation.AsBuilder foreignField(String name)

Specified by:

foreignField in interface LookupOperation.ForeignFieldBuilder

Parameters:

name - the field from the documents in the from collection, must not be null or empty.

Returns:

never null.

localField

public LookupOperation.ForeignFieldBuilder localField(String name)

Specified by:

localField in interface LookupOperation.LocalFieldBuilder

Parameters:

name - the field from the documents input to the $lookup stage, must not be null or empty.

Returns:

never null.