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

Class SelectionOperators.First

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

SelectionOperators

public static class SelectionOperators.First
extends Object

AbstractAggregationExpression to return the $firstN elements.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	First(Object value)

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.
static SelectionOperators.First	first()
static SelectionOperators.First	first(int numberOfResults)
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()
SelectionOperators.First	input(String fieldName)	Define the field to serve as source.
SelectionOperators.First	input(AggregationExpression expression)	Define the expression building the value to serve as source.
protected boolean	isArgumentMap()
SelectionOperators.First	limit(int numberOfResults)	Limits the number of returned elements to the given value.
SelectionOperators.First	limit(AggregationExpression expression)	Limits the number of returned elements to the value defined by the given expression.
SelectionOperators.First	of(String fieldName)	Define the field to serve as source.
SelectionOperators.First	of(AggregationExpression expression)	Define the expression building the value to serve as source.
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

Constructor Details

First

protected First(Object value)

Method Details

first

public static SelectionOperators.First first()

Returns:

new instance of SelectionOperators.First.

first

public static SelectionOperators.First first(int numberOfResults)

Returns:

new instance of SelectionOperators.First.

limit

public SelectionOperators.First limit(int numberOfResults)

Limits the number of returned elements to the given value.

Parameters:

numberOfResults -

Returns:

new instance of SelectionOperators.First.

limit

public SelectionOperators.First 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.First.

of

public SelectionOperators.First of(String fieldName)

Define the field to serve as source.

Parameters:

fieldName - must not be null.

Returns:

new instance of SelectionOperators.First.

of

public SelectionOperators.First of(AggregationExpression expression)

Define the expression building the value to serve as source.

Parameters:

expression - must not be null.

Returns:

new instance of SelectionOperators.First.

input

public SelectionOperators.First input(String fieldName)

Define the field to serve as source.

Parameters:

fieldName - must not be null.

Returns:

new instance of SelectionOperators.First.

input

public SelectionOperators.First input(AggregationExpression expression)

Define the expression building the value to serve as source.

Parameters:

expression - must not be null.

Returns:

new instance of SelectionOperators.First.

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