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|
|Modifier and Type||Method and Description|
Call the Callable.
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, getUniStringArg, hashCode, importAttributes, isSequenceVariadic, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller
atomize, deepEquals, effectiveBooleanValue, getAnnotations, getUnicodeStringValue, isArray, isMap, makeNewContext, simplify, typeCheck
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getLength, getStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence
asIterable, concatenate, containsNode, materialize
public Sequence call(XPathContext context, Sequence arguments) throws XPathException
context- the dynamic evaluation context
arguments- the values of the arguments, supplied as Sequences.
Generally it is advisable, if calling iterate() to process a supplied sequence, to
call it only once; if the value is required more than once, it should first be converted
GroundedValue by calling the utility method
It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.
XPathException- if a dynamic error occurs during the evaluation of the expression
Copyright (c) 2004-2022 Saxonica Limited. All rights reserved.