|
|||||||||
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.option.xom.XOMWriter
public class XOMWriter
XOMWriter is a Receiver that constructs a XOM document from the stream of events
Field Summary |
---|
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 | |
---|---|
XOMWriter(PipelineConfiguration pipe)
Create a XOMWriter using the default node factory |
|
XOMWriter(PipelineConfiguration pipe,
NodeFactory factory)
Create a XOMWriter |
Method Summary | |
---|---|
void |
attribute(NodeName nameCode,
SimpleType typeCode,
CharSequence value,
int locationId,
int properties)
Notify an attribute. |
void |
characters(CharSequence chars,
int locationId,
int properties)
Character data. |
void |
close()
End of the document. |
void |
comment(CharSequence chars,
int 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. |
Document |
getDocument()
Get the constructed document node |
void |
namespace(NamespaceBinding namespaceBinding,
int properties)
Notify a namespace. |
void |
open()
Start of the document. |
void |
processingInstruction(String target,
CharSequence data,
int locationId,
int properties)
Handle a processing instruction. |
void |
setUnparsedEntity(String name,
String systemID,
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,
int locationId,
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 |
Methods inherited from class net.sf.saxon.event.Builder |
---|
getBaseURI, getBuilderMonitor, getConfiguration, getPipelineConfiguration, getSystemId, isTiming, reset, setBaseURI, setLineNumbering, setPipelineConfiguration, setSystemId, setTiming |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XOMWriter(PipelineConfiguration pipe)
pipe
- the pipeline configurationpublic XOMWriter(PipelineConfiguration pipe, NodeFactory factory)
pipe
- the pipeline configurationfactory
- the XOM NodeFactory to be usedMethod Detail |
---|
public void setUnparsedEntity(String name, String systemID, String publicID) throws XPathException
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity
XPathException
- if an error occurspublic void open()
open
in interface Receiver
open
in class Builder
public void close()
close
in interface Receiver
close
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 startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties) throws XPathException
nameCode
- the name of the element.typeCode
- 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 nameCode, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException
Receiver
nameCode
- 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() throws XPathException
Receiver
XPathException
- if an error occurspublic void endElement() throws XPathException
XPathException
- if an error occurspublic 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 occurspublic void processingInstruction(String target, CharSequence data, int 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
- 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 boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
usesTypeAnnotations
in class Builder
public Document getDocument()
public NodeInfo getCurrentRoot()
getCurrentRoot
in class Builder
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |