cts:entity-walk

cts:entity-walk(
   $node as node(),
   $expr as item()*,
   [$dict as cts:entity-dictionary]
) as empty-sequence()

Summary

Walk an XML document or element node, evaluating an expression against any matching entities. This functions is similar to cts:entity-highlight in how it processes matched entities, but it differs in what it returns.

Parameters
node	A node to walk. The node must be either an XML document node or an XML element node; it cannot be a text node.
$expr	An expression to evaluate for each match. You can use the variables `$cts:text`, `$cts:node`, `$cts:entity-type`, `$cts:normalized-text`, `$cts:entity-id`, `$cts:start`, and `$cts:action` in the expression. See the Usage Notes for details.
dict	The entity dictionary to use for matching entities in the text of the input node. If you omit this parameter, the default entity dictionary is used. (No default dictionaries currently exist.) See the Usage Notes for details.

Usage Notes

The following variables are available for use inline in the expr parameter. These variables make aspects of the matched entity available to your inline code.

$cts:node as text()

The node containing the match.

$cts:text as xs:string

The matched text. In the case of overlapping matches, this value may not encompass the entirety of the entity match string. Rather, it contains only the non-overlapping part of the text, in order to prevent introduction of duplicate text in the final result.

$cts:entity-type

The type of the matched entity, as defined by the type field of the matching entity dictionary entry.

$cts:entity-id

The ID of the matched entity, as defined by the id field of the matching entity dictionary entry.

$cts:normalized-text as xs:string

The normalized entity text (only applicable to some languages).

$cts:start as xs:integer

The offset (in codepoints) of the start of $cts:text in the matched text node.

$cts:action as xs:string

The action to take. Use xdmp:set on this variable in your inline code to specify what should happen next. Use xdmp:set to set the value to one of the following:

"continue"

Walk the next match. If there are no more matches, return all evaluation results. This is the default action.

"skip"

Skip walking any more matches and return all evaluation results.

"break"

Stop walking matches and return all evaluation results.