Module spring.data.mongodb

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

Class ConditionalOperators

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ConditionalOperators

public class ConditionalOperators
extends Object

Gateway to conditional expressions that evaluate their argument expressions as booleans to a value.

Since:

1.10

Author:

Mark Paluch, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConditionalOperators.Cond	Encapsulates the aggregation framework $cond operator.
static class	ConditionalOperators.ConditionalOperatorFactory
static class	ConditionalOperators.IfNull	Encapsulates the aggregation framework $ifNull operator.
static class	ConditionalOperators.Switch	AggregationExpression for $switch.

Constructor Summary

Constructors

Constructor	Description
ConditionalOperators()

Method Summary

Modifier and Type	Method	Description
static ConditionalOperators.IfNull.ThenBuilder	ifNull(String fieldReference)	Creates new AggregationExpression that evaluates an expression and returns the value of the expression if the expression evaluates to a non-null value.
static ConditionalOperators.IfNull.ThenBuilder	ifNull(AggregationExpression expression)	Creates new AggregationExpression that evaluates an expression and returns the value of the expression if the expression evaluates to a non-null value.
static ConditionalOperators.Switch	switchCases(List<ConditionalOperators.Switch.CaseOperator> conditions)	Creates new AggregationExpression that evaluates a series of ConditionalOperators.Switch.CaseOperator expressions.
static ConditionalOperators.Switch	switchCases(ConditionalOperators.Switch.CaseOperator... conditions)	Creates new AggregationExpression that evaluates a series of ConditionalOperators.Switch.CaseOperator expressions.
static ConditionalOperators.ConditionalOperatorFactory	when(String fieldReference)	Take the field referenced by given fieldReference.
static ConditionalOperators.ConditionalOperatorFactory	when(AggregationExpression expression)	Take the value resulting from the given expression.
static ConditionalOperators.ConditionalOperatorFactory	when(CriteriaDefinition criteriaDefinition)	Take the value resulting from the given criteriaDefinition.

Methods inherited from class java.lang.Object

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

Constructor Details

ConditionalOperators

public ConditionalOperators()

Method Details

when

public static ConditionalOperators.ConditionalOperatorFactory when(String fieldReference)

Take the field referenced by given fieldReference.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ConditionalOperators.ConditionalOperatorFactory.

when

public static ConditionalOperators.ConditionalOperatorFactory when(AggregationExpression expression)

Take the value resulting from the given expression.

Parameters:

expression - must not be null.

Returns:

new instance of ConditionalOperators.ConditionalOperatorFactory.

when

public static ConditionalOperators.ConditionalOperatorFactory when(CriteriaDefinition criteriaDefinition)

Take the value resulting from the given criteriaDefinition.

Parameters:

criteriaDefinition - must not be null.

Returns:

new instance of ConditionalOperators.ConditionalOperatorFactory.

ifNull

public static ConditionalOperators.IfNull.ThenBuilder ifNull(String fieldReference)

Creates new AggregationExpression that evaluates an expression and returns the value of the expression if the expression evaluates to a non-null value. If the expression evaluates to a null value, including instances of undefined values or missing fields, returns the value of the replacement expression.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ConditionalOperators.IfNull.ThenBuilder to create ConditionalOperators.IfNull.

ifNull

public static ConditionalOperators.IfNull.ThenBuilder ifNull(AggregationExpression expression)

Creates new AggregationExpression that evaluates an expression and returns the value of the expression if the expression evaluates to a non-null value. If the expression evaluates to a null value, including instances of undefined values or missing fields, returns the value of the replacement expression.

Parameters:

expression - must not be null.

Returns:

new instance of ConditionalOperators.IfNull.ThenBuilder to create ConditionalOperators.IfNull.

switchCases

public static ConditionalOperators.Switch switchCases(ConditionalOperators.Switch.CaseOperator... conditions)

Creates new AggregationExpression that evaluates a series of ConditionalOperators.Switch.CaseOperator expressions. When it finds an expression which evaluates to true, $switch executes a specified expression and breaks out of the control flow.

Parameters:

conditions - must not be null.

Returns:

new instance of ConditionalOperators.Switch.

switchCases

public static ConditionalOperators.Switch switchCases(List<ConditionalOperators.Switch.CaseOperator> conditions)

Creates new AggregationExpression that evaluates a series of ConditionalOperators.Switch.CaseOperator expressions. When it finds an expression which evaluates to true, $switch executes a specified expression and breaks out of the control flow.

Parameters:

conditions - must not be null.

Returns:

new instance of ConditionalOperators.Switch.