XQuery cts:geospatial-json-property-child-reference

MarkLogic 9 Product Documentation
cts.geospatialJsonPropertyChildReference

cts.geospatialJsonPropertyChildReference(
   property as String,
   child as String,
   [options as String[]]
) as cts.reference

Summary

Creates a reference to a geospatial json property child range index, for use as a parameter to cts:value-tuples cts.valueTuples. This function will throw an exception if the specified range index does not exist.

Parameters

property A JSON property name.

child A JSON property name.

Parameters
property	A JSON property name.
child	A JSON property 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. 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.

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.

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

Example

cts.geospatialJsonPropertyChildReference("location", "point")

=> cts.geospatialJsonPropertyChildReference("location", "point",
     ["type=point","coordinate-system=wgs84"])

MarkLogic 9 Product Documentationcts.geospatialJsonPropertyChildReference

Summary

Usage Notes

See Also

Example

MarkLogic 9 Product Documentation
cts.geospatialJsonPropertyChildReference