|
Function Summary
|
|
cpf:check-transition
|
Verify that the current transition is the correct one for the
document.
|
|
cpf:document-get-error
|
Fetch a trace of the error that caused the document's processing to fail, if
any.
|
|
cpf:document-get-last-updated
|
Determine the date and time of the last update to the document's content, if
any.
|
|
cpf:document-get-processing-status
|
Determine the document's current processing status, if any.
|
|
cpf:document-get-state
|
Determine the document's current state, if any.
|
|
cpf:document-set-error
|
Set the document's error trace to the given value.
|
|
cpf:document-set-last-updated
|
Set the date and time of the document's last update.
|
|
cpf:document-set-processing-status
|
Set the document's processing status to the given value.
|
|
cpf:document-set-state
|
Set the document's state to the given state.
|
|
cpf:failure
|
Concludes the state action in failure, advancing the state as defined by the
state transition.
|
|
cpf:success
|
Concludes the action successfully, advancing the state as defined by the
transition.
|
|
css:convert
|
Convert CSS text to an equivalent XML representation that is more suitable
for analysis.
|
|
css:get
|
Fetch the CSS for the given document, be it embedded or linked.
|
|
cts:and-not-query
|
Returns a query specifying the set difference of
the matches specified by two sub-queries.
|
|
|
Returns the negative (second parameter) query used to construct the
specified query.
|
|
|
Returns the positive (first parameter) query used to construct the
specified query.
|
|
cts:and-query
|
Returns a query specifying the intersection
of the matches specified by the sub-queries.
|
|
|
Returns the options for the specified query.
|
|
|
Returns a sequence of the queries that were used to construct the specified
query.
|
|
cts:classify
|
Classifies a sequence of nodes based on training data.
|
|
cts:collection-match
|
Returns values from the collection lexicon
that match the specified wildcard pattern.
|
|
cts:collection-query
|
Returns a query matching documents in the collections with the given URIs.
|
|
|
Returns the URIs used to construct the specified query.
|
|
cts:collections
|
Returns values from the collection lexicon.
|
|
cts:confidence
|
Returns the confidence of a node,
or of the context node if no node is provided.
|
|
cts:contains
|
Returns true if any of a sequence of nodes matches a query.
|
|
cts:deregister
|
Deregister a registered query, explicitly releasing the associated
resources.
|
|
cts:directory-query
|
Returns a query matching documents in the directories with the given URIs.
|
|
|
Returns the depth used to construct the specified query.
|
|
|
Returns the URIs used to construct the specified query.
|
|
cts:document-query
|
Returns a query matching documents with the given URIs.
|
|
|
Returns the URIs used to construct the specified query.
|
|
cts:element-attribute-range-query
|
Returns a cts:query matching elements by name with a
range-index entry equal a given value.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the operator used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the value used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-attribute-value-match
|
Returns values from the specified element-attribute value lexicon(s)
that match the specified wildcard pattern.
|
|
cts:element-attribute-value-query
|
Returns a query matching elements by name with attributes by name
with text content equal a given phrase.
|
|
|
Returns the attribute QNames used to construct the specified query.
|
|
|
Returns the element QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-attribute-values
|
Returns values from the specified element-attribute value lexicon(s).
|
|
cts:element-attribute-word-match
|
Returns words from the specified element-attribute word lexicon(s) that
match a wildcard pattern.
|
|
cts:element-attribute-word-query
|
Returns a query matching elements by name
with attributes by name
with text content containing a given phrase.
|
|
|
Returns the attribute QNames used to construct the specified query.
|
|
|
Returns the element QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-attribute-words
|
Returns words from the specified element-attribute word lexicon(s).
|
|
cts:element-query
|
Returns a cts:query matching elements by name
with the content constrained by the given cts:query in the
second parameter.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the query used to construct the element query.
|
|
cts:element-range-query
|
Returns a cts:query matching elements by name with a
range-index entry equal a given value.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the operator used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the value used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-value-match
|
Returns values from the specified element value lexicon(s)
that match the specified wildcard pattern.
|
|
cts:element-value-query
|
Returns a query matching elements by name with text content equal a
given phrase.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-values
|
Returns values from the specified element value lexicon(s).
|
|
cts:element-word-match
|
Returns words from the specified element word lexicon(s) that match
a wildcard pattern.
|
|
cts:element-word-query
|
Returns a query matching elements by name with text content containing
a given phrase.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-words
|
Returns words from the specified element word lexicon.
|
|
cts:field-word-match
|
Returns words from the specified field word lexicon(s) that match
a wildcard pattern.
|
|
cts:field-word-query
|
Returns a query matching text content containing a given phrase in the
specified field.
|
|
|
Returns the names used to construct the specified
cts:field-word-query.
|
|
|
Returns the options for the specified
cts:field-word-query.
|
|
|
Returns the text used to construct the specified
cts:field-word-query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:field-words
|
Returns words from the specified field word lexicon.
|
|
cts:fitness
|
Returns the fitness of a node,
or of the context node if no node is provided.
|
|
cts:frequency
|
Returns an integer representing the number of times in which a particular
value occurs in a value lexicon lookup (for example,
cts:element-values).
|
|
cts:highlight
|
Returns a copy of the node, replacing any text matching the query
with the specified expression.
|
|
cts:near-query
|
Returns a query matching all of the specified queries, where
the matches occur within the specified distance from each other.
|
|
|
Returns the distance used to construct the near query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the query sequence used to construct the near query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:not-query
|
Returns a query specifying the matches not specified by its sub-query.
|
|
|
Returns the query used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:or-query
|
Returns a query specifying the union
of the matches specified by the sub-queries.
|
|
|
Returns a sequence of the queries that were used to construct the specified
query.
|
|
cts:quality
|
Returns the quality of a node,
or of the context node if no node is provided.
|
|
cts:register
|
Register a query for later use.
|
|
cts:registered-query
|
Returns a query matching fragments specified by previously registered
queries (see cts:register).
|
|
|
Returns the registered query identifiers used to construct the specified
query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:remainder
|
Returns an estimated search result size for a node,
or of the context node if no node is provided.
|
|
cts:score
|
Returns the score of a node,
or of the context node if no node is provided.
|
|
cts:search
|
Returns a relevance-ordered sequence of nodes specified by a given query.
|
|
cts:similar-query
|
Returns a query matching nodes similar to the model nodes.
|
|
|
Returns the nodes used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:stem
|
Stems a word.
|
|
cts:thresholds
|
Compute precision, recall, the F measure, and thresholds for the
classes computed by the classifier, by comparing with the labels
for the same set.
|
|
cts:tokenize
|
Tokenizes text into words, punctuation, and spaces.
|
|
cts:train
|
Produces a set of classifiers from a list of
labeled training documents.
|
|
cts:uri-match
|
Returns values from the URI lexicon
that match the specified wildcard pattern.
|
|
cts:uris
|
Returns values from the URI lexicon.
|
|
cts:word-match
|
Returns words from the word lexicon that match the wildcard pattern.
|
|
cts:word-query
|
Returns a query matching text content containing a given phrase.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:words
|
Returns words from the word lexicon.
|
|
cvt:basename
|
Return the filename part of the URI, cutting off any query strings or
fragments.
|
|
cvt:basepath
|
Return the base path of the URI, cutting off the filename.
|
|
cvt:destination-uri
|
Construct the destination URI from the source URI using the following
rules:
The path prefix of the destination URI is the same as the source URI's.
|
|
cvt:part-uri
|
Construct the URI for the part using the following rules:
The path prefix of the part URI is the same source URI's, followed by
a subdirectory name.
|
|
cvt:save-converted-documents
|
Save a set of converted documents, with appropriate links.
|
|
dbg:attach
|
Attach to a request and stop it for debugging.
|
|
dbg:attached
|
Return the request ID's of attached requests in a given server.
|
|
dbg:break
|
Set a breakpoint at the given expression ID.
|
|
dbg:breakpoints
|
Returns a sequence of expression ID's representing existing
breakpoints for the given request.
|
|
dbg:clear
|
Clear a breakpoint at the given expression ID.
|
|
dbg:connect
|
Connect to a Server (http, xdbc, or task) for debugging.
|
|
dbg:continue
|
Continue evaluation of the request.
|
|
dbg:detach
|
Detach from a stopped request.
|
|
dbg:disconnect
|
End the debugging of a server.
|
|
dbg:eval
|
Evaluate a string as an XQuery for debugging.
|
|
dbg:expr
|
Returns a description/representation of a given expression.
|
|
dbg:finish
|
Continue evaluation of the request until the end of the
current function.
|
|
dbg:function
|
Returns the expression ID representing the function
defined in a module with a given name.
|
|
dbg:invoke
|
Invoke a module for debugging.
|
|
dbg:line
|
Returns a sequence of expression ID's found on a given line of a
stopped request.
|
|
dbg:next
|
Continue evaluation of the request until the beginning or end
of an expression that is not a descendant of the current expression.
|
|
dbg:out
|
Continue evaluation of the request until the end of the
current expression.
|
|
dbg:stack
|
Return the stack trace for a given request.
|
|
dbg:status
|
Return the debugging status of given requests.
|
|
dbg:step
|
Continue evaluation of the request until the beginning or end
of an expression.
|
|
dbg:stop
|
Placing this call in XQuery will instruct the evaluator to stop
a request for debugging.
|
|
dbg:stopped
|
Return the request ID's of stopped requests in a given server.
|
|
dbg:value
|
Evaluate an expression in the context of the identified stopped request.
|
|
dbg:wait
|
Wait until at least one of the given requests stops or all
complete evaluating.
|
|
dbk:convert
|
Convert XHTML to DocBook lite vocabulary, if possible.
|
|
dom:add-permissions
|
Add permissions to the domain.
|
|
dom:add-pipeline
|
Add another pipeline to the set of pipelines bound to the domain.
|
|
dom:collection
|
Return the name of the collection in which domains are stored.
|
|
dom:create
|
Create a new content processing domain, along with the
triggers that perform work in that domain.
|
|
dom:domain-scope
|
Create a domain scope element.
|
|
dom:domains
|
Return all the domains.
|
|
dom:evaluation-context
|
Create an evaluation context element.
|
|
dom:get
|
Find a particular domain.
|
|
dom:remove
|
Remove the domain and any associated triggers.
|
|
dom:remove-permissions
|
Remove permissions to the domain.
|
|
dom:remove-pipeline
|
Remove the association between a pipeline and the domain.
|
|
dom:set-description
|
Set the description of the domain.
|
|
dom:set-domain-scope
|
Set the scope of the domain.
|
|
dom:set-evaluation-context
|
Set the evaluation context of the domain.
|
|
dom:set-name
|
Set the name of the domain to something else.
|
|
dom:set-permissions
|
Set the permissions of the domain.
|
|
dom:set-pipelines
|
Bind a new set of pipelines to the domain.
|
|
excel:clean
|
Clean up any conversion artifacts or other infelicities, putting each
sheet into its own div element.
|
|
fn:abs
|
Returns the absolute value of $arg.
|
|
fn:adjust-date-to-timezone
|
Adjusts an xs:date value to a specific timezone, or to no timezone at
all.
|
|
fn:adjust-dateTime-to-timezone
|
Adjusts an xs:dateTime value to a specific timezone, or to no
timezone at all.
|
|
fn:adjust-time-to-timezone
|
Adjusts an xs:time value to a specific timezone, or to no timezone at
all.
|
|
fn:avg
|
Returns the average of the values in the input sequence $arg, that is, the sum
of the values divided by the number of values.
|
|
fn:base-uri
|
Returns the value of the base-uri property for the specified node.
|
|
fn:boolean
|
Computes the effective boolean value of the sequence $arg.
|
|
fn:ceiling
|
Returns the smallest (closest to negative infinity) number with no fractional
part that is not less than the value of $arg.
|
|
fn:codepoint-equal
|
Returns true if the specified parameters are the same Unicode
code point, otherwise returns false.
|
|
fn:codepoints-to-string
|
Creates an xs:string from a sequence of Unicode code points.
|
|
fn:collection
|
Returns all of the documents that belong to the specified collection(s).
|
|
fn:compare
|
Returns -1, 0, or 1, depending on whether the value of the $comparand1 is respectively less than, equal to, or greater than the value of $comparand2, according to the rules of the collation that is used.
|
|
fn:concat
|
Returns the xs:string that is the concatenation of the values
of the specified parameters.
|
|
fn:contains
|
Returns true if the first parameter contains the string
from the second parameter, otherwise returns false.
|
|
fn:count
|
Returns the number of items in the value of $arg.
|
|
fn:current-date
|
Returns xs:date(fn:current-dateTime()).
|
|
fn:current-dateTime
|
Returns the current dateTime value (with timezone) from the dynamic context.
|
|
fn:current-time
|
Returns xs:time(fn:current-dateTime()).
|
|
fn:data
|
Takes a sequence of items and returns a sequence of atomic values.
|
|
fn:day-from-date
|
Returns an xs:integer between 1 and 31, both inclusive, representing the day
component in the localized value of $arg.
|
|
fn:day-from-dateTime
|
Returns an xs:integer between 1 and 31, both inclusive, representing the day
component in the localized value of $arg.
|
|
fn:days-from-duration
|
Returns an xs:integer representing the days component in the canonical
lexical representation of the value of $arg.
|
|
fn:deep-equal
|
This function assesses whether two sequences are deep-equal to each other.
|
|
fn:default-collation
|
Returns the value of the default collation property from the static context.
|
|
fn:distinct-nodes
|
Returns the sequence resulting from removing from the input sequence all
but one of a set of nodes that have the same identity as one another.
|
|
fn:distinct-values
|
Returns the sequence that results from removing from $arg all but one of a set
of values that are eq to one other.
|
|
fn:doc
|
Returns the document(s) stored in the database at the specified URI(s).
|
|
fn:doc-available
|
If fn:doc($uri) returns a document node, this function returns true.
|
|
fn:document-uri
|
Returns the value of the document-uri property for the specified node.
|
|
fn:empty
|
If the value of $arg is the empty sequence, the function returns true;
otherwise, the function returns false.
|
|
fn:encode-for-uri
|
Invertible function that escapes characters required to be escaped
inside path segments of URIs.
|
|
fn:ends-with
|
Returns true if the first parameter ends with the string
from the second parameter, otherwise returns false.
|
|
fn:error
|
Throw the given error.
|
|
fn:escape-html-uri
|
%-escapes everything except printable ASCII characters.
|
|
fn:escape-uri
|
Returns a string representing the specified URI either with escaped reserved
characters ($escape-reserved=true) or with the reserved characters left as
specified ($escape-reserved=true).
|
|
fn:exactly-one
|
Returns $arg if it contains exactly one item.
|
|
fn:exists
|
If the value of $arg is not the empty sequence, the function returns true;
otherwise, the function returns false.
|
|
fn:false
|
Returns the xs:boolean value false.
|
|
fn:floor
|
Returns the largest (closest to positive infinity) number with no fractional
part that is not greater than the value of $arg.
|
|
fn:hours-from-dateTime
|
Returns an xs:integer between 0 and 23, both inclusive, representing the
hours component in the localized value of $arg.
|
|
fn:hours-from-duration
|
Returns an xs:integer representing the hours component in the canonical
lexical representation of the value of $arg.
|
|
fn:hours-from-time
|
Returns an xs:integer between 0 and 23, both inclusive, representing the
value of the hours component in the localized value of $arg.
|
|
fn:id
|
Returns the sequence of element nodes that have an ID value matching the value
of one or more of the IDREF values supplied in $arg.
|
|
fn:idref
|
Returns the sequence of element or attribute nodes that have an IDREF value
matching the value of one or more of the ID values supplied in $arg.
|
|
fn:implicit-timezone
|
Returns the value of the implicit timezone property from the dynamic context.
|
|
fn:in-scope-prefixes
|
Returns the prefixes of the in-scope namespaces for $element.
|
|
fn:index-of
|
Returns a sequence of positive integers giving the positions within the
sequence $seqParam of items that are equal to $srchParam.
|
|
fn:insert-before
|
Returns a new sequence constructed from the value of $target with the value of
$inserts inserted at the position specified by the value of $position.
|
|
fn:iri-to-uri
|
Idempotent function that escapes non-URI characters.
|
|
fn:lang
|
This function tests whether the language of $node, or the context node if the
second argument is omitted, as specified by xml:lang attributes is the same
as, or is a sublanguage of, the language specified by $testlang.
|
|
fn:last
|
Returns the context size from the dynamic context.
|
|
fn:local-name
|
Returns the local part of the name of $arg as an xs:string that
will either be the zero-length string or will have the lexical form of
an xs:NCName.
|
|
fn:local-name-from-QName
|
Returns an xs:NCName representing the local part of
$arg.
|
|
fn:lower-case
|
Returns the specified string converting all of the characters to lower-case
characters.
|
|
fn:matches
|
Returns true if the specified $input matches the specified
$pattern, otherwise returns false.
|
|
fn:max
|
Selects an item from the input sequence $arg whose value is greater than or
equal to the value of every other item in the input sequence.
|
|
fn:min
|
Selects an item from the input sequence $arg whose value is less than or
equal to the value of every other item in the input sequence.
|
|
fn:minutes-from-dateTime
|
Returns an xs:integer value between 0 and 59, both inclusive,
representing the minute component in the localized value of $arg.
|
|
fn:minutes-from-duration
|
Returns an xs:integer representing the minutes component in the canonical
lexical representation of the value of $arg.
|
|
fn:minutes-from-time
|
Returns an xs:integer value between 0 to 59, both inclusive, representing
the value of the minutes component in the localized value of $arg.
|
|
fn:month-from-date
|
Returns an xs:integer between 1 and 12, both inclusive, representing the
month component in the localized value of $arg.
|
|
fn:month-from-dateTime
|
Returns an xs:integer between 1 and 12, both inclusive, representing the
month component in the localized value of $arg.
|
|
fn:months-from-duration
|
Returns an xs:integer representing the months component in the
canonical lexical representation of the value of $arg.
|
|
fn:name
|
Returns the name of a node, as an xs:string that is either the
zero-length string, or has the lexical form of an xs:QName.
|
|
fn:namespace-uri
|
Returns the namespace URI of the xs:QName of $arg.
|
|
fn:namespace-uri-for-prefix
|
Returns the namespace URI of one of the in-scope namespaces for $element,
identified by its namespace prefix.
|
|
fn:namespace-uri-from-QName
|
Returns the namespace URI for $arg as an xs:string.
|
|
fn:node-kind
|
Returns an xs:string representing the node's kind: either
"document", "element", "attribute", "text", "namespace",
"processing-instruction", "binary", or "comment".
|
|
fn:node-name
|
Returns an expanded-QName for node kinds that can have names.
|
|
fn:normalize-space
|
Returns the specified string with normalized whitespace, which strips off
any leading or trailing whi |