public class PedigreeFn extends SystemFunction
The function is applied to a map or array that has a pedigree, typically because it was selected by downwards selection within a tree where pedigrees are maintained. It returns information about the pedigree of the map or array, that is, information about its position within the containing tree.
This information is returned in the form of a map that contains the following entries.
container - the containing map or array, or an empty sequence if the supplied map or array is the root of the pedigree tree
index - if the container is an array, this entry is an integer holding the 1-based index of the supplied map or array within the containing array
key - if the container is a map, this entry is an atomic value holding the key of the entry in this map that contains the supplied map or array.
| Constructor and Description |
|---|
PedigreeFn() |
| Modifier and Type | Method and Description |
|---|---|
ZeroOrOne<MapItem> |
call(XPathContext context,
Sequence[] arguments)
Invoke the function
|
dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCalleratomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheckclone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitargumentArray, getGenregetLength, head, isStreamed, itemAt, iterate, iterator, reduce, subsequence, toGroundedValueasIterable, materializemakeRepeatablepublic ZeroOrOne<MapItem> call(XPathContext context, Sequence[] arguments) throws XPathException
Functioncontext - the XPath dynamic evaluation contextarguments - the actual arguments to be suppliedXPathException - if a dynamic error occurs within the functionCopyright (c) 2004-2020 Saxonica Limited. All rights reserved.