|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--net.sf.saxon.event.SequenceReceiver | +--net.sf.saxon.event.TreeReceiver
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 |
public TreeReceiver(Receiver nextInChain)
Method Detail |
public void setSystemId(java.lang.String systemId)
Receiver
setSystemId
in interface Receiver
setSystemId
in class SequenceReceiver
public java.lang.String getSystemId()
getSystemId
in interface javax.xml.transform.Result
getSystemId
in class SequenceReceiver
public Receiver getUnderlyingReceiver()
public void setConfiguration(Configuration config)
public Configuration getConfiguration()
public void setDocumentLocator(LocationProvider locator)
setDocumentLocator
in interface Receiver
setDocumentLocator
in class SequenceReceiver
public void open() throws XPathException
open
in interface Receiver
open
in class SequenceReceiver
XPathException
public void close() throws XPathException
XPathException
public void startDocument(int properties) throws XPathException
XPathException
public void endDocument() throws XPathException
XPathException
public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException
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
public void namespace(int namespaceCode, int properties) throws XPathException
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.
IllegalStateException:
- attempt to output a namespace when there is no open element
start tag
XPathException
public void attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties) throws XPathException
nameCode
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poolproperties
- Bit significant value. The following bits are defined:
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.
IllegalStateException:
- attempt to output an attribute when there is no open element
start tag
XPathException
public void startContent() throws XPathException
XPathException
public void endElement() throws XPathException
XPathException
public void characters(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
chars
- The characterslocationId
- 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:
XPathException
public void processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties) throws XPathException
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- 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:
XPathException
public void comment(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
chars
- The content of the commentlocationId
- 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:
XPathException
public void setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId) throws XPathException
setUnparsedEntity
in interface Receiver
setUnparsedEntity
in class SequenceReceiver
name
- The name of the unparsed entityuri
- The system identifier of the unparsed entitypublicId
- The public identifier of the unparsed entity
XPathException
public void append(Item item, int locationId) throws XPathException
append
in class SequenceReceiver
XPathException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |