com.microsoft.azure.cosmosdb

Class Index

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Index

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HashIndex, RangeIndex, SpatialIndex

public abstract class Index
extends JsonSerializable

Represents the index of a collection in the Azure Cosmos DB database service.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Index(IndexKind indexKind) Constructor.
protected	Index(org.json.JSONObject jsonObject, IndexKind indexKind) Constructor.
protected	Index(String jsonString, IndexKind indexKind) Constructor.

Method Summary

Modifier and Type	Method and Description
IndexKind	getKind() Gets index kind.
static HashIndex	Hash(DataType dataType) Returns an instance of HashIndex class with specified DataType.
static HashIndex	Hash(DataType dataType, int precision) Returns an instance of HashIndex class with specified DataType and precision.
static RangeIndex	Range(DataType dataType) Returns an instance of RangeIndex class with specified DataType.
static RangeIndex	Range(DataType dataType, int precision) Returns an instance of RangeIndex class with specified DataType and precision.
static SpatialIndex	Spatial(DataType dataType) Returns an instance of SpatialIndex class with specified DataType.

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Index

protected Index(IndexKind indexKind)

Constructor.

Parameters:

indexKind - the kind of the index

Index

protected Index(String jsonString,
                IndexKind indexKind)

Constructor.

Parameters:

jsonString - the json string that represents the index.

indexKind - the kind of the index

Index

protected Index(org.json.JSONObject jsonObject,
                IndexKind indexKind)

Constructor.

Parameters:

jsonObject - the json object that represents the index.

indexKind - the kind of the index

Method Detail

Range

public static RangeIndex Range(DataType dataType)

Returns an instance of RangeIndex class with specified DataType.

Here is an example to create RangeIndex instance passing in the DataType:

 

 RangeIndex rangeIndex = Index.Range(DataType.Number);

 
 

Parameters:

dataType - the data type.

Returns:

an instance of RangeIndex type.

Range

public static RangeIndex Range(DataType dataType,
                               int precision)

Returns an instance of RangeIndex class with specified DataType and precision.

Here is an example to create RangeIndex instance passing in the DataType and precision:

 

 RangeIndex rangeIndex = Index.Range(DataType.Number, -1);

 
 

Parameters:

dataType - specifies the target data type for the index path specification.

precision - specifies the precision to be used for the data type associated with this index.

Returns:

an instance of RangeIndex type.

Hash

public static HashIndex Hash(DataType dataType)

Returns an instance of HashIndex class with specified DataType.

Here is an example to create HashIndex instance passing in the DataType:

 

 HashIndex hashIndex = Index.Hash(DataType.String);
 
 

Parameters:

dataType - specifies the target data type for the index path specification.

Returns:

an instance of HashIndex type.

Hash

public static HashIndex Hash(DataType dataType,
                             int precision)

Returns an instance of HashIndex class with specified DataType and precision.

Here is an example to create HashIndex instance passing in the DataType and precision:

HashIndex hashIndex = Index.Hash(DataType.String, 3);

Parameters:

dataType - specifies the target data type for the index path specification.

precision - specifies the precision to be used for the data type associated with this index.

Returns:

an instance of HashIndex type.

Spatial

public static SpatialIndex Spatial(DataType dataType)

Returns an instance of SpatialIndex class with specified DataType.

Here is an example to create SpatialIndex instance passing in the DataType:

SpatialIndex spatialIndex = Index.Spatial(DataType.Point);

Parameters:

dataType - specifies the target data type for the index path specification.

Returns:

an instance of SpatialIndex type.

getKind

public IndexKind getKind()

Gets index kind.

Returns:

the index kind.