net.sf.saxon.event

Class TeeOutputter

public class TeeOutputter extends SequenceReceiver

TeeOutputter: a SequenceReceiver that duplicates received events to two different destinations
Field Summary
SequenceReceiverseq1
SequenceReceiverseq2
Constructor Summary
TeeOutputter(Receiver seq1, Receiver seq2)
Method Summary
voidappend(Item item, int locationId, int copyNamespaces)
Output an item (atomic value or node) to the sequence
voidattribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
Notify an attribute.
voidcharacters(CharSequence chars, int locationId, int properties)
Notify character data.
voidclose()
Notify the end of the event stream
voidcomment(CharSequence content, int locationId, int properties)
Notify a comment.
voidendDocument()
Notify the end of a document node
voidendElement()
Notify the end of an element.
voidnamespace(int namespaceCode, int properties)
Notify a namespace.
voidprocessingInstruction(String name, CharSequence data, int locationId, int properties)
Output a processing instruction
voidstartContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.
voidstartDocument(int properties)
Notify the start of a document node
voidstartElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start of an element

Field Detail

seq1

SequenceReceiver seq1

seq2

SequenceReceiver seq2

Constructor Detail

TeeOutputter

public TeeOutputter(Receiver seq1, Receiver seq2)

Method Detail

append

public void append(Item item, int locationId, int copyNamespaces)
Output an item (atomic value or node) to the sequence

attribute

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 locationId an integer which can be interpreted using a LocationMap 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: IllegalStateException: attempt to output an attribute when there is no open element start tag

characters

public void characters(CharSequence chars, int locationId, int properties)
Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.

Parameters: chars The characters locationId an integer which can be interpreted using a LocationMap 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
NO_SPECIAL_CHARACTERS
Value contains no special characters
WHITESPACE
Text is all whitespace

close

public void close()
Notify the end of the event stream

comment

public void comment(CharSequence content, int locationId, int properties)
Notify a comment. Comments are only notified if they are outside the DTD.

Parameters: content The content of the comment locationId an integer which can be interpreted using a LocationMap 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: IllegalArgumentException: the content is invalid for an XML comment

endDocument

public void endDocument()
Notify the end of a document node

endElement

public void endElement()
Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.

namespace

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

processingInstruction

public void processingInstruction(String name, CharSequence data, int locationId, int properties)
Output a processing instruction

Parameters: name 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 LocationMap 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: IllegalArgumentException: the content is invalid for an XML processing instruction

startContent

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.

startDocument

public void startDocument(int properties)
Notify the start of a document node

startElement

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. The value -1 indicates the default type, xdt:untyped. locationId an integer which can be interpreted using a LocationMap 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.