Package net.sf.saxon.tree.tiny

Class TinyBuilder

java.lang.Object
net.sf.saxon.event.Builder
net.sf.saxon.tree.tiny.TinyBuilder
All Implemented Interfaces:
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 Details

    • PARENT_POINTER_INTERVAL

      public static final int PARENT_POINTER_INTERVAL
      See Also:

  • Constructor Details

    • TinyBuilder

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

  • Method Details

    • 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 - 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

    • close

      public void close() throws XPathException
      Description copied from interface: Receiver
      Notify the end of the event stream
      Specified by:
      close in interface Receiver
      Overrides:
      close in class Builder
      Throws:
      XPathException - if an error occurs

    • startElement

      public void startElement(NodeName elemName, SchemaType type, Location location, 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.
      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 revelant properties, zero is supplied. The definitions of the bits are in class ReceiverOptions
      Throws:
      XPathException - if an error occurs

    • namespace

      public void namespace(NamespaceBindingSet namespaceBindings, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify one or more namespaces. 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:
      namespaceBindings - 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 type, CharSequence value, Location 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
      type - The type annotation of the attribute
      value - the string value of the attribute
      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 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
      Notify the end of an element node
      Throws:
      XPathException - if an error occurs

    • 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(CharSequence 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(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(String piname, CharSequence 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(CharSequence 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(String name, String uri, 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.

    • isPositionedAtElement

      public boolean isPositionedAtElement()

    • bulkCopy

      public void bulkCopy(TinyElementImpl sourceNode, boolean copyNamespaces)
      Copy an element node and its subtree from another TinyTree instance
      Parameters:
      sourceNode - the element at the root of the subtree to be copied

    • graft

      public void graft(NodeInfo node, boolean copyNamespaces)
      Graft an element node and its subtree from another tree instance
      Parameters:
      node - the external node to be grafted