net.sf.saxon.event
public interface Receiver extends Result
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.
Method Summary | |
---|---|
void | attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
Notify an attribute. |
void | characters(CharSequence chars, int locationId, int properties)
Notify character data. |
void | close()
Notify the end of the event stream |
void | comment(CharSequence content, int locationId, int properties)
Notify a comment. |
void | endDocument()
Notify the end of a document node |
void | endElement()
Notify the end of an element. |
PipelineConfiguration | getPipelineConfiguration()
Get the pipeline configuration |
void | namespace(int namespaceCode, int properties)
Notify a namespace. |
void | open()
Notify the start of the event stream |
void | processingInstruction(String name, CharSequence data, int locationId, int properties)
Output a 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 systemID, String publicID)
Notify an unparsed entity URI. |
void | startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.
|
void | startDocument(int properties)
Notify the start of a document node |
void | startElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start of an element |
boolean | usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations
supplied on element and attribute events |
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. The additional bit
NodeInfo.IS_DTD_TYPE may be set to indicate a DTD-derived type. value the string value of the attribute 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 value. The following bits are defined:
Throws: IllegalStateException: attempt to output an attribute when there is no open element start tag
Parameters: chars The characters 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 value. The following bits are defined:
Parameters: content The content of the comment 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 Additional information about the comment. The following bits are
defined:
Throws: IllegalArgumentException: the content is invalid for an XML comment
Returns: the pipeline configuration
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. 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.
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 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:
Throws: IllegalArgumentException: the content is invalid for an XML processing instruction
Parameters: pipe the pipeline configuration
Parameters: systemId the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)
Parameters: name The name of the unparsed entity systemID The system identifier of the unparsed entity publicID The public identifier of the unparsed entity
Parameters: properties bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions
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, 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
Returns: true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation