net.sf.saxon.event
Class TreeReceiver
public
class
TreeReceiver
extends SequenceReceiver
A TreeReceiver acts as a bridge between a SequenceReceiver, which can receive
events for constructing any kind of sequence, and an ordinary Receiver, which
only handles events relating to the building of trees. To do this, it has to
process any items added to the sequence using the append() interface; all other
events are passed through unchanged.
Method Summary |
void | append(Item item, int locationId, int copyNamespaces)
Append an arbitrary item (node or atomic value) to the output |
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 event sequence |
void | comment(CharSequence chars, int locationId, int properties)
Output a comment |
void | endDocument()
Notify the end of a document node |
void | endElement()
End of element |
String | getSystemId() |
Receiver | getUnderlyingReceiver()
Get the underlying Receiver (that is, the next one in the pipeline) |
void | namespace(int namespaceCode, int properties)
Notify a namespace. |
void | open()
Start of event sequence |
void | processingInstruction(String target, CharSequence data, int locationId, int properties)
Processing Instruction |
void | setSystemId(String systemId) |
void | setUnparsedEntity(String name, String uri, String publicId)
Set the URI for an unparsed entity in the document. |
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)
Notify the start of an element |
public TreeReceiver(
Receiver nextInChain)
public void append(
Item item, int locationId, int copyNamespaces)
Append an arbitrary item (node or atomic value) to the output
public void attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
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: IllegalStateException: attempt to output an attribute when there is no open element
start tag
public void characters(CharSequence chars, int locationId, int properties)
Character data
public void close()
End of event sequence
public void comment(CharSequence chars, int locationId, int properties)
Output a comment
public void endDocument()
Notify the end of a document node
public void endElement()
End of element
public String getSystemId()
Get the underlying Receiver (that is, the next one in the pipeline)
public void namespace(int namespaceCode, int properties)
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: IllegalStateException: attempt to output a namespace when there is no open element
start tag
public void open()
Start of event sequence
public void processingInstruction(String target, CharSequence data, int locationId, int properties)
Processing Instruction
public void setSystemId(String systemId)
public void setUnparsedEntity(String name, String uri, String publicId)
Set the URI for an unparsed entity in the document.
public void startContent()
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.
public void startDocument(int properties)
Start of a document node.
public void startElement(int nameCode, int typeCode, int locationId, int properties)
Notify the 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. properties bit-significant properties of the element node