Class SnapshotFn

    • Constructor Detail

      • SnapshotFn

        public SnapshotFn()
    • Method Detail

      • getCardinality

        public int getCardinality​(Expression[] arguments)
        Description copied from class: SystemFunction
        Get the cardinality, given knowledge of the actual arguments
        Overrides:
        getCardinality in class SystemFunction
        Parameters:
        arguments - the actual arguments supplied
        Returns:
        the most precise available cardinality that the function will return
      • call

        public Sequence call​(XPathContext context,
                             Sequence[] arguments)
                      throws XPathException
        Evaluate the expression
        Parameters:
        context - the dynamic evaluation context
        arguments - the values of the arguments, supplied as Sequences
        Returns:
        the result of the evaluation, in the form of a Sequence
        Throws:
        XPathException - if a dynamic error occurs during the evaluation of the expression
      • getMappingFunction

        public static ItemMappingFunction getMappingFunction()
        Get a mapping function that can be used to take a snapshot of every item in a sequence
        Returns:
        a suitable mapping function
      • snapshotSingle

        public static Item snapshotSingle​(Item origin)
        Take a snapshot of a single item
        Parameters:
        origin - the item in question
        Returns:
        the snapshot
      • makeAncestorList

        public static java.util.List<NodeInfo> makeAncestorList​(NodeInfo origin)
      • getStreamerName

        public java.lang.String getStreamerName()
        Description copied from class: SystemFunction
        Get a name that identifies the class that can be used to evaluate this function in streaming mode, that is, supplying one item or event at a time as it is delivered by the parser. Special streaming support is generally available in Saxon-EE for all system functions that take a sequence as their argument.
        Overrides:
        getStreamerName in class SystemFunction
        Returns:
        a name that identifies a class that supports streamed evaluation of this system function, or null if no such class is available. The mapping of names to classes is defined in the Saxon-EE class StreamerMap. In non-streaming Saxon editions (HE and PE) the method always returns null.