|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.event.Builder net.sf.saxon.tree.tiny.TinyBuilder
public class TinyBuilder
The TinyBuilder class is responsible for taking a stream of SAX events and constructing a Document tree, using the "TinyTree" implementation.
Field Summary | |
---|---|
static int |
PARENT_POINTER_INTERVAL
|
Fields inherited from class net.sf.saxon.event.Builder |
---|
baseURI, config, currentRoot, JDOM_TREE, JDOM2_TREE, lineNumbering, LINKED_TREE, namePool, open, pipe, STANDARD_TREE, started, systemId, timing, TINY_TREE, TINY_TREE_CONDENSED, UNSPECIFIED_TREE_MODEL |
Fields inherited from interface javax.xml.transform.Result |
---|
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
Constructor Summary | |
---|---|
TinyBuilder(PipelineConfiguration pipe)
Create a TinyTree builder |
Method Summary | |
---|---|
void |
attribute(NodeName attName,
SimpleType 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 |
BuilderMonitor |
getBuilderMonitor()
Get a builder monitor for this builder. |
int |
getCurrentDepth()
Get the current depth in the tree |
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 |
protected int |
makeTextNode(CharSequence chars,
int len)
Create a text node. |
void |
namespace(NamespaceBinding namespaceBinding,
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 |
reset()
Reset the builder to its initial state. |
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(NodeName elemName,
SchemaType type,
int locationId,
int properties)
Notify the start tag of an element |
Methods inherited from class net.sf.saxon.event.Builder |
---|
getBaseURI, getConfiguration, getCurrentRoot, getPipelineConfiguration, getSystemId, isTiming, setBaseURI, setLineNumbering, setPipelineConfiguration, setSystemId, setTiming, usesTypeAnnotations |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int PARENT_POINTER_INTERVAL
Constructor Detail |
---|
public TinyBuilder(PipelineConfiguration pipe)
pipe
- information about the pipeline leading up to this BuilderMethod Detail |
---|
public void setSizeParameters(int[] params)
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 datapublic int[] getSizeParameters()
public TinyTree getTree()
public int getCurrentDepth()
public void open()
open
in interface Receiver
open
in class Builder
public void startDocument(int properties) throws XPathException
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occurspublic void endDocument() throws XPathException
XPathException
- if an error occurspublic void reset()
Builder
reset
in class Builder
public void close() throws XPathException
Receiver
close
in interface Receiver
close
in class Builder
XPathException
- if an error occurspublic void startElement(NodeName elemName, SchemaType type, int locationId, int properties) throws XPathException
elemName
- the name of the element.type
- the type annotation of the element.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
XPathException
- if an error occurspublic void namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
Receiver
namespaceBinding
- contains the namespace prefix and namespace URIproperties
- 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:
XPathException
- if an error occurspublic void attribute(NodeName attName, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException
Receiver
attName
- The name of the attributetypeCode
- 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 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:
XPathException
- if an error occurspublic void startContent()
Receiver
public void endElement() throws XPathException
XPathException
- if an error occurspublic NodeInfo getLastCompletedElement()
public void characters(CharSequence chars, int locationId, int properties) throws XPathException
chars
- The characterslocationId
- 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:
XPathException
- if an error occursprotected int makeTextNode(CharSequence chars, int len)
chars
- the contents of the text nodelen
- the length of the text node
public void processingInstruction(String piname, CharSequence remainder, int locationId, int properties) throws XPathException
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 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.
XPathException
- if an error occurspublic void comment(CharSequence chars, int locationId, int properties) throws XPathException
chars
- The content of the commentlocationId
- 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.
XPathException
- if an error occurspublic void setUnparsedEntity(String name, String uri, String publicId)
name
- The name of the unparsed entityuri
- The system identifier of the unparsed entitypublicId
- The public identifier of the unparsed entitypublic BuilderMonitor getBuilderMonitor()
Builder
getBuilderMonitor
in class Builder
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |