com.allanbank.mongodb.builder

Class Sort

java.lang.Object

com.allanbank.mongodb.builder.Sort

public final class Sort
extends Object

Provides the ability to easily specify the sort direction for an index or sort specification.

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012, Allanbank Consulting, Inc., All Rights Reserved

Method Summary

Methods

Modifier and Type	Method and Description
static IntegerElement	asc(String field) Creates an ascending order specification, e.g., { <field> : 1 }.
static IntegerElement	desc(String field) Creates an descending order specification, e.g., { <field> : -1 }.
static StringElement	geo2d(String field) Creates an 2D index specification, e.g., { <field> : "2d" }.

Methods inherited from class java.lang.Object

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

Method Detail

asc

public static IntegerElement asc(String field)

Creates an ascending order specification, e.g., { <field> : 1 }.

Parameters:

field - The field to create the

Returns:

The ascending sort specification.

desc

public static IntegerElement desc(String field)

Creates an descending order specification, e.g., { <field> : -1 }.

Parameters:

field - The field to create the

Returns:

The descending sort specification.

geo2d

public static StringElement geo2d(String field)

Creates an 2D index specification, e.g., { <field> : "2d" }.

Parameters:

field - The field to create the

Returns:

The 2D index specification.