net.sf.saxon.tree
Class TreeBuilder

java.lang.Object
  net.sf.saxon.event.Builder
      net.sf.saxon.tree.TreeBuilder

All Implemented Interfaces:

Result, Receiver

public class TreeBuilder
extends Builder

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

Author:

Michael H. Kay

Field Summary

Fields inherited from class net.sf.saxon.event.Builder

LINKED_TREE, STANDARD_TREE, TINY_TREE, UNSPECIFIED_TREE_MODEL

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, CharSequence value, int locationId, int properties) Notify an attribute.
void	characters(CharSequence chars, int locationId, int properties) Notify a text node.
void	close() Callback interface for SAX: not for application use
void	comment(CharSequence chars, int locationId, int properties) Notify a comment
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	open() Callback interface for SAX: not for application use
void	processingInstruction(String name, CharSequence remainder, int locationId, int properties) Notify a processing instruction
void	setNodeFactory(NodeFactory factory) Set the Node Factory to use.
void	setUnparsedEntity(String name, String uri, 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	startElement(int nameCode, int typeCode, int locationId, int properties) Notify the start of an element

Methods inherited from class net.sf.saxon.event.Builder

build, build, endDocument, getBaseURI, getConfiguration, getCurrentRoot, getPipelineConfiguration, getSystemId, isTiming, setBaseURI, setLineNumbering, setPipelineConfiguration, setSystemId, setTiming, startDocument

Methods inherited from class java.lang.Object

equals, 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.

Parameters:

factory - the node factory to be used. This allows custom objects to be used to represent the elements in the tree.

open

public void open()
          throws XPathException

Callback interface for SAX: not for application use

Specified by:

open in interface Receiver

Overrides:

open in class Builder

Throws:

XPathException

close

public void close()
           throws XPathException

Callback interface for SAX: not for application use

Specified by:

close in interface Receiver

Overrides:

close in class Builder

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. The value -1 indicates the default type, xs:untyped.

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

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. 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:

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.

attribute

public void attribute(int nameCode,
                      int typeCode,
                      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:

nameCode - The name of the attribute, as held in the name pool

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

startContent

public void startContent()
                  throws XPathException

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.

Throws:

XPathException

endElement

public void endElement()
                throws XPathException

Notify the end of an element

Throws:

XPathException

characters

public void characters(CharSequence chars,
                       int locationId,
                       int properties)
                throws XPathException

Notify a text node. Adjacent text nodes must have already been merged

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(String name,
                                  CharSequence remainder,
                                  int locationId,
                                  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

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 "?>")

comment

public void comment(CharSequence chars,
                    int locationId,
                    int properties)
             throws XPathException

Notify 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

graftElement

public void graftElement(ElementImpl element)
                  throws XPathException

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.

Parameters:

element - the element to be grafted in as a new child.

Throws:

XPathException

setUnparsedEntity

public void setUnparsedEntity(String name,
                              String uri,
                              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