Module spring.data.mongodb

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

Class ConvertOperators.ConvertOperatorFactory

java.lang.Object

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

Enclosing class:

ConvertOperators

public static class ConvertOperators.ConvertOperatorFactory
extends Object

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
ConvertOperatorFactory(String fieldReference)	Creates new ConvertOperators.ConvertOperatorFactory for given fieldReference.
ConvertOperatorFactory(AggregationExpression expression)	Creates new ConvertOperators.ConvertOperatorFactory for given AggregationExpression.

Method Summary

Modifier and Type	Method	Description
ConvertOperators.DegreesToRadians	convertDegreesToRadians()	AggregationExpression for $degreesToRadians that converts an input value measured in degrees to radians.
ConvertOperators.Convert	convertTo(int numericTypeIdentifier)	Creates new aggregation expression that takes the associated value and converts it into the type specified by the given numericTypeIdentifier.
ConvertOperators.Convert	convertTo(String stringTypeIdentifier)	Creates new aggregation expression that takes the associated value and converts it into the type specified by the given stringTypeIdentifier.
ConvertOperators.Convert	convertTo(JsonSchemaObject.Type type)	Creates new aggregation expression that takes the associated value and converts it into the type specified by the given JsonSchemaObject.Type.
ConvertOperators.ToBool	convertToBoolean()	Creates new aggregation expression for $toBool that converts a value to boolean.
ConvertOperators.ToDate	convertToDate()	Creates new aggregation expression for $toDate that converts a value to a date.
ConvertOperators.ToDecimal	convertToDecimal()	Creates new aggregation expression for $toDecimal that converts a value to a decimal.
ConvertOperators.ToDouble	convertToDouble()	Creates new aggregation expression for $toDouble that converts a value to a decimal.
ConvertOperators.ToInt	convertToInt()	Creates new aggregation expression for $toInt that converts a value to an int.
ConvertOperators.ToLong	convertToLong()	Creates new aggregation expression for $toLong that converts a value to a long.
ConvertOperators.ToObjectId	convertToObjectId()	Creates new aggregation expression for $toObjectId that converts a value to a objectId.
ConvertOperators.ToString	convertToString()	Creates new aggregation expression for $toString that converts a value to a string.
ConvertOperators.Convert	convertToTypeOf(String fieldReference)	Creates new aggregation expression that takes the associated value and converts it into the type specified by the value of the given field reference.
ConvertOperators.Convert	convertToTypeOf(AggregationExpression expression)	Creates new aggregation expression that takes the associated value and converts it into the type specified by the given expression.

Methods inherited from class java.lang.Object

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

Constructor Details

ConvertOperatorFactory

public ConvertOperatorFactory(String fieldReference)

Creates new ConvertOperators.ConvertOperatorFactory for given fieldReference.

Parameters:

fieldReference - must not be null.

ConvertOperatorFactory

public ConvertOperatorFactory(AggregationExpression expression)

Creates new ConvertOperators.ConvertOperatorFactory for given AggregationExpression.

Parameters:

expression - must not be null.

Method Details

convertTo

public ConvertOperators.Convert convertTo(String stringTypeIdentifier)

Creates new aggregation expression that takes the associated value and converts it into the type specified by the given stringTypeIdentifier.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

stringTypeIdentifier - must not be null.

Returns:

new instance of ConvertOperators.Convert.

convertTo

public ConvertOperators.Convert convertTo(int numericTypeIdentifier)

Creates new aggregation expression that takes the associated value and converts it into the type specified by the given numericTypeIdentifier.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

numericTypeIdentifier - must not be null.

Returns:

new instance of ConvertOperators.Convert.

convertTo

public ConvertOperators.Convert convertTo(JsonSchemaObject.Type type)

Creates new aggregation expression that takes the associated value and converts it into the type specified by the given JsonSchemaObject.Type.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

type - must not be null.

Returns:

new instance of ConvertOperators.Convert.

convertToTypeOf

public ConvertOperators.Convert convertToTypeOf(String fieldReference)

Creates new aggregation expression that takes the associated value and converts it into the type specified by the value of the given field reference.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ConvertOperators.Convert.

convertToTypeOf

public ConvertOperators.Convert convertToTypeOf(AggregationExpression expression)

Creates new aggregation expression that takes the associated value and converts it into the type specified by the given expression.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

expression - must not be null.

Returns:

new instance of ConvertOperators.Convert.

convertToBoolean

public ConvertOperators.ToBool convertToBoolean()

Creates new aggregation expression for $toBool that converts a value to boolean. Shorthand for #convertTo("bool").
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ConvertOperators.ToBool.

convertToDate

public ConvertOperators.ToDate convertToDate()

Creates new aggregation expression for $toDate that converts a value to a date. Shorthand for #convertTo("date").
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ConvertOperators.ToDate.

convertToDecimal

public ConvertOperators.ToDecimal convertToDecimal()

Creates new aggregation expression for $toDecimal that converts a value to a decimal. Shorthand for #convertTo("decimal").
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ConvertOperators.ToDecimal.

convertToDouble

public ConvertOperators.ToDouble convertToDouble()

Creates new aggregation expression for $toDouble that converts a value to a decimal. Shorthand for #convertTo("double").
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ConvertOperators.ToDouble.

convertToInt

public ConvertOperators.ToInt convertToInt()

Creates new aggregation expression for $toInt that converts a value to an int. Shorthand for #convertTo("int").
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ConvertOperators.ToInt.

convertToLong

public ConvertOperators.ToLong convertToLong()

Creates new aggregation expression for $toLong that converts a value to a long. Shorthand for #convertTo("long").
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ConvertOperators.ToInt.

convertToObjectId

public ConvertOperators.ToObjectId convertToObjectId()

Creates new aggregation expression for $toObjectId that converts a value to a objectId. Shorthand for #convertTo("objectId").
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ConvertOperators.ToInt.

convertToString

public ConvertOperators.ToString convertToString()

Creates new aggregation expression for $toString that converts a value to a string. Shorthand for #convertTo("string").
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of ConvertOperators.ToInt.

convertDegreesToRadians

public ConvertOperators.DegreesToRadians convertDegreesToRadians()

AggregationExpression for $degreesToRadians that converts an input value measured in degrees to radians.

Returns:

new instance of ConvertOperators.DegreesToRadians.

Since:

3.3