Package com.saxonica.functions.extfn

Class WithPedigree

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

com.saxonica.functions.extfn.WithPedigree

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

public class WithPedigree
extends SystemFunction

The saxon:with-pedigree function, new in Saxon 9.9.

The function is applied to a map or array, and it returns a map or array, with the same content, but with a different implementation such that all downward selections from the map/array to contained maps and arrays maintain information about the selection route, which can be used to get information about the containing maps and arrays in a JSON-like tree.

Constructor Summary

Constructors

Constructor	Description
WithPedigree()

Method Summary

Modifier and Type	Method	Description
Item	call(XPathContext context, Sequence[] arguments)	Invoke the function
static Function	makeRootWithPedigree(Item root)

Methods inherited from class net.sf.saxon.functions.SystemFunction

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, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.Function

getGenre

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, concatenate, containsNode, materialize

Methods inherited from interface net.sf.saxon.om.Item

getLength, head, isStreamed, itemAt, iterate, reduce, subsequence

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Constructor Detail

WithPedigree

public WithPedigree()

Method Detail

call

public Item call(XPathContext context,
                 Sequence[] arguments)
          throws XPathException

Description copied from interface: Function

Invoke the function

Parameters:

context - the XPath dynamic evaluation context

arguments - the actual arguments to be supplied

Returns:

the result of invoking the function

Throws:

XPathException - if a dynamic error occurs within the function

makeRootWithPedigree

public static Function makeRootWithPedigree(Item root)