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

Class ObjectOperators.MergeObjects

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ObjectOperators

public static class ObjectOperators.MergeObjects
extends Object

AggregationExpression for $mergeObjects that combines multiple documents into a single document.
NOTE: Requires MongoDB 4.0 or later.

Since:

2.1

Author:

Christoph Strobl

See Also:

• https://docs.mongodb.com/manual/reference/operator/aggregation/mergeObjects/

Method Summary

Modifier and Type	Method	Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	appendAt(int index, String key, Object value)	Append the given key at the position in the underlying LinkedHashMap.
protected Map<String,Object>	appendTo(String key, Object value)
protected Map<String,Object>	argumentMap()	Get the argument map.
protected static List<Field>	asFields(String... fieldRefs)
protected boolean	contains(Object key)	Check if the given key is available.
protected <T> T	get(int index)	Get the value at a given index.
protected <T> T	get(Object key)	Get the value for a given key.
protected String	getMongoMethod()
protected boolean	isArgumentMap()
static ObjectOperators.MergeObjects	merge(Object... values)	Creates new aggregation expression that takes given values and combines them into a single document.
static ObjectOperators.MergeObjects	mergeValuesOf(String... fieldReferences)	Creates new aggregation expression that takes the given field references and combines them into a single document.
static ObjectOperators.MergeObjects	mergeValuesOf(AggregationExpression... expressions)	Creates new aggregation expression that takes the result of the given expressions and combines them into a single document.
ObjectOperators.MergeObjects	mergeWith(Object... values)	Creates new aggregation expression by adding the given values (documents or mapped objects).
ObjectOperators.MergeObjects	mergeWithValuesOf(String... fieldReferences)	Creates new aggregation expression by adding the given field references.
ObjectOperators.MergeObjects	mergeWithValuesOf(AggregationExpression... expression)	Creates new aggregation expression by adding the given expressions.
protected Map<String,Object>	remove(String key)
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
protected List<Object>	values()

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.AggregationExpression

toDocument

Method Details

merge

public static ObjectOperators.MergeObjects merge(Object... values)

Creates new aggregation expression that takes given values and combines them into a single document.

Parameters:

values - must not be null.

Returns:

new instance of ObjectOperators.MergeObjects.

mergeValuesOf

public static ObjectOperators.MergeObjects mergeValuesOf(String... fieldReferences)

Creates new aggregation expression that takes the given field references and combines them into a single document.

Parameters:

fieldReferences - must not be null.

Returns:

new instance of ObjectOperators.MergeObjects.

mergeValuesOf

public static ObjectOperators.MergeObjects mergeValuesOf(AggregationExpression... expressions)

Creates new aggregation expression that takes the result of the given expressions and combines them into a single document.

Parameters:

expressions - must not be null.

Returns:

new instance of ObjectOperators.MergeObjects.

mergeWithValuesOf

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

Creates new aggregation expression by adding the given field references.

Parameters:

fieldReferences - must not be null.

Returns:

new instance of ObjectOperators.MergeObjects.

mergeWithValuesOf

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

Creates new aggregation expression by adding the given expressions.

Parameters:

expression - must not be null.

Returns:

new instance of ObjectOperators.MergeObjects.

mergeWith

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

Creates new aggregation expression by adding the given values (documents or mapped objects).

Parameters:

values - must not be null.

Returns:

new instance of ObjectOperators.MergeObjects.

toDocument

public org.bson.Document toDocument(Object value,
 AggregationOperationContext context)

getMongoMethod

protected String getMongoMethod()

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

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.

asFields

protected static List<Field> asFields(String... fieldRefs)

append

protected List<Object> append(Object value,
 org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(String key,
 Object value)

appendTo

protected Map<String,Object> appendTo(String key,
 Object value)

remove

protected Map<String,Object> remove(String key)

appendAt

protected Map<String,Object> appendAt(int index,
 String key,
 Object value)

Append the given key at the position in the underlying LinkedHashMap.

Parameters:

index -

key -

value -

Returns:

Since:

3.1

values

protected List<Object> values()

get

protected <T> T get(int index)

Get the value at a given index.

Type Parameters:

T -

Parameters:

index -

Returns:

Since:

2.1

get

protected <T> T get(Object key)

Get the value for a given key.

Type Parameters:

T -

Parameters:

key -

Returns:

Since:

2.1

isArgumentMap

protected boolean isArgumentMap()

argumentMap

protected Map<String,Object> argumentMap()

Get the argument map.

Returns:

Since:

2.1

contains

protected boolean contains(Object key)

Check if the given key is available.

Parameters:

key -

Returns:

Since:

2.1