org.springframework.data.mongodb.core.aggregation

Class ConditionalOperator

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ConditionalOperator

All Implemented Interfaces:

AggregationExpression

public class ConditionalOperator
extends Object
implements AggregationExpression

Encapsulates the aggregation framework $cond operator. A ConditionalOperator allows nested conditions if-then[if-then-else]-else using Field, CriteriaDefinition or a custom condition. Replacement values can be either field references, values of simple MongoDB types or values that can be converted to a simple MongoDB type.

Since:

1.10

Author:

Mark Paluch, Christoph Strobl

See Also:

http://docs.mongodb.com/manual/reference/operator/aggregation/cond/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConditionalOperator.ConditionalExpressionBuilder Builder for fluent ConditionalOperator creation.
static interface	ConditionalOperator.OtherwiseBuilder
static interface	ConditionalOperator.ThenBuilder
static interface	ConditionalOperator.WhenBuilder

Constructor Summary

Constructors

Constructor and Description
ConditionalOperator(CriteriaDefinition condition, Object thenValue, Object otherwiseValue) Creates a new ConditionalOperator for a given CriteriaDefinition and then/otherwise values.
ConditionalOperator(org.bson.Document condition, Object thenValue, Object otherwiseValue) Creates a new ConditionalOperator for a given criteria and then/otherwise values.
ConditionalOperator(Field condition, Object thenValue, Object otherwiseValue) Creates a new ConditionalOperator for a given Field and then/otherwise values.

Method Summary

Modifier and Type	Method and Description
static ConditionalOperator.ConditionalExpressionBuilder	newBuilder() Get a builder that allows fluent creation of ConditionalOperator.
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationExpression into a Document within the given AggregationOperationContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionalOperator

public ConditionalOperator(Field condition,
                           Object thenValue,
                           Object otherwiseValue)

Creates a new ConditionalOperator for a given Field and then/otherwise values.

Parameters:

condition - must not be null.

thenValue - must not be null.

otherwiseValue - must not be null.

ConditionalOperator

public ConditionalOperator(CriteriaDefinition condition,
                           Object thenValue,
                           Object otherwiseValue)

Creates a new ConditionalOperator for a given CriteriaDefinition and then/otherwise values.

Parameters:

condition - must not be null.

thenValue - must not be null.

otherwiseValue - must not be null.

ConditionalOperator

public ConditionalOperator(org.bson.Document condition,
                           Object thenValue,
                           Object otherwiseValue)

Creates a new ConditionalOperator for a given criteria and then/otherwise values.

Parameters:

condition - must not be null.

thenValue - must not be null.

otherwiseValue - must not be null.

Method Detail

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationExpression

Turns the AggregationExpression into a Document within the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationExpression

Returns:

newBuilder

public static ConditionalOperator.ConditionalExpressionBuilder newBuilder()

Get a builder that allows fluent creation of ConditionalOperator.

Returns:

a new ConditionalOperator.ConditionalExpressionBuilder.