Index (mongodb-async-driver 2.0.1 API)

java.lang.Object
- com.allanbank.mongodb.builder.Index

```
public final class Index
extends Object
```
Provides the ability to easily specify the index type of a field within an index 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-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 index order.
`static int`	`DESCENDING` The value to indicate an descending index order.
`static String`	`GEO_2D_INDEX_NAME` The value for the "2d" index.
`static String`	`GEO_2DSPHERE_INDEX_NAME` The value for the "2dsphere" index.
`static String`	`GEO_HAYSTACK_INDEX_NAME` The value for the "geoHaystack" index.
`static String`	`HASHED_INDEX_NAME` The value for the "hashed" index.
`static String`	`TEXT_INDEX_NAME` The value for the "text" index.

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" }`.
`static StringElement`	`geo2dSphere(String field)` Creates an 2D Sphere index specification, e.g., `{ <field> : "2dsphere" }`.
`static StringElement`	`geoHaystack(String field)` Creates a haystack index specification, e.g., `{ <field> : "geoHaystack" }`.
`static StringElement`	`hashed(String field)` Creates an 'hashed' index specification, e.g., `{ <field> : "hashed" }`.
`static StringElement`	`text(String field)` Creates an 'text' index specification, e.g., `{ <field> : "text" }`.

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 index order.
    
    See Also:
    Constant Field Values
  - DESCENDING
```
public static final int DESCENDING
```
    The value to indicate an descending index order.
    
    See Also:
    Constant Field Values
  - GEO_2D_INDEX_NAME
```
public static final String GEO_2D_INDEX_NAME
```
    The value for the "2d" index.
    
    See Also:
    Constant Field Values
  - GEO_2DSPHERE_INDEX_NAME
```
public static final String GEO_2DSPHERE_INDEX_NAME
```
    The value for the "2dsphere" index.
    
    See Also:
    Constant Field Values
  - GEO_HAYSTACK_INDEX_NAME
```
public static final String GEO_HAYSTACK_INDEX_NAME
```
    The value for the "geoHaystack" index.
    
    See Also:
    Constant Field Values
  - HASHED_INDEX_NAME
```
public static final String HASHED_INDEX_NAME
```
    The value for the "hashed" index.
    
    See Also:
    Constant Field Values
  - TEXT_INDEX_NAME
```
public static final String TEXT_INDEX_NAME
```
    The value for the "text" index.
    
    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 Sort.asc(String) method.
    
    Parameters:
    field - The field to create the ascending index 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 the Sort.desc(String) method.
    
    Parameters:
    field - The field to create the descending index on.
    
    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 '2d' index on.
    
    Returns:
    The 2D index specification.
  - geo2dSphere
```
public static StringElement geo2dSphere(String field)
```
    Creates an 2D Sphere index specification, e.g., { <field> : "2dsphere" }.
    
    Parameters:
    field - The field to create the '2dsphere' index on.
    
    Returns:
    The 2D Sphere index specification.
    Since:
    
    MongoDB 2.4
  - geoHaystack
```
public static StringElement geoHaystack(String field)
```
    Creates a haystack index specification, e.g., { <field> : "geoHaystack" }.
    
    Parameters:
    field - The field to create the 'geoHaystack' index on.
    
    Returns:
    The 2D Sphere index specification.
    See Also:
    Haystack Index Documentation
  - hashed
```
public static StringElement hashed(String field)
```
    Creates an 'hashed' index specification, e.g., { <field> : "hashed" }.
    
    Parameters:
    field - The field to create the 'hashed' index on.
    
    Returns:
    The 'hashed' index specification.
    Since:
    
    MongoDB 2.4
  - text
```
public static StringElement text(String field)
```
    Creates an 'text' index specification, e.g., { <field> : "text" }.
    Note: MongoDB Inc. considers text indexes to be an experimental feature in the 2.4 release. Use with extreme caution. At a minimum make sure you have read the MongoDB Text Index Documentation.
    
    Parameters:
    field - The field to create the 'text' index on.
    
    Returns:
    The 'text' index specification.
    Since:
    
    MongoDB 2.4
    
    See Also:
    MongoDB Text Index Documentation

Class Index

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ASCENDING

DESCENDING

GEO_2D_INDEX_NAME

GEO_2DSPHERE_INDEX_NAME

GEO_HAYSTACK_INDEX_NAME

HASHED_INDEX_NAME

TEXT_INDEX_NAME

Method Detail

asc

desc

geo2d

geo2dSphere

geoHaystack

hashed

text