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
-
Method Summary
Modifier and TypeMethodDescriptionforeignField
(String name) let
(VariableOperators.Let let) Specifiesvariables) that can be used in the {@link PipelineBuilder#pipeline(AggregationOperation...) pipeline stages}.
localField
(String name) static LookupOperation.FromBuilder
Creates new builder forLookupOperation
.pipeline
(AggregationPipeline pipeline) Specifies thepipeline
that determines the resulting documents.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.LookupOperation.LetBuilder
let
Methods inherited from interface org.springframework.data.mongodb.core.aggregation.LookupOperation.PipelineBuilder
pipeline
-
Constructor Details
-
LookupOperationBuilder
public LookupOperationBuilder()
-
-
Method Details
-
newBuilder
Creates new builder forLookupOperation
.- Returns:
- never null.
-
from
- Specified by:
from
in interfaceLookupOperation.FromBuilder
- Parameters:
name
- the collection in the same database to perform the join with, must not be null or empty.- Returns:
- never null.
-
foreignField
- Specified by:
foreignField
in interfaceLookupOperation.ForeignFieldBuilder
- Parameters:
name
- the field from the documents in thefrom
collection, must not be null or empty.- Returns:
- never null.
-
localField
- Specified by:
localField
in interfaceLookupOperation.LocalFieldBuilder
- Parameters:
name
- the field from the documents input to the$lookup
stage, must not be null or empty.- Returns:
- never null.
-
let
Description copied from interface:LookupOperation.LetBuilder
Specifiesvariables) that can be used in the {@link PipelineBuilder#pipeline(AggregationOperation...) pipeline stages}.
- Specified by:
let
in interfaceLookupOperation.LetBuilder
- Parameters:
let
- must not be null.- Returns:
- never null.
- See Also:
-
pipeline
Description copied from interface:LookupOperation.PipelineBuilder
Specifies thepipeline
that determines the resulting documents.- Specified by:
pipeline
in interfaceLookupOperation.PipelineBuilder
- Parameters:
pipeline
- must not be null.- Returns:
- never null.
-
as
- Specified by:
as
in interfaceLookupOperation.AsBuilder
- Specified by:
as
in interfaceLookupOperation.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
.
-