XQuery cts:geospatial-element-pair-reference

MarkLogic Server 11.0 Product Documentation
cts.geospatialElementPairReference

cts.geospatialElementPairReference(
   element as xs.QName,
   lat as xs.QName,
   long as xs.QName,
   [options as String[]]
) as cts.reference

Summary

Creates a reference to a geospatial element pair range index, for use as a parameter to cts.valueTuples. This function will throw an exception if the specified range index does not exist.

Parameters
element An element QName name.
lat An element QName name.
long An element QName name.
options Options. The default is ().

Options include:

"type=type"
Use the lexicon with the type specified by type (point or long-lat-point)
"coordinate-system=string"
Use the given coordinate system. Valid values are:
wgs84
The WGS84 coordinate system with degrees as the angular unit.
wgs84/radians
The WGS84 coordinate system with radians as the angular unit.
wgs84/double
The WGS84 coordinate system at double precision with degrees as the angular unit.
wgs84/radians/double
The WGS84 coordinate system at double precision with radians as the angular unit.
etrs89
The ETRS89 coordinate system.
etrs89/double
The ETRS89 coordinate system at double precision.
raw
The raw (unmapped) coordinate system.
raw/double
The raw coordinate system at double precision.
"precision=value"
Use the coordinate system at the given precision. Allowed values: float and double.
"nullable"
Allow null values in tuples reported from cts.valueTuples when using this lexicon.
"unchecked"
Read the scalar type and coordinate-system info only from the input. Do not check the definition against the context database.

Usage Notes

The value of the precision option takes precedence over that implied by the governing coordinate system name, including the value of the coordinate-system option. For example, if the governing coordinate system is "wgs84/double" and the precision option is "float", then the reference uses single precision. An exception is thrown if an index with specified precision does not exist.

See Also

Example

cts.geospatialElementPairReference(xs.QName("pt"), xs.QName("lat"),
  xs.QName("long"));

=> cts.geospatialElementPairReference(fn:QName("","pt"), fn.QName("","lat"),
     fn.QName("","long"), ["type=point","coordinate-system=wgs84"])
Powered by MarkLogic Server | Terms of Use | Privacy Policy