AXIOM_TREE, baseURI, config, currentRoot, DOMINO_TREE, JDOM_TREE, JDOM2_TREE, lineNumbering, LINKED_TREE, namePool, open, pipe, STANDARD_TREE, started, systemId, timing, TINY_TREE, TINY_TREE_CONDENSED, UNSPECIFIED_TREE_MODEL
Constructor and Description |
---|
LinkedTreeBuilder(PipelineConfiguration pipe)
Create a Builder and initialise variables
|
Modifier and Type | Method and Description |
---|---|
void |
attribute(NodeName attName,
SimpleType typeCode,
java.lang.CharSequence value,
Location locationId,
int properties)
Notify an attribute.
|
void |
characters(java.lang.CharSequence chars,
Location locationId,
int properties)
Notify a text node.
|
void |
close()
Close the stream of Receiver events
|
void |
comment(java.lang.CharSequence chars,
Location locationId,
int properties)
Notify a comment
|
void |
endDocument()
Notify the end of the document
|
void |
endElement()
Notify the end of an element
|
BuilderMonitor |
getBuilderMonitor()
Get a builder monitor for this builder.
|
NodeImpl |
getCurrentLeafNode()
Get the current text, comment, or processing instruction node
|
net.sf.saxon.tree.linked.ParentNodeImpl |
getCurrentParentNode()
Get the current document or element node
|
NodeInfo |
getCurrentRoot()
Get the current root node.
|
void |
graftElement(ElementImpl element)
graftElement() allows an element node to be transferred from one tree to another.
|
void |
namespace(NamespaceBindingSet namespaceBindings,
int properties)
Notify one or more namespaces.
|
void |
open()
Open the stream of Receiver events
|
void |
processingInstruction(java.lang.String name,
java.lang.CharSequence remainder,
Location locationId,
int properties)
Notify a processing instruction
|
void |
reset()
Reset the builder to its initial state.
|
void |
setAllocateSequenceNumbers(boolean allocate)
Set whether the builder should allocate sequence numbers to elements as they are added to the
tree.
|
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(int properties)
Start of a document node.
|
void |
startElement(NodeName nodeName,
SchemaType type,
Location location,
int properties)
Notify the start of an element
|
getBaseURI, getConfiguration, getPipelineConfiguration, getSystemId, isTiming, setBaseURI, setLineNumbering, setPipelineConfiguration, setSystemId, setTiming, usesTypeAnnotations
public LinkedTreeBuilder(PipelineConfiguration pipe)
pipe
- the pipeline configurationpublic NodeInfo getCurrentRoot()
getCurrentRoot
in class Builder
public void reset()
Builder
public void setAllocateSequenceNumbers(boolean allocate)
allocate
- true if sequence numbers are to be allocatedpublic void setNodeFactory(NodeFactory factory)
factory
- the node factory to be used. This allows custom objects to be used to represent
the elements in the tree.public void open()
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 close() throws XPathException
close
in interface Receiver
close
in class Builder
XPathException
- if an error occurspublic void startElement(NodeName nodeName, SchemaType type, Location location, int properties) throws XPathException
nodeName
- the name of the element.type
- the type annotation of the element.location
- an object providing information about the module, line, and column where the node originatedproperties
- 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(NamespaceBindingSet namespaceBindings, int properties)
Receiver
namespaceBindings
- 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:public void attribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, Location locationId, int properties) throws XPathException
Receiver
attName
- The name of the attributetypeCode
- The type annotation of the attributevalue
- the string value of the attributelocationId
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void startContent() throws XPathException
Receiver
XPathException
- if an error occurspublic void endElement() throws XPathException
XPathException
- if an error occurspublic void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathException
chars
- The characterslocationId
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void processingInstruction(java.lang.String name, java.lang.CharSequence remainder, Location locationId, int properties)
name
- The PI name. This must be a legal name (it will not be checked).remainder
- The data portion of the processing instructionlocationId
- provides information such as line number and system ID.properties
- Additional information about the PI.public void comment(java.lang.CharSequence chars, Location locationId, int properties) throws XPathException
chars
- The content of the commentlocationId
- provides information such as line number and system ID.properties
- Additional information about the comment.XPathException
- if an error occurspublic net.sf.saxon.tree.linked.ParentNodeImpl getCurrentParentNode()
public NodeImpl getCurrentLeafNode()
public void graftElement(ElementImpl element)
element
- the element to be grafted in as a new child.public void setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)
name
- The name of the unparsed entityuri
- The system identifier of the unparsed entitypublicId
- The identifier of the unparsed entitypublic BuilderMonitor getBuilderMonitor()
getBuilderMonitor
in class Builder
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.