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

Class ArithmeticOperators.Tanh

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ArithmeticOperators.Tanh

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ArithmeticOperators

public static class ArithmeticOperators.Tanh
extends Object

An expression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.

Since:

3.3

Author:

Christoph Strobl

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()
protected Map<String,Object>	remove(String key)
static ArithmeticOperators.Tanh	tanh(Object value)	Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.
static ArithmeticOperators.Tanh	tanh(Object value, ArithmeticOperators.AngularUnit unit)	Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in the given unit.
static ArithmeticOperators.Tanh	tanhOf(String fieldReference)	Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.
static ArithmeticOperators.Tanh	tanhOf(String fieldReference, ArithmeticOperators.AngularUnit unit)	Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in the given unit.
static ArithmeticOperators.Tanh	tanhOf(AggregationExpression expression)	Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.
static ArithmeticOperators.Tanh	tanhOf(AggregationExpression expression, ArithmeticOperators.AngularUnit unit)	Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in the given unit.
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

tanhOf

public static ArithmeticOperators.Tanh tanhOf(String fieldReference)

Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.

Parameters:

fieldReference - the name of the field that resolves to a numeric value.

Returns:

new instance of ArithmeticOperators.Tanh.

tanhOf

public static ArithmeticOperators.Tanh tanhOf(String fieldReference,
 ArithmeticOperators.AngularUnit unit)

Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in the given unit.
Use tanhOf("angle", DEGREES) as shortcut for

 { $tanh : { $degreesToRadians : "$angle" } }
 

Parameters:

fieldReference - the name of the field that resolves to a numeric value.

unit - the unit of measure used by the value of the given field.

Returns:

new instance of ArithmeticOperators.Tanh.

tanhOf

public static ArithmeticOperators.Tanh tanhOf(AggregationExpression expression)

Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.
Use sinhOf("angle", DEGREES) as shortcut for eg. sinhOf(ConvertOperators.valueOf("angle").degreesToRadians()).

Parameters:

expression - the expression that resolves to a numeric value.

Returns:

new instance of ArithmeticOperators.Tanh.

tanhOf

public static ArithmeticOperators.Tanh tanhOf(AggregationExpression expression,
 ArithmeticOperators.AngularUnit unit)

Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in the given unit.

Parameters:

expression - the expression that resolves to a numeric value.

unit - the unit of measure used by the value of the given field.

Returns:

new instance of ArithmeticOperators.Tanh.

tanh

public static ArithmeticOperators.Tanh tanh(Object value)

Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.

Parameters:

value - anything (field, expression, ...) that resolves to a numeric value.

Returns:

new instance of ArithmeticOperators.Tanh.

tanh

public static ArithmeticOperators.Tanh tanh(Object value,
 ArithmeticOperators.AngularUnit unit)

Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in the given unit.

Parameters:

value - anything (field, expression, ...) that resolves to a numeric value

unit - the unit of measure used by the value of the given field.

Returns:

new instance of ArithmeticOperators.Tanh.

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