com.tomtom.speedtools.mongodb

Class MongoDBSorting

java.lang.Object

com.tomtom.speedtools.mongodb.MongoDBSorting

public class MongoDBSorting
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASC
static MongoDBSorting	DEFAULT_INSTANCE
static int	DESC

Constructor Summary

Constructors

Constructor and Description
MongoDBSorting()
MongoDBSorting(EntityMapper.Field<?>... fields) Creates an ascending sort object for given field.

Method Summary

Modifier and Type	Method and Description
com.mongodb.DBCursor	apply(com.mongodb.DBCursor dbCursor) Method applies the sorting if any to given DBCursor.
MongoDBSorting	ascending(EntityMapper.Field<?>... fields) Method constructs a new instance of a MongoDBSorting object and adds ascending sorting to initial instance.
MongoDBSorting	descending(EntityMapper.Field<?>... fields) Method constructs a new instance of a MongoDBSorting object and adds descending sorting to initial instance.
com.mongodb.DBObject	toDBObject()

Methods inherited from class java.lang.Object

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

Field Detail

ASC

public static final int ASC

See Also:

Constant Field Values

DESC

public static final int DESC

See Also:

Constant Field Values

DEFAULT_INSTANCE

@Nonnull
public static final MongoDBSorting DEFAULT_INSTANCE

Constructor Detail

MongoDBSorting

public MongoDBSorting()

MongoDBSorting

public MongoDBSorting(@Nonnull
                      EntityMapper.Field<?>... fields)

Creates an ascending sort object for given field.

Parameters:

fields - Field(s) to be sorted on.

Method Detail

ascending

@Nonnull
public MongoDBSorting ascending(@Nonnull
                                         EntityMapper.Field<?>... fields)

Method constructs a new instance of a MongoDBSorting object and adds ascending sorting to initial instance.

Parameters:

fields - Field(s) to be sorted on.

Returns:

A new MongoDBSorting instance with given ascending sort added.

descending

@Nonnull
public MongoDBSorting descending(@Nonnull
                                          EntityMapper.Field<?>... fields)

Method constructs a new instance of a MongoDBSorting object and adds descending sorting to initial instance.

Parameters:

fields - Field(s) to be sorted on.

Returns:

A new MongoDBSorting instance with given descending sort added.

apply

@Nonnull
public com.mongodb.DBCursor apply(@Nonnull
                                           com.mongodb.DBCursor dbCursor)

Method applies the sorting if any to given DBCursor.

Parameters:

dbCursor - DBCursor to apply sorting to.

Returns:

DBCursor with sorting.

toDBObject

@Nonnull
public com.mongodb.DBObject toDBObject()