com.marklogic.client.admin.config

Class QueryOptions.QueryGeospatialAttributePair

java.lang.Object

com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem

com.marklogic.client.admin.config.QueryOptions.QueryGeospatialAttributePair

All Implemented Interfaces:

ConstraintSource

Enclosing class:

QueryOptions

public static class QueryOptions.QueryGeospatialAttributePair
extends QueryOptions.BaseConstraintItem

Models a geospatial index with coordinates stored in a pair of attributes

Constructor Summary

Constructors

Constructor and Description
QueryOptions.QueryGeospatialAttributePair()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFacetOption(String facetOption) Add a facet option to this Geospatial constraint.
void	addGeoOption(String geoOption) Add a geospatial option to this constraint.
List<String>	getFacetOptions() List the facet options for the GeoSpatial constraint.
QueryOptions.Heatmap	getHeatmap() Returns the heatmap for this GeoSpatial constraint.
QueryOptions.MarkLogicQName	getLatitude() Returns the latitude element or attribute as a MarkLogic QName.
QueryOptions.MarkLogicQName	getLongitude() Returns the longitude element or attribute as a MarkLogic QName.
QueryOptions.MarkLogicQName	getParent() Returns the latitude and longitude container as a MarkLogic QName.
void	setGeoOptions(List<String> geoOptions) Specifies the geospatial options for this constraint.
void	setHeatmap(QueryOptions.Heatmap heatmap) Specifies the heatmap for this GeoSpatial constraint.
void	setLatitude(QueryOptions.MarkLogicQName latitude) Specifies the latitude element or attribute as a MarkLogic QName.
void	setLongitude(QueryOptions.MarkLogicQName longitude) Specifies the longitude element or attribute as a MarkLogic QName.
void	setParent(QueryOptions.MarkLogicQName parent) Specifies the latitude and longitude container as a MarkLogic QName.

Methods inherited from class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem

addTermOption, getAttribute, getElement, getFieldName, getFragmentScope, getJsonKeyName, getPath, getPathIndex, getPathNamespaceBindings, getTermOptions, getWeight, setAttribute, setElement, setField, setFragmentScope, setJsonKey, setPath, setTermOptions, setWeight

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOptions.QueryGeospatialAttributePair

public QueryOptions.QueryGeospatialAttributePair()

Method Detail

addFacetOption

public void addFacetOption(String facetOption)

Add a facet option to this Geospatial constraint.

Parameters:

facetOption - the option

addGeoOption

public void addGeoOption(String geoOption)

Add a geospatial option to this constraint.

Parameters:

geoOption - the option

getFacetOptions

public List<String> getFacetOptions()

List the facet options for the GeoSpatial constraint.

Returns:

the facet options

getHeatmap

public QueryOptions.Heatmap getHeatmap()

Returns the heatmap for this GeoSpatial constraint.

Returns:

the heatmap

getLatitude

public QueryOptions.MarkLogicQName getLatitude()

Returns the latitude element or attribute as a MarkLogic QName.

Returns:

the latitude

getLongitude

public QueryOptions.MarkLogicQName getLongitude()

Returns the longitude element or attribute as a MarkLogic QName.

Returns:

the longitude

getParent

public QueryOptions.MarkLogicQName getParent()

Returns the latitude and longitude container as a MarkLogic QName.

Returns:

the container

setGeoOptions

public void setGeoOptions(List<String> geoOptions)

Specifies the geospatial options for this constraint.

Parameters:

geoOptions - the option list

setHeatmap

public void setHeatmap(QueryOptions.Heatmap heatmap)

Specifies the heatmap for this GeoSpatial constraint.

Parameters:

heatmap - the heatmap

setLatitude

public void setLatitude(QueryOptions.MarkLogicQName latitude)

Specifies the latitude element or attribute as a MarkLogic QName.

Parameters:

latitude - the latitude

setLongitude

public void setLongitude(QueryOptions.MarkLogicQName longitude)

Specifies the longitude element or attribute as a MarkLogic QName.

Parameters:

longitude - the longitude

setParent

public void setParent(QueryOptions.MarkLogicQName parent)

Specifies the latitude and longitude container as a MarkLogic QName.

Parameters:

parent - the container