Package com.arangodb.model

Class GeoIndexOptions

java.lang.Object

com.arangodb.model.IndexOptions<GeoIndexOptions>

com.arangodb.model.GeoIndexOptions

public final class GeoIndexOptions
extends IndexOptions<GeoIndexOptions>

Author:

Mark Vollmary

Constructor Summary

Constructors

Constructor	Description
GeoIndexOptions()

Method Summary

Modifier and Type	Method	Description
GeoIndexOptions	geoJson(Boolean geoJson)
Iterable<String>	getFields()
Boolean	getGeoJson()
Boolean	getLegacyPolygons()
IndexType	getType()
GeoIndexOptions	legacyPolygons(Boolean legacyPolygons)

Methods inherited from class com.arangodb.model.IndexOptions

getInBackground, getName, inBackground, name

Methods inherited from class java.lang.Object

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

Constructor Details

GeoIndexOptions

public GeoIndexOptions()

Method Details

getFields

public Iterable<String> getFields()

getType

public IndexType getType()

getGeoJson

public Boolean getGeoJson()

geoJson

public GeoIndexOptions geoJson(Boolean geoJson)

Parameters:

geoJson - If a geo-spatial index on a location is constructed and geoJson is true, then the order within the array is longitude followed by latitude. This corresponds to the format described in

Returns:

options

getLegacyPolygons

public Boolean getLegacyPolygons()

legacyPolygons

public GeoIndexOptions legacyPolygons(Boolean legacyPolygons)

Parameters:

legacyPolygons - If `true` will use the old rules (pre-3.10) for the parsing GeoJSON polygons. This allows you to let old indexes produce the same, potentially wrong results as before an upgrade. A geo index with `legacyPolygons` set to `false` will use the new, correct and consistent method for parsing of GeoJSON polygons. See Legacy Polygons.

Returns:

options

Since:

ArangoDB 3.10