net.sf.saxon.dotnet
Class DotNetDomBuilder

java.lang.Object
  net.sf.saxon.dotnet.DotNetDomBuilder

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class DotNetDomBuilder
extends java.lang.Object
implements Receiver

DotNetDomBuilder is a Receiver that constructs an XmlDocument, the .NET implementation of a DOM

Field Summary

protected XmlNode	currentNode
protected XmlDocument	document
protected NamePool	namePool
protected PipelineConfiguration	pipe
protected java.lang.String	systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

DotNetDomBuilder()

Method Summary

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 node
void	endElement() End of an element.
Configuration	getConfiguration() Get the configuration used for this document
XmlDocument	getDocumentNode() Get the constructed document
PipelineConfiguration	getPipelineConfiguration() Get the pipeline configuration used for this document
java.lang.String	getSystemId() Get the System ID
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	setAttachmentPoint(XmlNode attachmentPoint) Set the attachment point, an existing node to which the new data will be added as a subtree
void	setPipelineConfiguration(PipelineConfiguration pipe) Set the namePool in which all name codes can be found
void	setSystemId(java.lang.String systemId) Set the System ID
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(int nameCode, int typeCode, int locationId, int properties) Start of an element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pipe

protected PipelineConfiguration pipe

namePool

protected NamePool namePool

systemId

protected java.lang.String systemId

currentNode

protected XmlNode currentNode

document

protected XmlDocument document

Constructor Detail

DotNetDomBuilder

public DotNetDomBuilder()

Method Detail

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

Set the namePool in which all name codes can be found

Specified by:

setPipelineConfiguration in interface Receiver

Parameters:

pipe - the pipeline configuration

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()

Get the pipeline configuration used for this document

Specified by:

getPipelineConfiguration in interface Receiver

Returns:

the pipeline configuration

getConfiguration

public Configuration getConfiguration()

Get the configuration used for this document

Returns:

the Saxon Configuration object

setSystemId

public void setSystemId(java.lang.String systemId)

Set the System ID

Specified by:

setSystemId in interface javax.xml.transform.Result

Specified by:

setSystemId in interface Receiver

Parameters:

systemId - the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)

getSystemId

public java.lang.String getSystemId()

Get the System ID

Specified by:

getSystemId in interface javax.xml.transform.Result

open

public void open()

Start of the document.

Specified by:

open in interface Receiver

close

public void close()

End of the document.

Specified by:

close in interface Receiver

startDocument

public void startDocument(int properties)
                   throws XPathException

Start of a document node.

Specified by:

startDocument in interface Receiver

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions

Throws:

XPathException

endDocument

public void endDocument()
                 throws XPathException

Notify the end of a document node

Specified by:

endDocument in interface Receiver

Throws:

XPathException

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int locationId,
                         int properties)
                  throws XPathException

Start of an element.

Specified by:

startElement in interface Receiver

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 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

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 interface Receiver

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 interface Receiver

Parameters:

nameCode - The name of the attribute, as held in the name pool

typeCode - 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 attribute

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 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 interface Receiver

Throws:

XPathException

endElement

public void endElement()
                throws XPathException

End of an element.

Specified by:

endElement in interface Receiver

Throws:

XPathException

characters

public void characters(java.lang.CharSequence chars,
                       int locationId,
                       int properties)
                throws XPathException

Character data.

Specified by:

characters in interface Receiver

Parameters:

chars - The characters

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 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 interface Receiver

Parameters:

target - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

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 - 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 interface Receiver

Parameters:

chars - The content of the comment

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 - Additional information about the comment. The following bits are defined:

CHECKED

Comment is known to be legal (e.g. doesn't contain "--")

Throws:

XPathException

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 interface Receiver

Parameters:

name - The name of the unparsed entity

systemID - The system identifier of the unparsed entity

publicID - The public identifier of the unparsed entity

Throws:

XPathException

setAttachmentPoint

public void setAttachmentPoint(XmlNode attachmentPoint)

Set the attachment point, an existing node to which the new data will be added as a subtree

Parameters:

attachmentPoint - the document node, document fragment node, or element node to which the new data will be attached

getDocumentNode

public XmlDocument getDocumentNode()

Get the constructed document

Returns:

the document node of the DOM document