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.

    • Constructor Detail

      • TinyBuilder

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

    • Method Detail

      • setStatistics

        public void setStatistics​(Statistics stats)
        Set the size parameters for the tree
        Parameters:
        stats - an object holding 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

      • 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 - properties of the document node
        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,
                         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

      • getAttValue

        protected java.lang.String getAttValue​(AttributeInfo att)

      • getLastCompletedElement

        public TinyNodeImpl getLastCompletedElement()
        Get the last completed element node. This is used during checking of schema assertions, which happens while the tree is still under construction. It is also used when copying accumulator values to the new tree from a streamed input. 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​(UnicodeString chars,
                       Location locationId,
                       int properties)
                throws XPathException
        Notify a text node
        Parameters:
        chars - The characters
        locationId - 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

      • makeTextNode

        protected int makeTextNode​(UnicodeString chars)
        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
        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,
                                  UnicodeString remainder,
                                  Location 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 - provides information such as line number and system ID.
        properties - Additional information about the PI.
        Throws:
        XPathException - if an error occurs

      • comment

        public void comment​(UnicodeString chars,
                    Location locationId,
                    int properties)
             throws XPathException
        Callback interface for SAX: not for application use
        Parameters:
        chars - The content of the comment
        locationId - provides information such as line number and system ID.
        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 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.