cts.pathReference

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

Summary

Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples. Since lexicons are implemented with range indexes, this function will throw an exception if the specified range index does not exist.

Parameters

path-expression A path range index expression.

Parameters
path-expression	A path range index expression.
options	Options. The default is (). Options include: "type=type" Use the lexicon with the type specified by type (int, unsignedInt, long, unsignedLong, float, double, decimal, dateTime, time, date, gYearMonth, gYear, gMonth, gDay, yearMonthDuration, dayTimeDuration, string, anyURI, point, or long-lat-point) "collation=URI" Use the lexicon with the collation specified by URI. "nullable" Allow null values in tuples reported from cts:value-tuples when using this lexicon. "unchecked" Read the scalar type, collation and coordinate-system info only from the input. Do not check the definition against the context database. "coordinate-system=name" Create a reference to an index or lexicon based on the specified coordinate system. Allowed values: "wgs84", "wgs84/double", "raw", "raw/double". Only applicable if the index/lexicon value type is `point` or `long-lat-point`. "precision=value" Create a reference to an index or lexicon configured with the specified geospatial precision. Allowed values: `float` and `double`. Only applicable if the index/lexicon value type is `point` or `long-lat-point`. This value takes precedence over the precision implicit in the coordinate system name.
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 (int, unsignedInt, long, unsignedLong, float, double, decimal, dateTime, time, date, gYearMonth, gYear, gMonth, gDay, yearMonthDuration, dayTimeDuration, string, anyURI, point, or long-lat-point)

"collation=URI"

Use the lexicon with the collation specified by URI.

"nullable"

Allow null values in tuples reported from cts:value-tuples when using this lexicon.

"unchecked"

Read the scalar type, collation and coordinate-system info only from the input. Do not check the definition against the context database.

"coordinate-system=name"

Create a reference to an index or lexicon based on the specified coordinate system. Allowed values: "wgs84", "wgs84/double", "raw", "raw/double". Only applicable if the index/lexicon value type is point or long-lat-point.

"precision=value"

Create a reference to an index or lexicon configured with the specified geospatial precision. Allowed values: float and double. Only applicable if the index/lexicon value type is point or long-lat-point. This value takes precedence over the precision implicit in the coordinate system name.

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.

Example

cts.pathReference("/section/title");
=>
cts.pathReference("/section/title",
  ["type=string","collation=http://marklogic.com/collation/"])

Example

cts.pathReference("/a:section/b:title",
  ["type=string","collation=http://marklogic.com/collation/codepoint"],
  {a:"a-namespace", b:"b-namespace"});
=>
cts.pathReference("/a:section/b:title",
  ["type=string","collation=http://marklogic.com/collation/codepoint"],
  {a:"a-namespace", b:"b-namespace"})