net.sf.saxon.tree
Class TreeBuilder

java.lang.Object
  |
  +--net.sf.saxon.event.Builder
        |
        +--net.sf.saxon.tree.TreeBuilder
All Implemented Interfaces:
Receiver, javax.xml.transform.Result

public class TreeBuilder
extends Builder

The Builder class is responsible for taking a stream of SAX events and constructing a Document tree.


Field Summary
 
Fields inherited from class net.sf.saxon.event.Builder
config, currentDocument, lineNumbering, locator, namePool, STANDARD_TREE, started, systemId, timing, TINY_TREE
 
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
 
Constructor Summary
TreeBuilder()
          create a Builder and initialise variables
 
Method Summary
 void attribute(int nameCode, int typeCode, java.lang.CharSequence value, int properties)
          Notify an attribute.
 void characters(java.lang.CharSequence chars, int properties)
          Notify a text node.
 void comment(java.lang.CharSequence chars, int properties)
          Notify a comment
 void endDocument()
          Callback interface for SAX: not for application use
 void endElement()
          Notify the end of an element
 void graftElement(ElementImpl element)
          graftElement() allows an element node to be transferred from one tree to another.
 void namespace(int namespaceCode, int properties)
          Notify a namespace.
 void processingInstruction(java.lang.String name, java.lang.CharSequence remainder, int properties)
          Notify a processing instruction
 void setDocumentLocator(org.xml.sax.Locator locator)
          Callback interface for SAX: not for application use
 void setNodeFactory(NodeFactory factory)
          Set the Node Factory to use.
 void setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)
          Set an unparsed entity URI for the document
 void startContent()
          Notify the start of the content, that is, the completion of all attributes and namespaces.
 void startDocument()
          Callback interface for SAX: not for application use
 void startElement(int nameCode, int typeCode, int properties)
          Notify the start of an element
 
Methods inherited from class net.sf.saxon.event.Builder
build, getConfiguration, getCurrentDocument, getSystemId, isTiming, setConfiguration, setLineNumbering, setRootNode, setSystemId, setTiming
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TreeBuilder

public TreeBuilder()
create a Builder and initialise variables

Method Detail

setNodeFactory

public void setNodeFactory(NodeFactory factory)
Set the Node Factory to use. If none is specified, the Builder uses its own.


startDocument

public void startDocument()
                   throws javax.xml.transform.TransformerException
Callback interface for SAX: not for application use

Specified by:
startDocument in interface Receiver
Overrides:
startDocument in class Builder
javax.xml.transform.TransformerException

endDocument

public void endDocument()
                 throws javax.xml.transform.TransformerException
Callback interface for SAX: not for application use

Specified by:
endDocument in interface Receiver
Overrides:
endDocument in class Builder
javax.xml.transform.TransformerException

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)
Callback interface for SAX: not for application use

Specified by:
setDocumentLocator in interface Receiver
Overrides:
setDocumentLocator in class Builder

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
                  throws javax.xml.transform.TransformerException
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.
javax.xml.transform.TransformerException

namespace

public void namespace(int namespaceCode,
                      int properties)
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; 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.

attribute

public void attribute(int nameCode,
                      int typeCode,
                      java.lang.CharSequence value,
                      int properties)
               throws javax.xml.transform.TransformerException
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:
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
javax.xml.transform.TransformerException

startContent

public void startContent()
                  throws javax.xml.transform.TransformerException
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.

javax.xml.transform.TransformerException

endElement

public void endElement()
                throws javax.xml.transform.TransformerException
Notify the end of an element

javax.xml.transform.TransformerException

characters

public void characters(java.lang.CharSequence chars,
                       int properties)
                throws javax.xml.transform.TransformerException
Notify a text node. Adjacent text nodes must have already been merged

Parameters:
chars - The characters
properties - Bit significant value. The following bits are defined:
DISABLE_ESCAPING
Disable escaping for this text node
USE_CDATA
Output as a CDATA section
NO_SPECIAL_CHARACTERS
Value contains no special characters
WHITESPACE
Text is all whitespace
javax.xml.transform.TransformerException

processingInstruction

public void processingInstruction(java.lang.String name,
                                  java.lang.CharSequence remainder,
                                  int properties)
Notify a processing instruction

Parameters:
name - The PI name. This must be a legal name (it will not be checked).
remainder - The data portion of the processing instruction
properties - Additional information about the PI. The following bits are defined:
CHECKED
Data is known to be legal (e.g. doesn't contain "?>")

comment

public void comment(java.lang.CharSequence chars,
                    int properties)
             throws javax.xml.transform.TransformerException
Notify a comment

Parameters:
chars - The content of the comment
properties - Additional information about the comment. The following bits are defined:
CHECKED
Comment is known to be legal (e.g. doesn't contain "--")
javax.xml.transform.TransformerException

graftElement

public void graftElement(ElementImpl element)
                  throws javax.xml.transform.TransformerException
graftElement() allows an element node to be transferred from one tree to another. This is a dangerous internal interface which is used only to contruct a stylesheet tree from a stylesheet using the "literal result element as stylesheet" syntax. The supplied element is grafted onto the current element as its only child.

javax.xml.transform.TransformerException

setUnparsedEntity

public void setUnparsedEntity(java.lang.String name,
                              java.lang.String uri,
                              java.lang.String publicId)
Set an unparsed entity URI for 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