XQuery cts:element-attribute-value-geospatial-co-occurrences

MarkLogic Server 11.0 Product Documentation
cts.elementAttributeValueGeospatialCoOccurrences

cts.elementAttributeValueGeospatialCoOccurrences(
   element-name-1 as xs.QName,
   attribute-name-1 as xs.QName?,
   geo-element-name as xs.QName,
   [coord-child-name-1 as xs.QName?],
   [coord-child-name-2 as xs.QName?],
   [options as String[]],
   [query as cts.query?],
   [quality-weight as Number?],
   [forest-ids as (Number|String)[]]
) as Sequence

Summary

Returns value co-occurrences from the specified element-attribute value lexicon with the specified geospatial lexicon. Value lexicons are implemented using range indexes; consequently this function requires a range index for the element and attribute pair specified in the function. If there is not a range index configured for the specified element and attribute pair, then an exception is thrown. Geospatial lexicons are implemented using geospatial indexes; consequently this function requires a geospatial index for the element/attribute combination specified in the function. If there is not a geospatial index configured for the specified element/attribute combination, then an exception is thrown.

Parameters
element-name-1 A QName identifying the parent element of the first lexicon.
attribute-name-1 A QName identifying an attribute of element-name-1.
geo-element-name A QName identifying the second lexicon, which must reference a geospatial lexicon. If it is an element child or JSON property child geospatial lexicon, pass the child QName in the coord-child-name-1 parameter. For an element, element attribute, or JSON property child pair geospatial lexicon, pass the child QNames in coord-child-name-1 and coord-child-name-2.
coord-child-name-1 An element, element attribute QName or JSON property name identifying the child of geo-element-name that holds either the lat and longitude coordinates (element child geospatial lexicon) or the latitude coordinate (element/attribute/JSON property child pair geospatial lexicon). Use an empty sequence if geo-element-name identifies an element or JSON property geospatial lexicon.
coord-child-name-2 An element, element attribute QName or JSON property name identifying the child of geo-element-name that holds the longitude coordinate when working with an element/attribute/JSON property child pair geospatial lexicon. Use empty sequence for an element or JSON property geospatial lexicon or element or JSON property child geospatial lexicon.
options Options. The default is (). The following options are available:
"geospatial-format=format"
Use the kind of geospatial lexicon specified by format (element, element-child, element-pair, or element-attribute-pair). If neither of the child QNames is specified, the default is "element"; if only the first of the child QNames is specified, the default is "element-child:; if both child QNames are specified, the default is "element-pair". If the selection is not compatible with the number of geospatial QNames specified, an error is raised.
"ascending"
Co-occurrences should be returned in ascending order.
"descending"
Co-occurrences should be returned in descending order.
"any"
Co-occurrences from any fragment should be included.
"document"
Co-occurrences from document fragments should be included.
"properties"
Co-occurrences from properties fragments should be included.
"locks"
Co-occurrences from locks fragments should be included.
"frequency-order"
Co-occurrences should be returned ordered by frequency.
"item-order"
Co-occurrences should be returned ordered by item.
"fragment-frequency"
Frequency should be the number of fragments with an included co-occurrences. This option is used with cts.frequency.
"item-frequency"
Frequency should be the number of occurrences of an included co-occurrence. This option is used with cts.frequency.
"type=type"
For the non-geospatial lexicon, use the type specified by type (int, unsignedInt, long, unsignedLong, float, double, decimal, dateTime, time, date, gYearMonth, gYear, gMonth, gDay, yearMonthDuration, dayTimeDuration, string, or anyURI)
"collation=URI"
For the non-geospatial lexicon, use the collation specified by URI.
"coordinate-system=name"
For the geospatial lexicons, use 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.
"timezone=TZ"
Return timezone sensitive values (dateTime, time, date, gYearMonth, gYear, gMonth, and gDay) adjusted to the timezone specified by TZ. Example timezones: Z, -08:00, +01:00.
"ordered"
Include co-occurrences only when the value from the first lexicon appears before the value from the second lexicon. Requires that word positions be enabled for both lexicons.
"reversed"
Consider the second lexicon as the first and vice versa.
"proximity=N"
Include co-occurrences only when the values appear within N words of each other. Requires that word positions be enabled for both lexicons.
"limit=N"
Return no more than N co-occurrences. 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. Co-occurrences 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 co-occurrences 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 co-occurrences 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.
"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.
"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 co-occurrences in fragments selected by this query, and compute frequencies from this set of included co-occurrences. The co-occurrences 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 "eager" if "frequency-order" or "map" is specified, otherwise "lazy".

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 "collation=URI" is not specified in the options parameter, then the default collation is used. If a lexicon with that collation does not exist, an error is thrown.

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.

If "sample=N" is not specfied in the options parameter, then all included co-occurrences 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 co-occurrences 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.

See Also

Example

//   Get the co-occurrences of the "name" attribute on the "person" element
//   with points encoded as "lat" and "long" attributes of "location"
//   elements. Return the co-occurrences as an ArrayNode with frequencies.

cts.elementAttributeValueGeospatialCoOccurrences(
     fn.QName("http://example.com/ns/geo", "person"),
     xs.QName("name"),
     fn.QName("http://example.com/ns/geo", "location"),
     fn.QName("http://example.com/ns/geo", "lat"),
     fn.QName("http://example.com/ns/geo", "long"),
     ["collation=http://marklogic.com/collation/codepoint"]);
Powered by MarkLogic Server | Terms of Use | Privacy Policy