Class ArithmeticOperators.ATan2

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ArithmeticOperators

public static class ArithmeticOperators.ATan2
extends Object

An expression that calculates the inverse tangent of y / x, where y and x are the first and second values passed to the expression respectively.

Since:

3.3

Author:

Divya Srivastava

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)
ArithmeticOperators.ATan2	atan2of(Number value)	Creates a new AggregationExpression that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.
ArithmeticOperators.ATan2	atan2of(String fieldReference)	Creates a new AggregationExpression that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.
ArithmeticOperators.ATan2	atan2of(AggregationExpression expression)	Creates a new AggregationExpression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.
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> @Nullable T	get(Object key)	Get the value for a given key.
protected String	getMongoMethod()
protected boolean	isArgumentMap()
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.
static ArithmeticOperators.ATan2	valueOf(String fieldReference)	Creates a new AggregationExpression that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.
static ArithmeticOperators.ATan2	valueOf(AggregationExpression expression)	Creates a new AggregationExpression that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.
protected List<Object>	values()

Methods inherited from class Object

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

Methods inherited from interface AggregationExpression

toDocument

Method Details

valueOf

public static ArithmeticOperators.ATan2 valueOf(String fieldReference)

Creates a new AggregationExpression that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.

Parameters:

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

Returns:

new instance of ArithmeticOperators.ATan2.

valueOf

public static ArithmeticOperators.ATan2 valueOf(AggregationExpression expression)

Creates a new AggregationExpression that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.

Parameters:

expression - the expression that resolves to a numeric value.

Returns:

new instance of ArithmeticOperators.ATan2.

atan2of

public ArithmeticOperators.ATan2 atan2of(String fieldReference)

Creates a new AggregationExpression that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.

Parameters:

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

Returns:

new instance of ArithmeticOperators.ATan2.

atan2of

public ArithmeticOperators.ATan2 atan2of(AggregationExpression expression)

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

Parameters:

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

Returns:

new instance of ArithmeticOperators.ATan2.

atan2of

public ArithmeticOperators.ATan2 atan2of(Number value)

Creates a new AggregationExpression that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.

Parameters:

value - of type Number

Returns:

new instance of ArithmeticOperators.ATan2.

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> @Nullable 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