org.springframework.data.mongodb.core.aggregation

Class SortOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.SortOperation

All Implemented Interfaces:

AggregationOperation

public class SortOperation
extends Object
implements AggregationOperation

Encapsulates the aggregation framework $sort-operation.

We recommend to use the static factory method Aggregation#sort(Direction, String...) instead of creating instances of this class directly.

Since:

1.3

Author:

Thomas Darimont, Oliver Gierke, Christoph Strobl, Mark Paluch

See Also:

MongoDB Aggregation Framework: $sort

Constructor Summary

Constructors

Constructor and Description
SortOperation(Sort sort) Creates a new SortOperation for the given Sort instance.

Method Summary

Modifier and Type	Method and Description
SortOperation	and(Sort.Direction direction, String... fields)
SortOperation	and(Sort sort)
String	getOperator() Return the MongoDB operator that is used for this AggregationOperation.
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

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.AggregationOperation

toPipelineStages

Constructor Detail

SortOperation

public SortOperation(Sort sort)

Creates a new SortOperation for the given Sort instance.

Parameters:

sort - must not be null.

Method Detail

and

public SortOperation and(Sort.Direction direction,
                         String... fields)

and

public SortOperation and(Sort sort)

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

Return the MongoDB operator that is used for this AggregationOperation. Aggregation operations should implement this method to avoid document rendering.

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.