Class LookupOperation.LookupOperationBuilder

java.lang.Object

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

All Implemented Interfaces:

LookupOperation.AsBuilder, LookupOperation.ForeignFieldBuilder, LookupOperation.FromBuilder, LookupOperation.LetBuilder, LookupOperation.LocalFieldBuilder, LookupOperation.PipelineBuilder

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.PipelineBuilder	let(VariableOperators.Let let)	Specifies invalid input: 'variables) that can be used in the {@link PipelineBuilder#pipeline(AggregationOperation...) pipeline stages}. @param let must not be {@literal null}. @return never {@literal null}. @see PipelineBuilder'
LookupOperation.ForeignFieldBuilder	localField(String name)
static LookupOperation.FromBuilder	newBuilder()	Creates new builder for LookupOperation.
LookupOperation.AsBuilder	pipeline(AggregationPipeline pipeline)	Specifies the pipeline that determines the resulting documents.

Methods inherited from class Object

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

Methods inherited from interface LookupOperation.LetBuilder

let

Methods inherited from interface LookupOperation.PipelineBuilder

pipeline

Constructor Details

LookupOperationBuilder

public LookupOperationBuilder()

Method Details

newBuilder

public static LookupOperation.FromBuilder newBuilder()

Creates new builder for LookupOperation.

Returns:

never null.

from

@Contract("_ -> this")
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.

foreignField

@Contract("_ -> this")
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

@Contract("_ -> this")
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.

let

@Contract("_ -> this")
public LookupOperation.PipelineBuilder let(VariableOperators.Let let)

Description copied from interface: LookupOperation.LetBuilder

Specifies invalid input: 'variables) that can be used in the {@link PipelineBuilder#pipeline(AggregationOperation...) pipeline stages}. @param let must not be {@literal null}. @return never {@literal null}. @see PipelineBuilder'

Specified by:

let in interface LookupOperation.LetBuilder

pipeline

@Contract("_ -> this")
public LookupOperation.AsBuilder pipeline(AggregationPipeline pipeline)

Description copied from interface: LookupOperation.PipelineBuilder

Specifies the pipeline that determines the resulting documents.

Specified by:

pipeline in interface LookupOperation.PipelineBuilder

Parameters:

pipeline - must not be null.

Returns:

never null.

as

@Contract("_ -> new")
public LookupOperation as(String name)

Specified by:

as in interface LookupOperation.AsBuilder

Specified by:

as in interface LookupOperation.PipelineBuilder

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.