cts.elementValueQuery

cts.elementvaluequeryctselementvaluequery

/apidoc/8.0/cts:element-value-query.xml

Returns a query matching elements by name with text content equal a given phrase. cts:element-value-query only matches against simple elements (that is, elements that contain only text and have no element children).

One or more element QNames to match. When multiple QNames are specified, the query matches if any QName matches.

element-name

xs.QName[]

One or more element values to match. When multiple strings are specified, the query matches if any string matches.

text

String[]

Options to this query. The default is ().

Options include:

"case-sensitive"

A case-sensitive query.

"case-insensitive"

A case-insensitive query.

"diacritic-sensitive"

A diacritic-sensitive query.

"diacritic-insensitive"

A diacritic-insensitive query.

"punctuation-sensitive"

A punctuation-sensitive query.

"punctuation-insensitive"

A punctuation-insensitive query.

"whitespace-sensitive"

A whitespace-sensitive query.

"whitespace-insensitive"

A whitespace-insensitive query.

"stemmed"

A stemmed query.

"unstemmed"

An unstemmed query.

"wildcarded"

A wildcarded query.

"unwildcarded"

An unwildcarded query.

"exact"

An exact match query. Shorthand for "case-sensitive", "diacritic-sensitive", "punctuation-sensitive", "whitespace-sensitive", "unstemmed", and "unwildcarded".

"lang=iso639code"

Specifies the language of the query. The iso639code code portion is case-insensitive, and uses the languages specified by ISO 639. The default is specified in the database configuration.

"min-occurs=number"

Specifies the minimum number of occurrences required. If fewer that this number of words occur, the fragment does not match. The default is 1.

"max-occurs=number"

Specifies the maximum number of occurrences required. If more than this number of words occur, the fragment does not match. The default is unbounded.

"synonym"

Specifies that all of the terms in the $text parameter are considered synonyms for scoring purposes. The result is that occurrences of more than one of the synonyms are scored as if there are more occurrences of the same term (as opposed to having a separate term that contributes to score).

options

String[]

A weight for this query. Higher weights move search results up in the relevance order. The default is 1.0. The weight should be between 64 and -16. Weights greater than 64 will have the same effect as a weight of 64. Weights less than the absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded to 0, which means that they do not contribute to the score.

weight

Number?

cts.elementValueQuery

If neither "case-sensitive" nor "case-insensitive" is present, $text is used to determine case sensitivity. If $text contains no uppercase, it specifies "case-insensitive". If $text contains uppercase, it specifies "case-sensitive".

If neither "diacritic-sensitive" nor "diacritic-insensitive" is present, $text is used to determine diacritic sensitivity. If $text contains no diacritics, it specifies "diacritic-insensitive". If $text contains diacritics, it specifies "diacritic-sensitive".

If neither "punctuation-sensitive" nor "punctuation-insensitive" is present, $text is used to determine punctuation sensitivity. If $text contains no punctuation, it specifies "punctuation-insensitive". If $text contains punctuation, it specifies "punctuation-sensitive".

If neither "whitespace-sensitive" nor "whitespace-insensitive" is present, the query is "whitespace-insensitive".

If neither "wildcarded" nor "unwildcarded" is present, the database configuration and $text determine wildcarding. If the database has any wildcard indexes enabled ("three character searches", "two character searches", "one character searches", or "trailing wildcard searches") and if $text contains either of the wildcard characters '?' or '*', it specifies "wildcarded". Otherwise it specifies "unwildcarded".

If neither "stemmed" nor "unstemmed" is present, the database configuration determines stemming. If the database has "stemmed searches" enabled, it specifies "stemmed". Otherwise it specifies "unstemmed". If the query is a wildcarded query and also a phrase query (contains two or more terms), the wildcard terms in the query are unstemmed.

Negative "min-occurs" or "max-occurs" values will be treated as 0 and non-integral values will be rounded down. An error will be raised if the "min-occurs" value is greater than the "max-occurs" value.

Note that the text content for the value in a cts:element-value-query is treated the same as a phrase in a cts:word-query, where the phrase is the element value. Therefore, any wildcard and/or stemming rules are treated like a phrase. For example, if you have an element value of "hello friend" with wildcarding enabled for a query, a cts:element-value-query for "he*" will not match because the wildcard matches do not span word boundaries, but a cts:element-value-query for "hello *" will match. A search for "*" will match, because a "*" wildcard by itself is defined to match the value. Similarly, stemming rules are applied to each term, so a search for "hello friends" would match when stemming is enabled for the query because "friends" matches "friend". For an example, see the fourth example below.

Similarly, because a "*" wildcard by itself is defined to match the value, the following query will match any element with the QName my-element, regardless of the wildcard indexes enabled in the database configuration:

cts:element-value-query(xs:QName("my-element"), "*", "wildcarded")

  cts.search(
    cts.elementValueQuery(
      xs.QName("function"),
      "MarkLogic Corporation"));
  
  => .. relevance-ordered sequence of documents
  having 'function' elements whose text
  content equals 'MarkLogic Corporation'.

  cts.search(
    cts.elementValueQuery(
      xs.QName("function"),
      "MarkLogic Corporation", "case-insensitive"));
  
  => .. relevance-ordered sequence of documents
  having 'function' elements whose text
  content equals 'MarkLogic Corporation', or any other
  case-shift like 'MARKLOGIC CorpoRation'.

  cts.search(
    cts.andQuery([
      cts.elementValueQuery(
        xs.QName("function"),
        "MarkLogic Corporation",
        "punctuation-insensitive", 0.5),
      cts.elementValueQuery(
        xs.QName("title"),
        "Word Query")]));
  => .. relevance-ordered sequence of documents having both:
  (a) 'function' elements with text content equal to
      'MarkLogic Corporation', ignoring embedded
      punctuation,
  AND
  (b) 'title' elements with text content equal to
      'Word Query', with the results of the first sub-query
      query given weight 0.5, and the results of the second
      sub-query given the default weight 1.0.  As a result,
      the title phrase 'Word Query' counts more heavily
      towards the relevance score.

var node = xdmp.unquote('<my-node>hello friend</my-node>').next().value.root;
var res = new Array();
res.push(cts.contains(node, cts.elementValueQuery(xs.QName('my-node'),
      "hello friends", "stemmed")));
res.push(cts.contains(node, cts.elementValueQuery(xs.QName('my-node'),
      "he*", "wildcarded")));
res.push(cts.contains(node, cts.elementValueQuery(xs.QName('my-node'),
      "hello f*", "wildcarded")));
res;

=> [true, false, true]