net.sf.saxon.tinytree

Class TinyBuilder

Implemented Interfaces:
Receiver, Result

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 Summary

static int
PARENT_POINTER_INTERVAL

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

LINKED_TREE, STANDARD_TREE, TINY_TREE, UNSPECIFIED_TREE_MODEL, baseURI, config, currentRoot, lineNumbering, namePool, pipe, started, systemId, timing

Constructor Summary

TinyBuilder()
Create a TinyTree builder

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)
Callback interface for SAX: not for application use
void
close()
Notify the end of the event stream
void
comment(CharSequence chars, int locationId, int properties)
Callback interface for SAX: not for application use
void
endDocument()
Callback interface for SAX: not for application use
void
endElement()
Callback interface for SAX: not for application use
NodeInfo
getLastCompletedElement()
Get the last completed element node.
int[]
getSizeParameters()
Get the size parameters for the tree
TinyTree
getTree()
Get the tree being built by this builder
void
namespace(int namespaceCode, int properties)
Notify a namespace.
void
open()
Open the event stream
void
processingInstruction(String piname, CharSequence remainder, int locationId, int properties)
Callback interface for SAX: not for application use
void
setSizeParameters(int[] params)
Set the size parameters for the tree
void
setUnparsedEntity(String name, String uri, String publicId)
Set an unparsed entity in the document
void
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.
void
startDocument(int properties)
Write a document node to the tree
void
startElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start tag of an element

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

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

Field Details

PARENT_POINTER_INTERVAL

public static final int PARENT_POINTER_INTERVAL
Field Value:
10

Constructor Details

TinyBuilder

public TinyBuilder()
Create a TinyTree builder

Method Details

attribute

public void attribute(int nameCode,
                      int typeCode,
                      CharSequence value,
                      int locationId,
                      int properties)
            throws XPathException
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
Specified by:
attribute in interface Receiver
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:

characters

public void characters(CharSequence chars,
                       int locationId,
                       int properties)
            throws XPathException
Callback interface for SAX: not for application use
Specified by:
characters in interface Receiver

close

public void close()
            throws XPathException
Notify the end of the event stream
Specified by:
close in interface Receiver
Overrides:
close in interface Builder

comment

public void comment(CharSequence chars,
                    int locationId,
                    int properties)
            throws XPathException
Callback interface for SAX: not for application use
Specified by:
comment in interface Receiver

endDocument

public void endDocument()
            throws XPathException
Callback interface for SAX: not for application use
Specified by:
endDocument in interface Receiver
Overrides:
endDocument in interface Builder

endElement

public void endElement()
            throws XPathException
Callback interface for SAX: not for application use
Specified by:
endElement in interface Receiver

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

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

getTree

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

namespace

public void namespace(int namespaceCode,
                      int properties)
            throws XPathException
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.
Specified by:
namespace in interface Receiver
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.

open

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

processingInstruction

public void processingInstruction(String piname,
                                  CharSequence remainder,
                                  int locationId,
                                  int properties)
            throws XPathException
Callback interface for SAX: not for application use
Specified by:
processingInstruction in interface Receiver

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

setUnparsedEntity

public void setUnparsedEntity(String name,
                              String uri,
                              String publicId)
Set an unparsed entity in the document
Specified by:
setUnparsedEntity in interface Receiver

startContent

public void startContent()
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.
Specified by:
startContent in interface Receiver

startDocument

public void startDocument(int properties)
            throws XPathException
Write a document node to the tree
Specified by:
startDocument in interface Receiver
Overrides:
startDocument in interface Builder

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int locationId,
                         int properties)
            throws XPathException
Notify the start tag of an element
Specified by:
startElement in interface Receiver