Class AccumulatorOperators.Min

java.lang.Object

org.springframework.data.mongodb.core.aggregation.AccumulatorOperators.Min

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

AccumulatorOperators

public static class AccumulatorOperators.Min
extends Object

AggregationExpression for $min.

Since:

1.10

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
AccumulatorOperators.Min	and(String fieldReference)	Creates new AccumulatorOperators.Min with all previously added arguments appending the given one.
AccumulatorOperators.Min	and(AggregationExpression expression)	Creates new AccumulatorOperators.Min with all previously added arguments appending the given one.
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> @Nullable T	get(Object key)	Get the value for a given key.
protected String	getMongoMethod()
protected boolean	isArgumentMap()
AccumulatorOperators.Min	limit(int numberOfResults)	Creates new AccumulatorOperators.Min that returns the given number of minimum values ($minN).
static AccumulatorOperators.Min	minOf(String fieldReference)	Creates new AccumulatorOperators.Min.
static AccumulatorOperators.Min	minOf(AggregationExpression expression)	Creates new AccumulatorOperators.Min.
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

getMongoMethod

protected String getMongoMethod()

minOf

public static AccumulatorOperators.Min minOf(String fieldReference)

Creates new AccumulatorOperators.Min.

Parameters:

fieldReference - must not be null.

Returns:

new instance of AccumulatorOperators.Min.

minOf

public static AccumulatorOperators.Min minOf(AggregationExpression expression)

Creates new AccumulatorOperators.Min.

Parameters:

expression - must not be null.

Returns:

new instance of AccumulatorOperators.Min.

and

@Contract("_ -> new")
public AccumulatorOperators.Min and(String fieldReference)

Creates new AccumulatorOperators.Min with all previously added arguments appending the given one.
NOTE: Only possible in $project stage.

Parameters:

fieldReference - must not be null.

Returns:

new instance of AccumulatorOperators.Min.

and

@Contract("_ -> new")
public AccumulatorOperators.Min and(AggregationExpression expression)

Creates new AccumulatorOperators.Min with all previously added arguments appending the given one.
NOTE: Only possible in $project stage.

Parameters:

expression - must not be null.

Returns:

new instance of AccumulatorOperators.Min.

limit

@Contract("_ -> new")
public AccumulatorOperators.Min limit(int numberOfResults)

Creates new AccumulatorOperators.Min that returns the given number of minimum values ($minN). NOTE: Cannot be used with more than one input value.

Parameters:

numberOfResults -

Returns:

new instance of AccumulatorOperators.Min.

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