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

Class ObjectOperators.ObjectOperatorFactory

java.lang.Object

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

Enclosing class:

ObjectOperators

public static class ObjectOperators.ObjectOperatorFactory
extends Object

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
ObjectOperatorFactory(Object value)	Creates new ObjectOperators.ObjectOperatorFactory for given value.

Method Summary

Modifier and Type	Method	Description
ObjectOperators.GetField	getField(String fieldName)	Creates new aggregation expression that takes the associated value and obtains the value of the field with matching name.
ObjectOperators.MergeObjects	merge()	Creates new aggregation expression that takes the associated value and uses $mergeObjects as an accumulator within the $group stage.
ObjectOperators.MergeObjects	mergeWith(Object... values)	Creates new aggregation expression that takes the associated value and combines it with the given values (documents or mapped objects) into a single document.
ObjectOperators.MergeObjects	mergeWithValuesOf(String... fieldReferences)	Creates new aggregation expression that takes the associated value and combines it with the values of the given field references into a single document.
ObjectOperators.MergeObjects	mergeWithValuesOf(AggregationExpression... expression)	Creates new aggregation expression that takes the associated value and combines it with the result values of the given expressions into a single document.
AggregationExpression	removeField(String fieldName)	Creates new aggregation expression that takes the associated value and obtains the value of the field with matching name.
ObjectOperators.SetField	setField(String fieldName)	Creates new aggregation expression that takes the associated value and obtains the value of the field with matching name.
ObjectOperators.ObjectToArray	toArray()	Creates new aggregation expression that takes the associated value and converts it to an array of documents that contain two fields k and v each.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectOperatorFactory

public ObjectOperatorFactory(Object value)

Creates new ObjectOperators.ObjectOperatorFactory for given value.

Parameters:

value - must not be null.

Method Details

merge

public ObjectOperators.MergeObjects merge()

Creates new aggregation expression that takes the associated value and uses $mergeObjects as an accumulator within the $group stage.
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ObjectOperators.MergeObjects.

mergeWith

public ObjectOperators.MergeObjects mergeWith(Object... values)

Creates new aggregation expression that takes the associated value and combines it with the given values (documents or mapped objects) into a single document.
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ObjectOperators.MergeObjects.

mergeWithValuesOf

public ObjectOperators.MergeObjects mergeWithValuesOf(String... fieldReferences)

Creates new aggregation expression that takes the associated value and combines it with the values of the given field references into a single document.
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ObjectOperators.MergeObjects.

mergeWithValuesOf

public ObjectOperators.MergeObjects mergeWithValuesOf(AggregationExpression... expression)

Creates new aggregation expression that takes the associated value and combines it with the result values of the given expressions into a single document.
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ObjectOperators.MergeObjects.

toArray

public ObjectOperators.ObjectToArray toArray()

Creates new aggregation expression that takes the associated value and converts it to an array of documents that contain two fields k and v each.
NOTE: Requires MongoDB 3.6 or later.

Since:

2.1

getField

public ObjectOperators.GetField getField(String fieldName)

Creates new aggregation expression that takes the associated value and obtains the value of the field with matching name.

Since:

4.0

setField

public ObjectOperators.SetField setField(String fieldName)

Creates new aggregation expression that takes the associated value and obtains the value of the field with matching name.

Since:

4.0

removeField

public AggregationExpression removeField(String fieldName)

Creates new aggregation expression that takes the associated value and obtains the value of the field with matching name.

Since:

4.0