Receiver: This interface represents a recipient of XML tree-walking (push) events. It is
based on SAX2's ContentHandler, but adapted to handle additional events, and
to use Saxon's name pool. Namespaces and Attributes are handled by separate events
following the startElement event. Schema types can be defined for elements and attributes.
The Receiver interface is an important internal interface within Saxon, and provides a powerful
mechanism for integrating Saxon with other applications. It has been designed with extensibility
and stability in mind. However, it should be considered as an interface designed primarily for
internal use, and not as a completely stable part of the public Saxon API.
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.
nameCode
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name pool. The additional bit
NodeInfo.IS_DTD_TYPE may be set to indicate a DTD-derived type.value
- the string value of the attributelocationId
- an integer which can be interpreted using a LocationProvider
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:
characters
public void characters(CharSequence chars,
int locationId,
int properties)
throws XPathException
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.
chars
- The characterslocationId
- an integer which can be interpreted using a LocationProvider
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:
close
public void close()
throws XPathException
Notify the end of the event stream
comment
public void comment(CharSequence content,
int locationId,
int properties)
throws XPathException
Notify a comment. Comments are only notified if they are outside the DTD.
content
- The content of the commentlocationId
- an integer which can be interpreted using a LocationProvider
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:
endDocument
public void endDocument()
throws XPathException
Notify the end of a document node
endElement
public void endElement()
throws XPathException
Notify the end of an element. The receiver must maintain a stack if it needs to know which
element is ending.
getPipelineConfiguration
public PipelineConfiguration getPipelineConfiguration()
Get the pipeline configuration
- the pipeline configuration
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. The events represent namespace
declarations and undeclarations rather than in-scope namespace nodes: an undeclaration is represented
by a namespace code of zero. If the sequence of namespace events contains two
A namespace must not conflict with any namespaces already used for element or attribute names.
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.properties
- The most important property is REJECT_DUPLICATES. If this property is set, the
namespace declaration will be rejected if it conflicts with a previous declaration of the same
prefix. If the property is not set, the namespace declaration will be ignored if it conflicts
with a previous declaration. This reflects the fact that when copying a tree, namespaces for child
elements are emitted before the namespaces of their parent element. Unfortunately this conflicts
with the XSLT rule for complex content construction, where the recovery action in the event of
conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:
it sets the REJECT_DUPLICATES flag, and this is treated as a hard error.
open
public void open()
throws XPathException
Notify the start of the event stream
processingInstruction
public void processingInstruction(String name,
CharSequence data,
int locationId,
int properties)
throws XPathException
Output a processing instruction
name
- 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 LocationProvider
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:
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration config)
Set the pipeline configuration
config
- the pipeline configuration
setSystemId
public void setSystemId(String systemId)
Set the System ID of the tree represented by this event stream
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 systemID,
String publicID)
throws XPathException
Notify an unparsed entity URI.
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity
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.
startDocument
public void startDocument(int properties)
throws XPathException
Notify the start of a document node
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptions
startElement
public void startElement(int nameCode,
int typeCode,
int locationId,
int properties)
throws XPathException
Notify the start of an element
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, xs:untyped.locationId
- an integer which can be interpreted using a LocationProvider
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. The definitions of the bits are in class ReceiverOptions