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

Class AccumulatorOperators.Percentile

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

AccumulatorOperators

public static class AccumulatorOperators.Percentile
extends Object

AggregationExpression for $percentile.

Since:

4.2

Author:

Julia Lee

Method Summary

Modifier and Type	Method	Description
AccumulatorOperators.Percentile	and(String fieldReference)	Creates new AccumulatorOperators.Percentile with all previously added inputs appending the given one.
AccumulatorOperators.Percentile	and(AggregationExpression expression)	Creates new AccumulatorOperators.Percentile with all previously added inputs 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> T	get(Object key)	Get the value for a given key.
protected String	getMongoMethod()
protected boolean	isArgumentMap()
AccumulatorOperators.Percentile	percentages(Double... percentages)	Define the percentile value(s) that must resolve to percentages in the range 0.0 - 1.0 inclusive.
static AccumulatorOperators.Percentile	percentileOf(String fieldReference)	Creates new AccumulatorOperators.Percentile.
static AccumulatorOperators.Percentile	percentileOf(AggregationExpression expression)	Creates new AccumulatorOperators.Percentile.
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 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

percentileOf

public static AccumulatorOperators.Percentile percentileOf(String fieldReference)

Creates new AccumulatorOperators.Percentile.

Parameters:

fieldReference - must not be null.

Returns:

new instance of AccumulatorOperators.Percentile.

percentileOf

public static AccumulatorOperators.Percentile percentileOf(AggregationExpression expression)

Creates new AccumulatorOperators.Percentile.

Parameters:

expression - must not be null.

Returns:

new instance of AccumulatorOperators.Percentile.

percentages

public AccumulatorOperators.Percentile percentages(Double... percentages)

Define the percentile value(s) that must resolve to percentages in the range 0.0 - 1.0 inclusive.

Parameters:

percentages - must not be null.

Returns:

new instance of AccumulatorOperators.Percentile.

and

public AccumulatorOperators.Percentile and(String fieldReference)

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

Parameters:

fieldReference - must not be null.

Returns:

new instance of AccumulatorOperators.Percentile.

and

public AccumulatorOperators.Percentile and(AggregationExpression expression)

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

Parameters:

expression - must not be null.

Returns:

new instance of AccumulatorOperators.Percentile.

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