net.sf.saxon.dom
Class DOMEmitter

java.lang.Object
  net.sf.saxon.event.Emitter
      net.sf.saxon.dom.DOMEmitter

All Implemented Interfaces:

Result, Receiver

public class DOMEmitter
extends Emitter

DOMEmitter is an Emitter that attaches the result tree to a specified Node in a DOM Document

Field Summary

protected Node	currentNode
protected Document	document

Fields inherited from class net.sf.saxon.event.Emitter

characterSet, locator, namePool, outputProperties, outputStream, streamResult, systemId, writer

Constructor Summary

DOMEmitter()

Method Summary

void	attribute(int nameCode, int typeCode, CharSequence value, int properties) Notify an attribute.
void	characters(CharSequence chars, int properties) Character data.
void	comment(CharSequence chars, int properties) Handle a comment.
void	endDocument() End of the document.
void	endElement() End of an element.
void	namespace(int namespaceCode, int properties) Notify a namespace.
void	processingInstruction(String target, CharSequence data, int properties) Handle a processing instruction.
void	setNode(Node node) Set output destination
void	startContent() Notify the start of the content, that is, the completion of all attributes and namespaces.
void	startDocument() Start of the document.
void	startElement(int nameCode, int typeCode, int properties) Start of an element.

Methods inherited from class net.sf.saxon.event.Emitter

getNamePool, getOutputProperties, getOutputStream, getSystemId, getWriter, makeEmitter, makeWriter, setDocumentLocator, setNamePool, setOutputProperties, setOutputStream, setStreamResult, setSystemId, setUnparsedEntity, setWriter, usesWriter

Methods inherited from class java.lang.Object

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

Field Detail

currentNode

protected Node currentNode

document

protected Document document

Constructor Detail

DOMEmitter

public DOMEmitter()

Method Detail

startDocument

public void startDocument()

Start of the document.

endDocument

public void endDocument()

End of the document.

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
                  throws TransformerException

Start of an element.

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.

Throws:

TransformerException

namespace

public void namespace(int namespaceCode,
                      int properties)
               throws TransformerException

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; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.

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.

Throws:

TransformerException

attribute

public void attribute(int nameCode,
                      int typeCode,
                      CharSequence value,
                      int properties)
               throws TransformerException

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.

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

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:

TransformerException

startContent

public void startContent()
                  throws TransformerException

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.

Throws:

TransformerException

endElement

public void endElement()
                throws TransformerException

End of an element.

Throws:

TransformerException

characters

public void characters(CharSequence chars,
                       int properties)
                throws TransformerException

Character data.

Parameters:

chars - The characters

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

NO_SPECIAL_CHARACTERS

Value contains no special characters

WHITESPACE

Text is all whitespace

Throws:

TransformerException

processingInstruction

public void processingInstruction(String target,
                                  CharSequence data,
                                  int properties)
                           throws TransformerException

Handle a processing instruction.

Parameters:

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

data - The data portion of the processing instruction

properties - Additional information about the PI. The following bits are defined:

CHECKED

Data is known to be legal (e.g. doesn't contain "?>")

Throws:

TransformerException

comment

public void comment(CharSequence chars,
                    int properties)
             throws TransformerException

Handle a comment.

Parameters:

chars - The content of the comment

properties - Additional information about the comment. The following bits are defined:

CHECKED

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

Throws:

TransformerException

setNode

public void setNode(Node node)

Set output destination