public class DOMWriter extends Builder
AXIOM_TREE, baseURI, config, currentRoot, DOMINO_TREE, JDOM_TREE, JDOM2_TREE, lineNumbering, LINKED_TREE, namePool, open, STANDARD_TREE, started, timing, TINY_TREE, TINY_TREE_CONDENSED, UNSPECIFIED_TREE_MODEL
Constructor and Description |
---|
DOMWriter() |
Modifier and Type | Method and Description |
---|---|
void |
attribute(NodeName nameCode,
SimpleType typeCode,
java.lang.CharSequence value,
Location locationId,
int properties)
Notify an attribute.
|
void |
characters(java.lang.CharSequence chars,
Location locationId,
int properties)
Character data.
|
void |
close()
End of the document.
|
void |
comment(java.lang.CharSequence chars,
Location locationId,
int properties)
Handle a comment.
|
void |
endDocument()
Notify the end of a document node
|
void |
endElement()
End of an element.
|
NodeInfo |
getCurrentRoot()
Get the current root node.
|
protected org.w3c.dom.Document |
getDOMDocumentNode()
Get the constructed DOM Document node
|
PipelineConfiguration |
getPipelineConfiguration()
Get the pipeline configuration used for this document
|
java.lang.String |
getSystemId()
Get the system identifier that was set with setSystemId.
|
void |
namespace(NamespaceBindingSet namespaceBindings,
int properties)
Notify one or more namespaces.
|
void |
open()
Start of the document.
|
void |
processingInstruction(java.lang.String target,
java.lang.CharSequence data,
Location locationId,
int properties)
Handle a processing instruction.
|
void |
setNextSibling(org.w3c.dom.Node nextSibling)
Set next sibling
|
void |
setNode(org.w3c.dom.Node node)
Set the attachment point for the new subtree
|
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipelineConfiguration
|
void |
setSystemId(java.lang.String systemId)
Set the System ID of the destination tree
|
void |
setUnparsedEntity(java.lang.String name,
java.lang.String systemID,
java.lang.String publicID)
Notify an unparsed entity URI.
|
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 nameCode,
SchemaType typeCode,
Location location,
int properties)
Start of an element.
|
boolean |
usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations
supplied on element and attribute events
|
getBaseURI, getBuilderMonitor, getConfiguration, isTiming, reset, setBaseURI, setLineNumbering, setTiming
public void setPipelineConfiguration(PipelineConfiguration pipe)
setPipelineConfiguration
in interface Receiver
setPipelineConfiguration
in class Builder
pipe
- the pipeline configurationpublic PipelineConfiguration getPipelineConfiguration()
getPipelineConfiguration
in interface Receiver
getPipelineConfiguration
in class Builder
public void setSystemId(java.lang.String systemId)
setSystemId
in interface javax.xml.transform.Result
setSystemId
in interface Receiver
setSystemId
in class Builder
systemId
- the SystemId, that is, the document-uri.public void setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathException
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entityXPathException
- if an error occurspublic java.lang.String getSystemId()
getSystemId
in interface javax.xml.transform.Result
getSystemId
in class Builder
public void open()
public void close()
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 startElement(NodeName nameCode, SchemaType typeCode, Location location, int properties) throws XPathException
nameCode
- the name of the element.typeCode
- 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) throws XPathException
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:XPathException
- if an error occurspublic void attribute(NodeName nameCode, SimpleType typeCode, java.lang.CharSequence value, Location locationId, int properties) throws XPathException
Receiver
nameCode
- 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 target, java.lang.CharSequence data, Location locationId, int properties) throws XPathException
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- provides information such as line number and system ID.properties
- Additional information about the PI.XPathException
- if an error occurspublic 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 boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
usesTypeAnnotations
in class Builder
public void setNode(org.w3c.dom.Node node)
node
- the node to which the new subtree will be attachedpublic void setNextSibling(org.w3c.dom.Node nextSibling)
nextSibling
- the node, which must be a child of the attachment point, before which the new subtree
will be created. If this is null the new subtree will be added after any existing children of the
attachment point.public NodeInfo getCurrentRoot()
getCurrentRoot
in class Builder
protected org.w3c.dom.Document getDOMDocumentNode()
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.