XQuery cts:geospatial-region-path-reference

MarkLogic 12 EA 1 Product Documentation
cts.geospatialRegionPathReference

cts.geospatialRegionPathReference(
   path-expression as String,
   [options as String[]],
   [namespaces as Object],
   [geohash-precision as Number?],
   [units as String?],
   [invalid-values as String?]
) as cts.reference

Summary

Create a reference to a geospatial region path index, for use as a parameter to cts.geospatialRegionQuery and other query operations on geospatial region indexes. This function throws an exception if the specified region path index does not exist.

Parameters
path-expression The XPath expression specified in the index configuration.
options Index configuration options. The default is (). These options should match the configuration used when creating the index. Available options:
"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 (default) and double.
"unchecked"
Read the coordinate-system info only from the input. Do not check the definition against the context database.
namespaces A map of namespace bindings. The keys should be namespace prefixes and the values should be namespace URIs. These namespace bindings will be added to the in-scope namespace bindings in the interpretation of the path.
geohash-precision The geohash precision specified in the index configuration. Values between 1 and 12 inclusive are possible.
units The units specified in the index configuration. 'miles', 'km', 'feet', and 'meters' are valid.
invalid-values The invalid values setting specified in the index configuration. 'reject' and 'ignore' are valid.

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 the specified precision does not exist.

See Also

Example

cts.geospatialRegionPathReference('//item/region')

=> A region path index reference of the following form:

  cts.geospatialRegionPathReference("//item/region",["coordinate-system=wgs84"])

Example

cts.geospatialRegionPathReference(
  '//item/region', ['coordinate-system=wgs84','precision=double'])

=> A region path index reference of the following form:

  cts.geospatialRegionPathReference(
    "//item/region",["coordinate-system=wgs84/double"])

Example

cts.geospatialRegionPathReference(
  '//item/region', ['coordinate-system=wgs84','precision=double'], null, 4, 'miles', 'reject')

=> A region path index reference of the following form:

  cts.geospatialRegionPathReference(
    "//item/region",["coordinate-system=wgs84/double"],["geohash-precision=4"],["units=miles"],["invalid-values=0"])

Example

cts.geospatialRegionPathReference(
  '//kml:LinearRing/kml:coordinates', [],
  {kml: 'http://www.opengis.net/kml/2.2'})

=> A region path index reference of the following form:

   cts.geospatialRegionPathReference(
     "//kml:LinearRing/kml:coordinates",
     ["coordinate-system=wgs84"],
     {kml:"http://www.opengis.net/kml/2.2"})
Powered by MarkLogic Server | Terms of Use | Privacy Policy