Package net.sf.saxon.tinytree
Class TinyBuilder
java.lang.Object
net.sf.saxon.event.Builder
net.sf.saxon.tinytree.TinyBuilder
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
FieldsFields inherited from class net.sf.saxon.event.Builder
baseURI, config, currentRoot, lineNumbering, LINKED_TREE, namePool, pipe, STANDARD_TREE, started, systemId, timing, TINY_TREE, UNSPECIFIED_TREE_MODEL
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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 usevoid
close()
Notify the end of the event streamvoid
comment
(CharSequence chars, int locationId, int properties) Callback interface for SAX: not for application usevoid
Callback interface for SAX: not for application usevoid
Callback interface for SAX: not for application useGet the last completed element node.int[]
Get the size parameters for the treegetTree()
Get the tree being built by this buildervoid
namespace
(int namespaceCode, int properties) Notify a namespace.void
open()
Open the event streamvoid
processingInstruction
(String piname, CharSequence remainder, int locationId, int properties) Callback interface for SAX: not for application usevoid
reset()
Reset the builder to its initial state.void
setSizeParameters
(int[] params) Set the size parameters for the treevoid
setUnparsedEntity
(String name, String uri, String publicId) Set an unparsed entity in the documentvoid
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 treevoid
startElement
(int nameCode, int typeCode, int locationId, int properties) Notify the start tag of an elementMethods inherited from class net.sf.saxon.event.Builder
build, build, getBaseURI, getConfiguration, getCurrentRoot, getPipelineConfiguration, getSystemId, isTiming, setBaseURI, setLineNumbering, setPipelineConfiguration, setSystemId, setTiming
-
Field Details
-
PARENT_POINTER_INTERVAL
public static final int PARENT_POINTER_INTERVAL- See Also:
-
-
Constructor Details
-
TinyBuilder
public TinyBuilder()Create a TinyTree builder
-
-
Method Details
-
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
-
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
Get the tree being built by this builder- Returns:
- the TinyTree
-
open
Open the event stream- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classBuilder
- Throws:
XPathException
-
startDocument
Write a document node to the tree- Specified by:
startDocument
in interfaceReceiver
- Overrides:
startDocument
in classBuilder
- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOptions
- Throws:
XPathException
-
endDocument
Callback interface for SAX: not for application use- Specified by:
endDocument
in interfaceReceiver
- Overrides:
endDocument
in classBuilder
- Throws:
XPathException
-
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. -
close
Description copied from interface:Receiver
Notify the end of the event stream- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classBuilder
- Throws:
XPathException
-
startElement
public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException Notify the start tag 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 aLocationProvider
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 classReceiverOptions
- Throws:
XPathException
-
namespace
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.- Throws:
XPathException
-
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 pooltypeCode
- 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 attributelocationId
- an integer which can be interpreted using aLocationProvider
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()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
Callback interface for SAX: not for application use- Throws:
XPathException
-
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
-
characters
Callback interface for SAX: not for application use- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using aLocationProvider
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 piname, CharSequence remainder, int 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 instructionlocationId
- an integer which can be interpreted using aLocationProvider
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 "?>")
- Throws:
XPathException
-
comment
Callback interface for SAX: not for application use- Parameters:
chars
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
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
-
setUnparsedEntity
Set an unparsed entity in the document- Parameters:
name
- The name of the unparsed entityuri
- The system identifier of the unparsed entitypublicId
- The public identifier of the unparsed entity
-