XQuery cts:element-child-geospatial-values

MarkLogic 10 Product Documentation
cts.elementChildGeospatialValues

cts.elementChildGeospatialValues(
   element-names as xs.QName[],
   child-names as xs.QName[],
   [start as cts.point?],
   [options as String[]],
   [query as cts.query?],
   [quality-weight as Number?],
   [forest-ids as (Number|String)[]]
) as Sequence

Summary

Returns values from the specified element-child geospatial value lexicon(s). Element-child geospatial value lexicons are implemented using geospatial indexes; consequently this function requires an element-child geospatial index of for each of the element/child pairs specified in the function. If there is not a range index configured for each of the specified element/child pairs, then an exception is thrown.

Parameters
element-names One or more element QNames.
child-names One or more child element QNames.
start A starting value. If the parameter value is not in the lexicon, then the values are returned beginning with the next value.
options Options. The default is ().

Options include:

"ascending"
Values should be returned in ascending order.
"descending"
Values should be returned in descending order.
"any"
Values from any fragment should be included.
"document"
Values from document fragments should be included.
"properties"
Values from properties fragments should be included.
"locks"
Values from locks fragments should be included.
"frequency-order"
Values should be returned ordered by frequency.
"item-order"
Values should be returned ordered by item.
"fragment-frequency"
Frequency should be the number of fragments with an included value. This option is used with cts.frequency.
"item-frequency"
Frequency should be the number of occurrences of an included value. This option is used with cts.frequency.
"coordinate-system=name"
Use the lexicon with the coordinate system specified by name. Allowed values: "wgs84", "wgs84/double", "etrs89", "etrs89/double", "raw", "raw/double".
"precision=value"
Use the coordinate system at the given precision. Allowed values: float and double.
"limit=N"
Return no more than N values. You should not use this option with the "skip" option. Use "truncate" instead.
"skip=N"
Skip over fragments selected by the query to treat the Nth matching fragment as the first fragment. Values from skipped fragments are not included. This option affects the number of fragments selected by the query to calculate frequencies. Only applies when a $query parameter is specified.
"sample=N"
Return only values from the first N fragments after skip selected by the query. This option does not affect the number of fragments selected by the query to calculate frequencies. Only applies when a $query parameter is specified.
"truncate=N"
Include only values from the first N fragments after skip selected by the query. This option affects the number of fragments selected by the query to calculate frequencies. Only applies when a $query parameter is specified.
"type=long-lat-point"
Specifies the format for the point in the data as longitude first, latitude second.
"type=point"
Specifies the format for the point in the data as latitude first, longitude second. This is the default format.
"score-logtfidf"
Compute scores using the logtfidf method. Only applies when a $query parameter is specified.
"score-logtf"
Compute scores using the logtf method. Only applies when a $query parameter is specified.
"score-simple"
Compute scores using the simple method. Only applies when a $query parameter is specified.
"score-random"
Compute scores using the random method. Only applies when a $query parameter is specified.
"score-zero"
Compute all scores as zero. Only applies when a $query parameter is specified.
"score-zero"
Compute all scores as zero.
"checked"
Word positions should be checked when resolving the query.
"unchecked"
Word positions should not be checked when resolving the query.
"too-many-positions-error"
If too much memory is needed to perform positions calculations to check whether a document matches a query, return an XDMP-TOOMANYPOSITIONS error, instead of accepting the document as a match.
"eager"
Perform most of the work concurrently before returning the first item from the indexes, and only some of the work sequentially while iterating through the rest of the items. This usually takes the shortest time for a complete item-order result or for any frequency-order result.
"lazy"
Perform only some the work concurrently before returning the first item from the indexes, and most of the work sequentially while iterating through the rest of the items. This usually takes the shortest time for a small item-order partial result.
"concurrent"
Perform the work concurrently in another thread. This is a hint to the query optimizer to help parallelize the lexicon work, allowing the calling query to continue performing other work while the lexicon processing occurs. This is especially useful in cases where multiple lexicon calls occur in the same query (for example, resolving many facets in a single query).
"map"
Return results as a JavaScript Object instead of as a Sequence.
query Only include values in fragments selected by this query, and compute frequencies from this set of included values. The values do not need to match the query, but they must occur in fragments selected by the query. The fragments are not filtered to ensure they match the query, but instead selected in the same manner as "unfiltered" cts:search operations.
quality-weight A document quality weight to use when computing scores. The default is 1.0.
forest-ids A sequence of IDs of forests to which the search will be constrained. An empty sequence means to search all forests in the database. The default is ().

Usage Notes

Only one of "frequency-order" or "item-order" may be specified in the options parameter. If neither "frequency-order" nor "item-order" is specified, then the default is "item-order".

Only one of "fragment-frequency" or "item-frequency" may be specified in the options parameter. If neither "fragment-frequency" nor "item-frequency" is specified, then the default is "fragment-frequency".

Only one of "ascending" or "descending" may be specified in the options parameter. If neither "ascending" nor "descending" is specified, then the default is "ascending" if "item-order" is specified, and "descending" if "frequency-order" is specified.

Only one of "eager" or "lazy" may be specified in the options parameter. If neither "eager" nor "lazy" is specified, then the default is "lazy" if "item-order" is specified, and "eager" if "frequency-order" is specified.

Only one of "any", "document", "properties", or "locks" may be specified in the options parameter. If none of "any", "document", "properties", or "locks" are specified and there is a $query parameter, then the default is "document". If there is no $query parameter then the default is "any".

Only one of the "score-logtfidf", "score-logtf", "score-simple", "score-random", or "score-zero" options may be specified in the options parameter. If none of "score-logtfidf", "score-logtf", "score-simple", "score-random", or "score-zero" are specified, then the default is "score-logtfidf".

Only one of the "checked" or "unchecked" options may be specified in the options parameter. If neither "checked" nor "unchecked" are specified, then the default is "checked".

If "coordinate-system=name" is not specified in the options parameter, then the default coordinate system is used. If a lexicon with that coordinate system does not exist, an error is thrown.

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 query uses single precision.

If "sample=N" is not specfied in the options parameter, then all included values may be returned. If a $query parameter is not present, then "sample=N" has no effect.

If "truncate=N" is not specfied in the options parameter, then values from all fragments selected by the $query parameter are included. If a $query parameter is not present, then "truncate=N" has no effect.

To incrementally fetch a subset of the values returned by this function, use fn.subsequence on the output, rather than the "skip" option. The "skip" option is based on fragments matching the query parameter (if present), not on values. A fragment matched by the query might produce multiple values or no values. The number of fragments skipped does not correspond to the number of values. Also, the skip is applied to the relevance ordered query matches, not to the ordered value list.

When using the "skip" option, use the "truncate" option rather than the "limit" option to control the number of matching fragments from which to draw values.

When multiple element and/or child QNames are specified, then all possible element/child QName combinations are used to select the matching values.

See Also

Example

cts.elementChildGeospatialValues(
     xs.QName("location"), xs.QName("position"), cts.point(0,0) );

=> (cts:point(0,0),cts:point(0,10),cts:point(0,20),...)
Powered by MarkLogic Server | Terms of Use | Privacy Policy