com.microsoft.azure.cosmosdb

Class SpatialIndex

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Index

com.microsoft.azure.cosmosdb.SpatialIndex

All Implemented Interfaces:

Serializable

public final class SpatialIndex
extends Index

Represents a spatial index in the Azure Cosmos DB database service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpatialIndex(DataType dataType) Initializes a new instance of the SpatialIndex class.
SpatialIndex(org.json.JSONObject jsonObject) Initializes a new instance of the SpatialIndex class.
SpatialIndex(String jsonString) Initializes a new instance of the SpatialIndex class.

Method Summary

Modifier and Type	Method and Description
DataType	getDataType() Gets data type.
void	setDataType(DataType dataType) Sets data type.

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

getKind, Hash, Hash, Range, Range, Spatial

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

SpatialIndex

public SpatialIndex(DataType dataType)

Initializes a new instance of the SpatialIndex class.

Here is an example to instantiate SpatialIndex class passing in the DataType

 

 SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);

 
 

Parameters:

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

SpatialIndex

public SpatialIndex(String jsonString)

Initializes a new instance of the SpatialIndex class.

Parameters:

jsonString - the json string that represents the index.

SpatialIndex

public SpatialIndex(org.json.JSONObject jsonObject)

Initializes a new instance of the SpatialIndex class.

Parameters:

jsonObject - the json object that represents the index.

Method Detail

getDataType

public DataType getDataType()

Gets data type.

Returns:

the data type.

setDataType

public void setDataType(DataType dataType)

Sets data type.

Parameters:

dataType - the data type.