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

Class SelectionOperators.Top

java.lang.Object

org.springframework.data.mongodb.core.aggregation.SelectionOperators.Top

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

SelectionOperators

public static class SelectionOperators.Top
extends Object

AbstractAggregationExpression to return the top element according to the specified order.

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()	In case a limit value (n) is present $topN is used instead of $top.
protected boolean	isArgumentMap()
SelectionOperators.Top	limit(int numberOfResults)	Limits the number of returned elements to the given value.
SelectionOperators.Top	limit(AggregationExpression expression)	Limits the number of returned elements to the value defined by the given expression.
SelectionOperators.Top	output(String... fieldNames)	Define fields included in the output for each element.
SelectionOperators.Top	output(AggregationExpression... out)	Define expressions building the value included in the output for each element.
SelectionOperators.Top	output(Fields out)	Define result ordering.
protected Map<String,Object>	remove(String key)
SelectionOperators.Top	sortBy(Sort sort)	Define result ordering.
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 SelectionOperators.Top	top()
static SelectionOperators.Top	top(int numberOfResults)
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

getMongoMethod

protected String getMongoMethod()

In case a limit value (n) is present $topN is used instead of $top.

Returns:

top

public static SelectionOperators.Top top()

Returns:

new instance of SelectionOperators.Top.

top

public static SelectionOperators.Top top(int numberOfResults)

Parameters:

numberOfResults - Limits the number of returned elements to the given value.

Returns:

new instance of SelectionOperators.Top.

limit

public SelectionOperators.Top limit(int numberOfResults)

Limits the number of returned elements to the given value.

Parameters:

numberOfResults -

Returns:

new instance of SelectionOperators.Top.

limit

public SelectionOperators.Top limit(AggregationExpression expression)

Limits the number of returned elements to the value defined by the given expression.

Parameters:

expression - must not be null.

Returns:

new instance of SelectionOperators.Top.

sortBy

public SelectionOperators.Top sortBy(Sort sort)

Define result ordering.

Parameters:

sort - must not be null.

Returns:

new instance of SelectionOperators.Top.

output

public SelectionOperators.Top output(Fields out)

Define result ordering.

Parameters:

out - must not be null.

Returns:

new instance of SelectionOperators.Top.

output

public SelectionOperators.Top output(String... fieldNames)

Define fields included in the output for each element.

Parameters:

fieldNames - must not be null.

Returns:

new instance of SelectionOperators.Top.

See Also:

• output(Fields)

output

public SelectionOperators.Top output(AggregationExpression... out)

Define expressions building the value included in the output for each element.

Parameters:

out - must not be null.

Returns:

new instance of SelectionOperators.Top.

See Also:

• output(Fields)

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