SpatialIndex Class

Package:

com.microsoft.azure.documentdb

• java.lang.Object
• • Serializable
  • • JsonSerializable
    • • Index
      • • com.microsoft.azure.documentdb.SpatialIndex

public class SpatialIndex extends Index

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

Constructor Summary

Constructor	Description
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); </code></pre></p>
SpatialIndex(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.

Inherited Members

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) JsonSerializable.getHashMap() JsonSerializable.getInt(String propertyName) Index.getKind() JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(Collection<String> propertyNames) JsonSerializable.getString(String propertyName) JsonSerializable.has(String propertyName) Index.Hash(DataType dataType) Index.Hash(DataType dataType, int precision) Index.Index(IndexKind indexKind) Index.Index(String jsonString, IndexKind indexKind) Index.Index(JSONObject jsonObject, IndexKind indexKind) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.JsonSerializable(JSONObject jsonObject) Index.Range(DataType dataType) Index.Range(DataType dataType, int precision) JsonSerializable.remove(String propertyName) Index.Spatial(DataType dataType) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString() JsonSerializable.toString(int indentFactor)

Constructor Details

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);
</code></pre></p>




						
Parameters:
							

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

				

SpatialIndex

public SpatialIndex(JSONObject jsonObject)

Initializes a new instance of the SpatialIndex class.

Parameters:

jsonObject - the json object that represents the index.

SpatialIndex

public SpatialIndex(String jsonString)

Initializes a new instance of the SpatialIndex class.

Parameters:

jsonString - the json string that represents the index.

Method Details

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.