Package net.sf.saxon.tree.tiny

Class TinyBuilder

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver
    Direct Known Subclasses:
    TinyBuilderCondensed
    public class TinyBuilder
extends Builder
    The TinyBuilder class is responsible for taking a stream of SAX events and constructing a Document tree, using the "TinyTree" implementation.
    Author:
    Michael H. Kay

    • Field Detail

      • PARENT_POINTER_INTERVAL

        public static final int PARENT_POINTER_INTERVAL
        See Also:
        Constant Field Values

    • Constructor Detail

      • TinyBuilder

        public TinyBuilder​(PipelineConfiguration pipe)
        Create a TinyTree builder
        Parameters:
        pipe - information about the pipeline leading up to this Builder

    • Method Detail

      • setSizeParameters

        public void setSizeParameters​(int[] params)
        Set the size parameters for the tree
        Parameters:
        params - an array of four integers giving the expected number of non-attribute nodes, the expected number of attributes, the expected number of namespace declarations, and the expected total length of character data

      • getSizeParameters

        public int[] getSizeParameters()
        Get the size parameters for the tree
        Returns:
        an array of four integers giving the actual number of non-attribute nodes, the actual number of attributes, the actual number of namespace declarations, and the actual total length of character data. Return null if and only if the current tree is null.

      • getTree

        public TinyTree getTree()
        Get the tree being built by this builder
        Returns:
        the TinyTree

      • getCurrentDepth

        public int getCurrentDepth()
        Get the current depth in the tree
        Returns:
        the current depth

      • open

        public void open()
        Open the event stream
        Specified by:
        open in interface Receiver
        Overrides:
        open in class Builder

      • startDocument

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

      • endDocument

        public void endDocument()
                 throws XPathException
        Callback interface for SAX: not for application use
        Throws:
        XPathException - if an error occurs

      • reset

        public void reset()
        Description copied from class: Builder
        Reset the builder to its initial state. The most important effect of calling this method (implemented in subclasses) is to release any links to the constructed document tree, allowing the memory occupied by the tree to released by the garbage collector even if the Builder is still in memory. This can happen because the Builder is referenced from a parser in the Configuration's parser pool.
        Overrides:
        reset in class Builder

      • startElement

        public void startElement​(NodeName elemName,
                         SchemaType type,
                         int locationId,
                         int properties)
                  throws XPathException
        Notify the start tag of an element
        Parameters:
        elemName - the name of the element.
        type - the type annotation of the element.
        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 properties of the element node. If there are no revelant properties, zero is supplied. The definitions of the bits are in class ReceiverOptions
        Throws:
        XPathException - if an error occurs

      • namespace

        public void namespace​(NamespaceBinding namespaceBinding,
                      int properties)
               throws XPathException
        Description copied from interface: Receiver
        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. The events represent namespace declarations and undeclarations rather than in-scope namespace nodes: an undeclaration is represented by a namespace code of zero. If the sequence of namespace events contains two A namespace must not conflict with any namespaces already used for element or attribute names.
        Parameters:
        namespaceBinding - contains the namespace prefix and namespace URI
        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:
        Throws:
        XPathException - if an error occurs

      • attribute

        public void attribute​(NodeName attName,
                      SimpleType typeCode,
                      java.lang.CharSequence value,
                      int locationId,
                      int properties)
               throws XPathException
        Description copied from interface: Receiver
        Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
        Parameters:
        attName - The name of the attribute
        typeCode - The type of the attribute, as held in the name pool. The additional bit NodeInfo.IS_DTD_TYPE may be set to indicate a DTD-derived type.
        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.
        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
        Throws:
        XPathException - if an error occurs

      • startContent

        public void startContent()
        Description copied from interface: Receiver
        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.

      • endElement

        public void endElement()
                throws XPathException
        Callback interface for SAX: not for application use
        Throws:
        XPathException - if an error occurs

      • getLastCompletedElement

        public NodeInfo getLastCompletedElement()
        Get the last completed element node. This is used during checking of schema assertions, which happens while the tree is still under construction. This method is called immediately after a call on endElement(), and it returns the element that has just ended.
        Returns:
        the last completed element node, that is, the element whose endElement event is the most recent endElement event to be reported, or null if there is no such element

      • characters

        public void characters​(java.lang.CharSequence chars,
                       int locationId,
                       int properties)
                throws XPathException
        Callback interface for SAX: not for application use
        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 - if an error occurs

      • makeTextNode

        protected int makeTextNode​(java.lang.CharSequence chars,
                           int len)
        Create a text node. Separate method so it can be overridden. If the current node on the tree is already a text node, the new text will be appended to it.
        Parameters:
        chars - the contents of the text node
        len - the length of the text node
        Returns:
        the node number of the created text node, or the text node to which this text has been appended.

      • processingInstruction

        public void processingInstruction​(java.lang.String piname,
                                  java.lang.CharSequence remainder,
                                  int locationId,
                                  int properties)
                           throws XPathException
        Callback interface for SAX: not for application use
        Parameters:
        piname - The PI name. This must be a legal name (it will not be checked).
        remainder - 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.
        Throws:
        XPathException - if an error occurs

      • comment

        public void comment​(java.lang.CharSequence chars,
                    int locationId,
                    int properties)
             throws XPathException
        Callback interface for SAX: not for application use
        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.
        Throws:
        XPathException - if an error occurs

      • setUnparsedEntity

        public void setUnparsedEntity​(java.lang.String name,
                              java.lang.String uri,
                              java.lang.String publicId)
        Set an unparsed entity in the document
        Parameters:
        name - The name of the unparsed entity
        uri - The system identifier of the unparsed entity
        publicId - The public identifier of the unparsed entity

      • getBuilderMonitor

        public BuilderMonitor getBuilderMonitor()
        Description copied from class: Builder
        Get a builder monitor for this builder. This must be called immediately after opening the builder, and all events to the builder must thenceforth be sent via the BuilderMonitor.
        Overrides:
        getBuilderMonitor in class Builder
        Returns:
        a new BuilderMonitor appropriate to this kind of Builder; or null if the Builder does not provide this service. The default implementation returns null.