Class TreeReceiver

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver

    public class TreeReceiver
    extends SequenceReceiver
    A TreeReceiver acts as a bridge between a SequenceReceiver, which can receive events for constructing any kind of sequence, and an ordinary Receiver, which only handles events relating to the building of trees. To do this, it has to process any items added to the sequence using the append() interface; all other events are passed through unchanged.

    If atomic items are appended to the sequence, then adjacent atomic items are turned in to a text node by converting them to strings and adding a single space as a separator.

    If a document node is appended to the sequence, then the document node is ignored and its children are appended to the sequence.

    If any other node is appended to the sequence, then it is pushed to the result as a sequence of Receiver events, which may involve walking recursively through the contents of a tree.

    • Constructor Summary

      Constructors 
      Constructor Description
      TreeReceiver​(Receiver nextInChain)
      Create a TreeReceiver
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void append​(Item item, int locationId, int copyNamespaces)
      Append an arbitrary item (node or atomic value) to the output
      void attribute​(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties)
      Notify an attribute.
      void characters​(java.lang.CharSequence chars, int locationId, int properties)
      Character data
      void close()
      End of event sequence
      void comment​(java.lang.CharSequence chars, int locationId, int properties)
      Output a comment
      void endDocument()
      Notify the end of a document node
      void endElement()
      End of element
      Receiver getUnderlyingReceiver()
      Get the underlying Receiver (that is, the next one in the pipeline)
      void namespace​(int namespaceCode, int properties)
      Notify a namespace.
      void open()
      Start of event sequence
      void processingInstruction​(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
      Processing Instruction
      void setPipelineConfiguration​(PipelineConfiguration pipe)
      Set the pipeline configuration
      void setSystemId​(java.lang.String systemId)
      Set the system ID
      void setUnparsedEntity​(java.lang.String name, java.lang.String uri, java.lang.String publicId)
      Set the URI for an unparsed entity in the document.
      void startContent()
      Notify the start of the content, that is, the completion of all attributes and namespaces.
      void startDocument​(int properties)
      Start of a document node.
      void startElement​(int nameCode, int typeCode, int locationId, int properties)
      Notify the start of an element
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TreeReceiver

        public TreeReceiver​(Receiver nextInChain)
        Create a TreeReceiver
        Parameters:
        nextInChain - the receiver to which events will be directed, after expanding append events into more primitive tree-based events
    • Method Detail

      • setSystemId

        public void setSystemId​(java.lang.String systemId)
        Description copied from class: SequenceReceiver
        Set the system ID
        Specified by:
        setSystemId in interface Receiver
        Specified by:
        setSystemId in interface javax.xml.transform.Result
        Overrides:
        setSystemId in class SequenceReceiver
        Parameters:
        systemId - the URI used to identify the tree being passed across this interface
      • getUnderlyingReceiver

        public Receiver getUnderlyingReceiver()
        Get the underlying Receiver (that is, the next one in the pipeline)
        Returns:
        the underlying Receiver
      • startDocument

        public void startDocument​(int properties)
                           throws XPathException
        Start of a document node.
        Parameters:
        properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions
        Throws:
        XPathException
      • startElement

        public void startElement​(int nameCode,
                                 int typeCode,
                                 int locationId,
                                 int properties)
                          throws XPathException
        Notify the start of an element
        Parameters:
        nameCode - integer code identifying the name of the element within the name pool.
        typeCode - integer code identifying the element's type within the name pool.
        properties - bit-significant properties of the element node
        locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        Throws:
        XPathException
      • namespace

        public void namespace​(int namespaceCode,
                              int properties)
                       throws XPathException
        Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.
        Parameters:
        namespaceCode - an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.
        properties - The most important property is REJECT_DUPLICATES. If this property is set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error: it sets the REJECT_DUPLICATES flag, and this is treated as a hard error.
        Throws:
        XPathException
      • attribute

        public void attribute​(int nameCode,
                              int typeCode,
                              java.lang.CharSequence value,
                              int locationId,
                              int properties)
                       throws XPathException
        Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
        Parameters:
        nameCode - The name of the attribute, as held in the name pool
        typeCode - The type of the attribute, as held in the name pool
        properties - Bit significant value. The following bits are defined:
        DISABLE_ESCAPING
        Disable escaping for this attribute
        NO_SPECIAL_CHARACTERS
        Attribute value contains no special characters
        value - the string value of the attribute
        locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        Throws:
        XPathException
      • startContent

        public void startContent()
                          throws XPathException
        Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.
        Throws:
        XPathException
      • characters

        public void characters​(java.lang.CharSequence chars,
                               int locationId,
                               int properties)
                        throws XPathException
        Character data
        Parameters:
        chars - The characters
        locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        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
      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                          java.lang.CharSequence data,
                                          int locationId,
                                          int properties)
                                   throws XPathException
        Processing Instruction
        Parameters:
        target - The PI name. This must be a legal name (it will not be checked).
        data - The data portion of the processing instruction
        locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        properties - Additional information about the PI. The following bits are defined:
        CHECKED
        Data is known to be legal (e.g. doesn't contain "?>")
        Throws:
        XPathException
      • comment

        public void comment​(java.lang.CharSequence chars,
                            int locationId,
                            int properties)
                     throws XPathException
        Output a comment
        Parameters:
        chars - The content of the comment
        locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
        properties - Additional information about the comment. The following bits are defined:
        CHECKED
        Comment is known to be legal (e.g. doesn't contain "--")
        Throws:
        XPathException
      • setUnparsedEntity

        public void setUnparsedEntity​(java.lang.String name,
                                      java.lang.String uri,
                                      java.lang.String publicId)
                               throws XPathException
        Set the URI for an unparsed entity in the document.
        Specified by:
        setUnparsedEntity in interface Receiver
        Overrides:
        setUnparsedEntity in class SequenceReceiver
        Parameters:
        name - The name of the unparsed entity
        uri - The system identifier of the unparsed entity
        publicId - The public identifier of the unparsed entity
        Throws:
        XPathException