Package net.sf.saxon.xom
Class XOMWriter
- java.lang.Object
-
- net.sf.saxon.xom.XOMWriter
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties)
Notify an attribute.void
characters(java.lang.CharSequence chars, int locationId, int properties)
Character data.void
close()
End of the document.void
comment(java.lang.CharSequence chars, int locationId, int properties)
Handle a comment.void
endDocument()
Notify the end of a document nodevoid
endElement()
End of an element.Document
getDocument()
Get the constructed document nodePipelineConfiguration
getPipelineConfiguration()
Get the pipeline configuration used for this documentjava.lang.String
getSystemId()
Get the system identifier that was set with setSystemId.void
namespace(int namespaceCode, int properties)
Notify a namespace.void
open()
Start of the document.void
processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
Handle a processing instruction.void
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipelineConfigurationvoid
setSystemId(java.lang.String systemId)
Set the System ID of the destination treevoid
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(int nameCode, int typeCode, int locationId, int properties)
Start of an element.
-
-
-
Method Detail
-
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipelineConfiguration- Specified by:
setPipelineConfiguration
in interfaceReceiver
- Parameters:
pipe
- the pipeline configuration
-
getPipelineConfiguration
public PipelineConfiguration getPipelineConfiguration()
Get the pipeline configuration used for this document- Specified by:
getPipelineConfiguration
in interfaceReceiver
- Returns:
- the pipeline configuration
-
setSystemId
public void setSystemId(java.lang.String systemId)
Set the System ID of the destination tree- Specified by:
setSystemId
in interfaceReceiver
- Specified by:
setSystemId
in interfacejavax.xml.transform.Result
- Parameters:
systemId
- the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)
-
setUnparsedEntity
public void setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathException
Notify an unparsed entity URI.- Specified by:
setUnparsedEntity
in interfaceReceiver
- Parameters:
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity- Throws:
XPathException
-
getSystemId
public java.lang.String getSystemId()
Get the system identifier that was set with setSystemId.- Specified by:
getSystemId
in interfacejavax.xml.transform.Result
- Returns:
- The system identifier that was set with setSystemId, or null if setSystemId was not called.
-
startDocument
public void startDocument(int properties) throws XPathException
Start of a document node.- Specified by:
startDocument
in interfaceReceiver
- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOptions
- Throws:
XPathException
-
endDocument
public void endDocument() throws XPathException
Notify the end of a document node- Specified by:
endDocument
in interfaceReceiver
- Throws:
XPathException
-
startElement
public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException
Start of an element.- Specified by:
startElement
in interfaceReceiver
- 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
public void namespace(int namespaceCode, int properties) throws XPathException
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.- Specified by:
namespace
in interfaceReceiver
- 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, java.lang.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.- Specified by:
attribute
in interfaceReceiver
- 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() throws XPathException
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.- Specified by:
startContent
in interfaceReceiver
- Throws:
XPathException
-
endElement
public void endElement() throws XPathException
End of an element.- Specified by:
endElement
in interfaceReceiver
- Throws:
XPathException
-
characters
public void characters(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
Character data.- Specified by:
characters
in interfaceReceiver
- 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(java.lang.String target, java.lang.CharSequence data, int locationId, int properties) throws XPathException
Handle a processing instruction.- Specified by:
processingInstruction
in interfaceReceiver
- Parameters:
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 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
public void comment(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
Handle a comment.- Specified by:
comment
in interfaceReceiver
- 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
-
getDocument
public Document getDocument()
Get the constructed document node- Returns:
- the document node of the constructed XOM tree
-
-