public class PedigreeFn extends SystemFunctionThe saxon:pedigree function, new in Saxon 9.9.
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.
Constructors Constructor Description
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
call(XPathContext context, Sequence arguments)Call the Callable.
Methods inherited from class net.sf.saxon.functions.SystemFunction
dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getContextNode, getDescription, getDetails, getElaborator, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, getUniStringArg, hashCode, importAttributes, isSequenceVariadic, isTrustedResultType, makeCall, makeFunction, makeFunction40, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller
Methods inherited from class net.sf.saxon.functions.AbstractFunction
atomize, deepEqual40, deepEquals, effectiveBooleanValue, getAnnotations, getUnicodeStringValue, isArray, isMap, makeNewContext, simplify, typeCheck
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
Methods inherited from interface net.sf.saxon.om.Item
getLength, getStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence
public Sequence call(XPathContext context, Sequence arguments) throws XPathExceptionDescription copied from interface:
CallableCall the Callable.
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 to a
GroundedValueby calling the utility method SequenceTool.toGroundedValue().
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.
- the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.
XPathException- if a dynamic error occurs during the evaluation of the expression