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.

MongoDB supports many different index types in addition to the simple ascending and descending order. See the Index helper for more information.

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-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCENDING The value to indicate an ascending sort order.
static int	DESCENDING The value to indicate an descending sort order.

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) Deprecated. Moved to the Index class as Index.geo2d(java.lang.String) to live with the other other index types. This method will be removed after the 1.3.0 release.
static IntegerElement	natural() Creates an natural ascending order sort specification, e.g., { "$natural" : 1 }.
static IntegerElement	natural(int direction) Creates an natural order sort specification with the specified ASCENDING or DESCENDING order, e.g., { "$natural" : <direction> }.

Methods inherited from class java.lang.Object

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

Field Detail

ASCENDING

public static final int ASCENDING

The value to indicate an ascending sort order.

See Also:

Constant Field Values

DESCENDING

public static final int DESCENDING

The value to indicate an descending sort order.

See Also:

Constant Field Values

Method Detail

asc

public static IntegerElement asc(String field)

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

This method is equivalent to Index.asc(String) method.

Parameters:

field - The field to create the ascending sort on.

Returns:

The ascending sort specification.

desc

public static IntegerElement desc(String field)

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

This method is equivalent to Index.desc(String) method.

Parameters:

field - The field to create the descending sort on.

Returns:

The descending sort specification.

geo2d

@Deprecated
public static StringElement geo2d(String field)

Deprecated. Moved to the Index class as Index.geo2d(java.lang.String) to live with the other other index types. This method will be removed after the 1.3.0 release.

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

Parameters:

field - The field to create the '2d' sort on.

Returns:

The 2D index specification.

natural

public static IntegerElement natural()

Creates an natural ascending order sort specification, e.g., { "$natural" : 1 }.

Returns:

The natural ascending sort specification.

natural

public static IntegerElement natural(int direction)

Creates an natural order sort specification with the specified ASCENDING or DESCENDING order, e.g., { "$natural" : <direction> }.

Parameters:

direction - The direction for the natural ordering, either ASCENDING or DESCENDING.

Returns:

The descending sort specification.