MarkLogic Server 11.0 Product Documentationcts.elementValueCoOccurrences
cts.elementValueCoOccurrences( element-name-1 as xs.QName, element-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 (that is, pairs of values, both of which appear
in the same fragment) from the specified element value lexicon(s). The
values are returned as
an ArrayNode with two children, each child
containing one of the co-occurring values. You can use
cts.frequency
on each item returned to find how many times the pair occurs.
Value lexicons are implemented using range indexes; consequently
this function requires an element range index for each element specified
in the function. If there is not a range index configured for each
of the specified elements, an exception is thrown.
| Parameters | |
|---|---|
| element-name-1 | An element QName. |
| element-name-2 | An element QName. |
| options |
Options. The default is ().
Options include:
|
| query |
Only include co-occurrences in fragments selected by the
cts: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. If a string
is entered, the string is treated as a cts:word-query of the
specified string.
|
| 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 "sample=N" is not specified 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 specified 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 co-occurrences 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 query might contain multiple occurrences or no occurrences.
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 co-occurrences 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.
Example
// This query has the database fragmented on SPEECH and
// finds the first 3 SPEAKERs that co-occur in a SPEECH
// in the play Hamlet.
// Requires an element range index on SPEAKER with range
// value positions enabled on the range index.
fn.subsequence(
cts.elementValueCoOccurrences(
xs.QName("SPEAKER"), xs.QName("SPEAKER"),
["frequency-order","ordered"],
cts.documentQuery("/shakespeare/plays/hamlet.xml")), 1, 3);
=>
["MARCELLUS", "BERNARDO"]
["ROSENCRANTZ", "GUILDENSTERN"]
["HORATIO", "MARCELLUS"]
Example
// this query has the database fragmented on SPEECH and
// finds SPEAKERs that co-occur in a SPEECH in the play Hamlet,
// returned as a map
cts.elementValueCoOccurrences(
xs.QName("SPEAKER"), xs.QName("SPEAKER"),
["frequency-order","ordered", "map"],
cts.documentQuery("/shakespeare/plays/hamlet.xml"))
=>
{
"HORATIO":"MARCELLUS",
"CORNELIUS":"VOLTIMAND",
"MARCELLUS":
["BERNARDO", "HORATIO"],
"ROSENCRANTZ":"GUILDENSTERN"
}
Example
// This example uses the co-occurrences between the URI lexicon
// and an element range index to effectively join documents together.
// Load sample data
declareUpdate();
xdmp.documentInsert("/test1.xml", fn.head(xdmp.unquote(
' <test1><hello>this is a value</hello></test1>')));
xdmp.documentInsert("/test2.xml", fn.head(xdmp.unquote(
' <test2><hello>this is a value</hello></test2>')));
xdmp.documentInsert("/test3.xml", fn.head(xdmp.unquote(
' <test3><hello>this is a different value</hello></test3>')));
**********
// Requires an element range index on 'hello' and the URI lexicon.
// This query finds 'hello' element values that occur in more than one
// document. It is an efficient way to join documents using range indexes.
const x =
cts.elementValueCoOccurrences(
// note the special xdmp:document QName for the URI lexicon
xs.QName("hello"), xs.QName("xdmp:document"),
// uses the "map" option, so returns the results as a JavaScript object
["frequency-order", "map",
"collation-1=http://marklogic.com/collation/",
"collation-2=http://marklogic.com/collation/codepoint"]);
const res = new Array();
// Iterate through each property and return the ones that have
// 2 or more values.
for (y in x) {
if (x[y].length > 1) {
let o = new Object();
o[y] = x[y];
res.push(o);}
};
res;
// returns the values that occur in more than one document (URI)
=>
[{"this is a value":["/test1.xml", "/test2.xml"]}]