Package net.sf.saxon.event

Interface Receiver

    • Method Detail

      • setPipelineConfiguration

        void setPipelineConfiguration​(PipelineConfiguration pipe)
        Set the pipeline configuration
        Parameters:
        pipe - the pipeline configuration

      • getPipelineConfiguration

        PipelineConfiguration getPipelineConfiguration()
        Get the pipeline configuration
        Returns:
        the pipeline configuration

      • startDocument

        void startDocument​(int properties)
            throws XPathException
        Notify the start of a document node
        Parameters:
        properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption
        Throws:
        XPathException - if an error occurs

      • setUnparsedEntity

        void setUnparsedEntity​(java.lang.String name,
                       java.lang.String systemID,
                       java.lang.String publicID)
                throws XPathException
        Notify an unparsed entity URI.
        Parameters:
        name - The name of the unparsed entity
        systemID - The system identifier of the unparsed entity
        publicID - The identifier of the unparsed entity
        Throws:
        XPathException - if an error occurs

      • startElement

        void startElement​(NodeName elemName,
                  SchemaType type,
                  AttributeMap attributes,
                  NamespaceMap namespaces,
                  Location location,
                  int properties)
           throws XPathException
        Notify the start of an element
        Parameters:
        elemName - the name of the element.
        type - the type annotation of the element.
        attributes - the attributes of this element
        namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
        location - an object providing information about the module, line, and column where the node originated
        properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption
        Throws:
        XPathException - if an error occurs

      • endElement

        void endElement()
         throws XPathException
        Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.
        Throws:
        XPathException - if an error occurs

      • characters

        void characters​(UnicodeString chars,
                Location location,
                int properties)
         throws XPathException
        Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.
        Parameters:
        chars - The characters
        location - provides information such as line number and system ID.
        properties - Bit significant value. The following bits are defined:
        DISABLE_ESCAPING
        Disable escaping for this text node
        USE_CDATA
        Output as a CDATA section
        Throws:
        XPathException - if an error occurs

      • processingInstruction

        void processingInstruction​(java.lang.String name,
                           UnicodeString data,
                           Location location,
                           int properties)
                    throws XPathException
        Output a processing instruction
        Parameters:
        name - The PI name. This must be a legal name (it will not be checked).
        data - The data portion of the processing instruction
        location - provides information such as line number and system ID.
        properties - Additional information about the PI.
        Throws:
        java.lang.IllegalArgumentException - if the content is invalid for an XML processing instruction
        XPathException - if an error occurs

      • comment

        void comment​(UnicodeString content,
             Location location,
             int properties)
      throws XPathException
        Notify a comment. Comments are only notified if they are outside the DTD.
        Parameters:
        content - The content of the comment
        location - provides information such as line number and system ID.
        properties - Additional information about the comment.
        Throws:
        java.lang.IllegalArgumentException - if the content is invalid for an XML comment
        XPathException - if an error occurs

      • append

        default void append​(Item item,
                    Location locationId,
                    int properties)
             throws XPathException
        Append an arbitrary item (node, atomic value, or function) to the output. The default implementation throws UnsupportedOperationException.
        Parameters:
        item - the item to be appended
        locationId - the location of the calling instruction, for diagnostics
        properties - if the item is an element node, this indicates whether its namespaces need to be copied. Values are ReceiverOption.ALL_NAMESPACES; the default (0) means
        Throws:
        XPathException - if an error occurs
        java.lang.UnsupportedOperationException - if this Receiver does not allow appending of items (at any time, or at this particular point in the sequence of events)

      • append

        default void append​(Item item)
             throws XPathException
        Append an arbitrary item (node, atomic value, or function) to the output. By default, if the item is an element node, it is copied with all namespaces. The default implementation calls append(Item, Location, int), whose default implementation throws UnsupportedOperationException
        Parameters:
        item - the item to be appended
        Throws:
        XPathException - if the operation fails

      • usesTypeAnnotations

        default boolean usesTypeAnnotations()
        Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events. The default implementation of this method returns false.
        Returns:
        true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation (or conversely, it may avoid stripping unwanted type annotations)