net.sf.saxon.event
Class TreeReceiver

java.lang.Object
  |
  +--net.sf.saxon.event.SequenceReceiver
        |
        +--net.sf.saxon.event.TreeReceiver
All Implemented Interfaces:
Receiver, javax.xml.transform.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.


Field Summary
 
Fields inherited from class net.sf.saxon.event.SequenceReceiver
locator, previousAtomic
 
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
 
Constructor Summary
TreeReceiver(Receiver nextInChain)
           
 
Method Summary
 void append(Item item, int locationId)
          Append an arbitrary item (node or atomic value) to the output
 void attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties)
          Notify an attribute.
 void characters(java.lang.CharSequence chars, int locationId, int properties)
          Character data
 void close()
          End of document
 void comment(java.lang.CharSequence chars, int locationId, int properties)
          Output a comment
 void endDocument()
          Notify the end of a document node
 void endElement()
          End of element
 Configuration getConfiguration()
          Get the configuration to be used (providing access to a NamePool)
 java.lang.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 document
 void processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
          Processing Instruction
 void setConfiguration(Configuration config)
          Set the configuration to be used (providing access to a NamePool)
 void setDocumentLocator(LocationProvider locator)
          Set the Document Locator
 void setSystemId(java.lang.String systemId)
          Set the System ID of the destination tree
 void setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.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
getDocumentLocator
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TreeReceiver

public TreeReceiver(Receiver nextInChain)
Method Detail

setSystemId

public void setSystemId(java.lang.String systemId)
Description copied from interface: Receiver
Set the System ID of the destination tree

Specified by:
setSystemId in interface Receiver
Overrides:
setSystemId in class SequenceReceiver

getSystemId

public java.lang.String getSystemId()
Specified by:
getSystemId in interface javax.xml.transform.Result
Overrides:
getSystemId in class SequenceReceiver

getUnderlyingReceiver

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


setConfiguration

public void setConfiguration(Configuration config)
Set the configuration to be used (providing access to a NamePool)


getConfiguration

public Configuration getConfiguration()
Get the configuration to be used (providing access to a NamePool)


setDocumentLocator

public void setDocumentLocator(LocationProvider locator)
Set the Document Locator

Specified by:
setDocumentLocator in interface Receiver
Overrides:
setDocumentLocator in class SequenceReceiver

open

public void open()
          throws XPathException
Start of document

Specified by:
open in interface Receiver
Overrides:
open in class SequenceReceiver
XPathException

close

public void close()
           throws XPathException
End of document

XPathException

startDocument

public void startDocument(int properties)
                   throws XPathException
Start of a document node.

XPathException

endDocument

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

XPathException

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int locationId,
                         int properties)
                  throws XPathException
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.
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.
XPathException

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.

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
XPathException

attribute

public void attribute(int nameCode,
                      int typeCode,
                      java.lang.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.

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
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.
Throws:
IllegalStateException: - attempt to output an attribute when there is no open element start tag
XPathException

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.

XPathException

endElement

public void endElement()
                throws XPathException
End of element

XPathException

characters

public void characters(java.lang.CharSequence chars,
                       int locationId,
                       int properties)
                throws XPathException
Character data

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
XPathException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.CharSequence data,
                                  int locationId,
                                  int properties)
                           throws XPathException
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
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 "?>")
XPathException

comment

public void comment(java.lang.CharSequence chars,
                    int locationId,
                    int properties)
             throws XPathException
Output a comment

Parameters:
chars - 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 "--")
XPathException

setUnparsedEntity

public void setUnparsedEntity(java.lang.String name,
                              java.lang.String uri,
                              java.lang.String publicId)
                       throws XPathException
Set the URI for an unparsed entity in the document.

Specified by:
setUnparsedEntity in interface Receiver
Overrides:
setUnparsedEntity in class SequenceReceiver
Parameters:
name - The name of the unparsed entity
uri - The system identifier of the unparsed entity
publicId - The public identifier of the unparsed entity
XPathException

append

public void append(Item item,
                   int locationId)
            throws XPathException
Append an arbitrary item (node or atomic value) to the output

Specified by:
append in class SequenceReceiver
XPathException