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

Class DocumentOperators

java.lang.Object

org.springframework.data.mongodb.core.aggregation.DocumentOperators

public class DocumentOperators
extends Object

Gateway to document expressions such as $rank, $documentNumber, etc.

Since:

3.3

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentOperators.DenseRank	DocumentOperators.DenseRank resolves the current document position (the rank) relative to other documents.
static class	DocumentOperators.DocumentNumber	DocumentOperators.DocumentNumber resolves the current document position.
static class	DocumentOperators.DocumentOperatorsFactory
static class	DocumentOperators.Rank	DocumentOperators.Rank resolves the current document position (the rank) relative to other documents.
static class	DocumentOperators.Shift	Shift applies an expression to a document in a specified position relative to the current document.

Constructor Summary

Constructors

Constructor	Description
DocumentOperators()

Method Summary

Modifier and Type	Method	Description
static DocumentOperators.DenseRank	denseRank()	Obtain the document position (without gaps) relative to others (rank).
static DocumentOperators.DocumentNumber	documentNumber()	Obtain the current document position.
static DocumentOperators.Rank	rank()	Obtain the document position (including gaps) relative to others (rank).
static DocumentOperators.DocumentOperatorsFactory	valueOf(String fieldReference)	Take the field referenced by given fieldReference.
static DocumentOperators.DocumentOperatorsFactory	valueOf(AggregationExpression expression)	Take the value resulting from the given AggregationExpression.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentOperators

public DocumentOperators()

Method Details

rank

public static DocumentOperators.Rank rank()

Obtain the document position (including gaps) relative to others (rank).

Returns:

new instance of DocumentOperators.Rank.

Since:

3.3

denseRank

public static DocumentOperators.DenseRank denseRank()

Obtain the document position (without gaps) relative to others (rank).

Returns:

new instance of DocumentOperators.DenseRank.

Since:

3.3

valueOf

public static DocumentOperators.DocumentOperatorsFactory valueOf(String fieldReference)

Take the field referenced by given fieldReference.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DocumentOperators.DocumentOperatorsFactory.

valueOf

public static DocumentOperators.DocumentOperatorsFactory valueOf(AggregationExpression expression)

Take the value resulting from the given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of DocumentOperators.DocumentOperatorsFactory.

documentNumber

public static DocumentOperators.DocumentNumber documentNumber()

Obtain the current document position.

Returns:

new instance of DocumentOperators.DocumentNumber.

Since:

3.3