Class ScriptOperators.Function

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ScriptOperators.Function

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ScriptOperators

public static class ScriptOperators.Function
extends Object

ScriptOperators.Function defines a custom aggregation $function in JavaScript.
{ $function: { body: ..., args: ..., lang: "js" } }
ScriptOperators.Function cannot be used as part of schema validation query expression.
NOTE: Server-Side JavaScript execution must be enabled

Since:

3.1

Author:

Christoph Strobl, Mark Paluch

See Also:

• MongoDB Documentation: $function

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)
ScriptOperators.Function	args(Object... args)	Set the arguments passed to the function body.
ScriptOperators.Function	args(List<Object> args)	Set the arguments passed to the function body.
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 ScriptOperators.Function	function(String body)	Create a new ScriptOperators.Function with the given function definition.
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()
ScriptOperators.Function	lang(String lang)	The language used in the body.
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 Object

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

Methods inherited from interface AggregationExpression

toDocument

Method Details

function

public static ScriptOperators.Function function(String body)

Create a new ScriptOperators.Function with the given function definition.

Parameters:

body - must not be null.

Returns:

new instance of ScriptOperators.Function.

args

public ScriptOperators.Function args(Object... args)

Set the arguments passed to the function body.

Parameters:

args - the arguments passed to the function body. Leave empty if the function does not take any arguments.

Returns:

new instance of ScriptOperators.Function.

args

public ScriptOperators.Function args(List<Object> args)

Set the arguments passed to the function body.

Parameters:

args - the arguments passed to the function body. Leave empty if the function does not take any arguments.

Returns:

new instance of ScriptOperators.Function.

lang

public ScriptOperators.Function lang(String lang)

The language used in the body.

Parameters:

lang - must not be null nor empty.

Returns:

new instance of ScriptOperators.Function.

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