MarkLogic 10 Product Documentation
cts.geospatialPathReference

cts.geospatialPathReference(
   path-expression as String,
   [options as String[]],
   [map as Object]
) as cts.reference

Summary

Creates a reference to a geospatial path 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

path-expression A path expression.

Parameters
path-expression	A path expression.
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. wgs84/double The WGS84 coordinate system at double precision. 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.
map	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.

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.

wgs84/double
The WGS84 coordinate system at double precision.

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.

map 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.

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.

Example

cts.geospatialPathReference("//item/point");

=> cts.geospatialPathReference("//item/point",
     ["type=point","coordinate-system=wgs84"])

MarkLogic 10 Product Documentationcts.geospatialPathReference

Summary

Usage Notes

See Also

Example

MarkLogic 10 Product Documentation
cts.geospatialPathReference