net.sf.saxon.dotnet

Class DotNetDomBuilder

Implemented Interfaces:
Receiver, Result

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

Method Summary

void
attribute(int nameCode, int 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.
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
String
getSystemId()
Get the System ID
void
namespace(int namespaceCode, 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
setPipelineConfiguration(PipelineConfiguration pipe)
Set the namePool in which all name codes can be found
void
setSystemId(String systemId)
Set the System ID
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(int nameCode, int typeCode, int locationId, int properties)
Start of an element.

Field Details

currentNode

protected XmlNode currentNode

document

protected XmlDocument document

namePool

protected NamePool namePool

pipe

protected PipelineConfiguration pipe

systemId

protected String systemId

Method Details

attribute

public void attribute(int nameCode,
                      int typeCode,
                      CharSequence value,
                      int locationId,
                      int properties)
            throws XPathException
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:

characters

public void characters(CharSequence chars,
                       int locationId,
                       int properties)
            throws XPathException
Character data.
Specified by:
characters in interface Receiver

close

public void close()
End of the document.
Specified by:
close in interface Receiver

comment

public void comment(CharSequence chars,
                    int locationId,
                    int properties)
            throws XPathException
Handle a comment.
Specified by:
comment in interface Receiver

endDocument

public void endDocument()
            throws XPathException
Notify the end of a document node
Specified by:
endDocument in interface Receiver

endElement

public void endElement()
            throws XPathException
End of an element.
Specified by:
endElement in interface Receiver

getConfiguration

public Configuration getConfiguration()
Get the configuration used for this document
Returns:
the Saxon Configuration object

getDocumentNode

public XmlDocument getDocumentNode()
Get the constructed document
Returns:
the document node of the constructed document

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()
Get the pipeline configuration used for this document
Specified by:
getPipelineConfiguration in interface Receiver

getSystemId

public String getSystemId()
Get the System ID

namespace

public void namespace(int namespaceCode,
                      int properties)
            throws XPathException
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.

open

public void open()
Start of the document.
Specified by:
open in interface Receiver

processingInstruction

public void processingInstruction(String target,
                                  CharSequence data,
                                  int locationId,
                                  int properties)
            throws XPathException
Handle a processing instruction.
Specified by:
processingInstruction in interface Receiver

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)
Set the namePool in which all name codes can be found
Specified by:
setPipelineConfiguration in interface Receiver

setSystemId

public void setSystemId(String systemId)
Set the System ID
Specified by:
setSystemId in interface Receiver

setUnparsedEntity

public void setUnparsedEntity(String name,
                              String systemID,
                              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

startContent

public void startContent()
            throws XPathException
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

startDocument

public void startDocument(int properties)
            throws XPathException
Start of a document node.
Specified by:
startDocument in interface Receiver

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int locationId,
                         int properties)
            throws XPathException
Start of an element.
Specified by:
startElement in interface Receiver