Module spring.data.mongodb

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

Class ObjectOperators

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ObjectOperators

public class ObjectOperators
extends Object

Gateway for object expression operators.

Since:

2.1

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectOperators.GetField	AggregationExpression for $getField.
static class	ObjectOperators.MergeObjects	AggregationExpression for $mergeObjects that combines multiple documents into a single document.
static class	ObjectOperators.ObjectOperatorFactory
static class	ObjectOperators.ObjectToArray	AggregationExpression for $objectToArray that converts a document to an array of documents that each contains two fields k and v.
static class	ObjectOperators.SetField	AggregationExpression for $setField.

Constructor Summary

Constructors

Constructor	Description
ObjectOperators()

Method Summary

Modifier and Type	Method	Description
static AggregationExpression	getValueOf(String fieldName)	Get the value of the field with given name from the $$CURRENT object.
static AggregationExpression	setValueTo(String fieldName, Object value)	Set the value of the field with given name on the $$CURRENT object.
static ObjectOperators.ObjectOperatorFactory	valueOf(String fieldReference)	Take the value referenced by given fieldReference.
static ObjectOperators.ObjectOperatorFactory	valueOf(AggregationExpression expression)	Take the value provided by the given AggregationExpression.
static ObjectOperators.ObjectOperatorFactory	valueOf(SystemVariable variable)	Use the value from the given SystemVariable as input for the target expression.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectOperators

public ObjectOperators()

Method Details

valueOf

public static ObjectOperators.ObjectOperatorFactory valueOf(String fieldReference)

Take the value referenced by given fieldReference.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ObjectOperators.ObjectOperatorFactory.

valueOf

public static ObjectOperators.ObjectOperatorFactory valueOf(AggregationExpression expression)

Take the value provided by the given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of ObjectOperators.ObjectOperatorFactory.

valueOf

public static ObjectOperators.ObjectOperatorFactory valueOf(SystemVariable variable)

Use the value from the given SystemVariable as input for the target expression.

Parameters:

variable - the SystemVariable to use (eg. SystemVariable.ROOT.

Returns:

new instance of ObjectOperators.ObjectOperatorFactory.

Since:

4.2

getValueOf

public static AggregationExpression getValueOf(String fieldName)

Get the value of the field with given name from the $$CURRENT object. Short version for ObjectOperators.valueOf("$$CURRENT").getField(fieldName).

Parameters:

fieldName - the field name.

Returns:

new instance of AggregationExpression.

Since:

4.2

setValueTo

public static AggregationExpression setValueTo(String fieldName,
 Object value)

Set the value of the field with given name on the $$CURRENT object. Short version for ObjectOperators.valueOf($$CURRENT).setField(fieldName).toValue(value).

Parameters:

fieldName - the field name.

Returns:

new instance of AggregationExpression.

Since:

4.2