Module spring.data.mongodb

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

Class ConvertOperators.Convert

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ConvertOperators.Convert

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ConvertOperators

public static class ConvertOperators.Convert
extends Object

AggregationExpression for $convert that converts a value to a specified type.
NOTE: Requires MongoDB 4.0 or later.

Since:

2.1

Author:

Christoph Strobl

See Also:

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

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.
static ConvertOperators.Convert	convertValue(Object value)	Creates new ConvertOperators.Convert using the given value for the input attribute.
static ConvertOperators.Convert	convertValueOf(String fieldReference)	Creates new ConvertOperators.Convert using the value of the provided fieldReference as input value.
static ConvertOperators.Convert	convertValueOf(AggregationExpression expression)	Creates new ConvertOperators.Convert using the result of the provided expression as input value.
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()
ConvertOperators.Convert	onErrorReturn(Object value)	Optionally specify the value to return on encountering an error during conversion.
ConvertOperators.Convert	onErrorReturnValueOf(String fieldReference)	Optionally specify the field holding the value to return on encountering an error during conversion.
ConvertOperators.Convert	onErrorReturnValueOf(AggregationExpression expression)	Optionally specify the expression to evaluate and return on encountering an error during conversion.
ConvertOperators.Convert	onNullReturn(Object value)	Optionally specify the value to return when the input is null or missing.
ConvertOperators.Convert	onNullReturnValueOf(String fieldReference)	Optionally specify the field holding the value to return when the input is null or missing.
ConvertOperators.Convert	onNullReturnValueOf(AggregationExpression expression)	Optionally specify the expression to evaluate and return when the input is null or missing.
protected Map<String,Object>	remove(String key)
ConvertOperators.Convert	to(int numericTypeIdentifier)	Specify the conversion target type via its numeric representation.
ConvertOperators.Convert	to(String stringTypeIdentifier)	Specify the conversion target type via its String representation.
ConvertOperators.Convert	to(JsonSchemaObject.Type type)	Specify the conversion target type.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
ConvertOperators.Convert	toTypeOf(String fieldReference)	Specify the conversion target type via the value of the given field.
ConvertOperators.Convert	toTypeOf(AggregationExpression expression)	Specify the conversion target type via the value of the given expression.
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

convertValue

public static ConvertOperators.Convert convertValue(Object value)

Creates new ConvertOperators.Convert using the given value for the input attribute.

Parameters:

value - must not be null.

Returns:

new instance of ConvertOperators.Convert.

convertValueOf

public static ConvertOperators.Convert convertValueOf(String fieldReference)

Creates new ConvertOperators.Convert using the value of the provided fieldReference as input value.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ConvertOperators.Convert.

convertValueOf

public static ConvertOperators.Convert convertValueOf(AggregationExpression expression)

Creates new ConvertOperators.Convert using the result of the provided expression as input value.

Parameters:

expression - must not be null.

Returns:

new instance of ConvertOperators.Convert.

to

public ConvertOperators.Convert to(String stringTypeIdentifier)

Specify the conversion target type via its String representation.

• double
• string
• objectId
• bool
• date
• int
• long
• decimal

Parameters:

stringTypeIdentifier - must not be null.

Returns:

new instance of ConvertOperators.Convert.

to

public ConvertOperators.Convert to(int numericTypeIdentifier)

Specify the conversion target type via its numeric representation.

1

double

2

string

7

objectId

8

bool

9

date

16

int

18

long

19

decimal

Parameters:

numericTypeIdentifier - must not be null.

Returns:

new instance of ConvertOperators.Convert.

to

public ConvertOperators.Convert to(JsonSchemaObject.Type type)

Specify the conversion target type.

Parameters:

type - must not be null.

Returns:

new instance of ConvertOperators.Convert.

toTypeOf

public ConvertOperators.Convert toTypeOf(String fieldReference)

Specify the conversion target type via the value of the given field.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ConvertOperators.Convert.

toTypeOf

public ConvertOperators.Convert toTypeOf(AggregationExpression expression)

Specify the conversion target type via the value of the given expression.

Parameters:

expression - must not be null.

Returns:

new instance of ConvertOperators.Convert.

onErrorReturn

public ConvertOperators.Convert onErrorReturn(Object value)

Optionally specify the value to return on encountering an error during conversion.

Parameters:

value - must not be null.

Returns:

new instance of ConvertOperators.Convert.

onErrorReturnValueOf

public ConvertOperators.Convert onErrorReturnValueOf(String fieldReference)

Optionally specify the field holding the value to return on encountering an error during conversion.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ConvertOperators.Convert.

onErrorReturnValueOf

public ConvertOperators.Convert onErrorReturnValueOf(AggregationExpression expression)

Optionally specify the expression to evaluate and return on encountering an error during conversion.

Parameters:

expression - must not be null.

Returns:

new instance of ConvertOperators.Convert.

onNullReturn

public ConvertOperators.Convert onNullReturn(Object value)

Optionally specify the value to return when the input is null or missing.

Parameters:

value - must not be null.

Returns:

new instance of ConvertOperators.Convert.

onNullReturnValueOf

public ConvertOperators.Convert onNullReturnValueOf(String fieldReference)

Optionally specify the field holding the value to return when the input is null or missing.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ConvertOperators.Convert.

onNullReturnValueOf

public ConvertOperators.Convert onNullReturnValueOf(AggregationExpression expression)

Optionally specify the expression to evaluate and return when the input is null or missing.

Parameters:

expression - must not be null.

Returns:

new instance of ConvertOperators.Convert.

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.

toDocument

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

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