Class 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 Detail

      • WithPedigree

        public WithPedigree()
    • Method Detail

      • call

        public Item call​(XPathContext context,
                         Sequence[] arguments)
                  throws XPathException
        Description copied from interface: Callable
        Call 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 GroundedValue by calling the utility method SequenceTool.toGroundedValue().

        If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

        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
      • makeRootWithPedigree

        public static Function makeRootWithPedigree​(Item root)