net.sf.saxon.event

Class TreeReceiver

Implemented Interfaces:
Receiver, Result

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.

If atomic items are appended to the sequence, then adjacent atomic items are turned in to a text node by converting them to strings and adding a single space as a separator.

If a document node is appended to the sequence, then the document node is ignored and its children are appended to the sequence.

If any other node is appended to the sequence, then it is pushed to the result as a sequence of Receiver events, which may involve walking recursively through the contents of a tree.

Field Summary

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

pipelineConfiguration, previousAtomic, systemId

Constructor Summary

TreeReceiver(Receiver nextInChain)
Create a TreeReceiver

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
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
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration
void
setSystemId(String systemId)
Set the System ID of the tree represented by this event stream
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

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

append, getConfiguration, getNamePool, getPipelineConfiguration, getSystemId, open, setPipelineConfiguration, setSystemId, setUnparsedEntity

Constructor Details

TreeReceiver

public TreeReceiver(Receiver nextInChain)
Create a TreeReceiver
Parameters:
nextInChain - the receiver to which events will be directed, after expanding append events into more primitive tree-based events

Method Details

append

public void append(Item item,
                   int locationId,
                   int copyNamespaces)
            throws XPathException
Append an arbitrary item (node or atomic value) to the output
Overrides:
append in interface SequenceReceiver

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
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()
            throws XPathException
End of event sequence
Specified by:
close in interface Receiver

comment

public void comment(CharSequence chars,
                    int locationId,
                    int properties)
            throws XPathException
Output 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 element
Specified by:
endElement in interface Receiver

getUnderlyingReceiver

public Receiver getUnderlyingReceiver()
Get the underlying Receiver (that is, the next one in the pipeline)
Returns:
the underlying Receiver

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; however, duplicates may be reported. 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.

open

public void open()
            throws XPathException
Start of event sequence
Specified by:
open in interface Receiver
Overrides:
open in interface SequenceReceiver

processingInstruction

public void processingInstruction(String target,
                                  CharSequence data,
                                  int locationId,
                                  int properties)
            throws XPathException
Processing Instruction
Specified by:
processingInstruction in interface Receiver

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration
Specified by:
setPipelineConfiguration in interface Receiver
Overrides:
setPipelineConfiguration in interface SequenceReceiver
Parameters:

setSystemId

public void setSystemId(String systemId)
Set the System ID of the tree represented by this event stream
Specified by:
setSystemId in interface Receiver
Overrides:
setSystemId in interface SequenceReceiver
Parameters:
systemId - the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)

setUnparsedEntity

public void setUnparsedEntity(String name,
                              String uri,
                              String publicId)
            throws XPathException
Set the URI for an unparsed entity in the document.
Specified by:
setUnparsedEntity in interface Receiver
Overrides:
setUnparsedEntity in interface SequenceReceiver

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
Notify the 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.
properties - bit-significant properties of the element node