cts.elementAttributeWords

cts.elementattributewordsctselementattributewords

/apidoc/8.0/cts:element-attribute-words.xml

Returns words from the specified element-attribute word lexicon(s). This function requires an element-attribute word lexicon for each of the element/attribute pairs specified in the function. If there is not an element/attribute word lexicon configured for any of the specified element/attribute pairs, then an exception is thrown. The words are returned in collation order.

One or more element QNames.

element-names

xs.QName[]

One or more attribute QNames.

attribute-names

xs.QName[]

A starting word. Returns only this word and any following words from the lexicon. If the parameter is not in the lexicon, then it returns the words beginning with the next word.

start

String?

Options. The default is ().

Options include:

"ascending"

Words should be returned in ascending order.

"descending"

Words should be returned in descending order.

"any"

Words from any fragment should be included.

"document"

Words from document fragments should be included.

"properties"

Words from properties fragments should be included.

"locks"

Words from locks fragments should be included.

"collation=URI"

Use the lexicon with the collation specified by URI.

"limit=N"

Return no more than N words.

"skip=N"

Skip over fragments selected by the cts:query to treat the Nth fragment as the first fragment. Words from skipped fragments are not included. Only applies when a $query parameter is specified.

"sample=N"

Return only words from the first N fragments after skip selected by the cts:query. Only applies when a $query parameter is specified.

"truncate=N"

Include only words from the first N fragments after skip selected by the cts:query. Only applies when a $query parameter is specified.

"score-logtfidf"

Compute scores using the logtfidf method.

"score-logtf"

Compute scores using the logtf method.

"score-simple"

Compute scores using the simple method.

"score-random"

Compute scores using the random method.

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

"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 ValueIterator.

options

String[]

Only include words in fragments selected by the cts:query. The words do not need to match the query, but the words 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. If a string is entered, the string is treated as a cts:word-query of the specified string.

query

cts.query?

A document quality weight to use when computing scores. The default is 1.0.

quality-weight

Number?

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 ().

forest-ids

String[]

ValueIterator

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

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 "sample=N" is not specfied in the options parameter, then all included words 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 words from all fragments selected by the $query parameter are included. If a $query parameter is not present, then "truncate=N" has no effect.

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

When run without a $query parameter and as a user with the admin role, the word lexicon functions return results that might include words from deleted fragments. However, when run as a user with the admin role and without a $query parameter, the word lexicon functions run faster (because they do not need to look up where each word comes from). It is therefore faster to run word lexicon functions as an admin user without passing a $query parameter.

  cts.elementAttributeWords(xs.QName("animal"),
                              xs.QName("name"),
                              "aardvark")
  => ("aardvark","aardvarks","aardwolf",...)