| net.sf.saxon.event.Receiver
All known Subclasses: net.sf.saxon.event.Builder, net.sf.saxon.event.SequenceReceiver, net.sf.saxon.event.Sink, net.sf.saxon.event.Emitter,
| Receiver | | public interface Receiver extends Result(Code) | | 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.
author:
Michael H. Kay |
| Method Summary | |
| public void | attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
Notify an attribute. | | public void | characters(CharSequence chars, int locationId, int properties)
Notify character data. | | public void | close()
| | public void | comment(CharSequence content, int locationId, int properties)
Notify a comment. | | public void | endDocument()
| | public void | endElement()
Notify the end of an element. | | public PipelineConfiguration | getPipelineConfiguration()
| | public void | namespace(int namespaceCode, int properties)
Notify a namespace. | | public void | open()
| | public void | processingInstruction(String name, CharSequence data, int locationId, int properties)
Output a processing instruction
Parameters:
name - The PI name. | | public void | setPipelineConfiguration(PipelineConfiguration config)
| | public void | setSystemId(String systemId)
| | public void | setUnparsedEntity(String name, String systemID, String publicID)
Notify an unparsed entity URI. | | public void | startContent()
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. | | public void | startDocument(int properties)
| | public void | startElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start of an element
Parameters:
nameCode - integer code identifying the name of the element within the name pool.
Parameters:
typeCode - integer code identifying the element's type within the name pool. |
| attribute | | public void attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties) throws XPathException(Code) | | 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
Parameters:
typeCode - The type of the attribute, as held in the name pool. The additional bitNodeInfo.IS_DTD_TYPE may be set to indicate a DTD-derived type.
Parameters:
locationId - an integer which can be interpreted using a LocationMap to returninformation such as line number and system ID. If no location information is available,the value zero is supplied.
Parameters:
properties - Bit significant value. The following bits are defined:DISABLE_ESCAPING Disable escaping for this attributeNO_SPECIAL_CHARACTERS Attribute value contains no special characters
throws:
IllegalStateException - : attempt to output an attribute when there is no open elementstart tag |
| characters | | public void characters(CharSequence chars, int locationId, int properties) throws XPathException(Code) | | 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.
Parameters:
chars - The characters
Parameters:
locationId - an integer which can be interpreted using a LocationMap to returninformation such as line number and system ID. If no location information is available,the value zero is supplied.
Parameters:
properties - Bit significant value. The following bits are defined:DISABLE_ESCAPING Disable escaping for this text nodeUSE_CDATA Output as a CDATA sectionNO_SPECIAL_CHARACTERS Value contains no special charactersWHITESPACE Text is all whitespace |
| comment | | public void comment(CharSequence content, int locationId, int properties) throws XPathException(Code) | | Notify a comment. Comments are only notified if they are outside the DTD.
Parameters:
content - The content of the comment
Parameters:
locationId - an integer which can be interpreted using a LocationMap to returninformation such as line number and system ID. If no location information is available,the value zero is supplied.
Parameters:
properties - Additional information about the comment. The following bits aredefined:CHECKED Comment is known to be legal (e.g. doesn't contain "--")
throws:
IllegalArgumentException - : the content is invalid for an XML comment |
| endElement | | public void endElement() throws XPathException(Code) | | Notify the end of an element. The receiver must maintain a stack if it needs to know which
element is ending.
|
| namespace | | public void namespace(int namespaceCode, int properties) throws XPathException(Code) | | 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.
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 ofzero represents the empty prefix (that is, the default namespace). A URI code of zero representsa URI of "", that is, a namespace undeclaration.
Parameters:
properties - The most important property is REJECT_DUPLICATES. If this property is set, thenamespace declaration will be rejected if it conflicts with a previous declaration of the sameprefix. If the property is not set, the namespace declaration will be ignored if it conflictswith a previous declaration. This reflects the fact that when copying a tree, namespaces for childelements are emitted before the namespaces of their parent element. Unfortunately this conflictswith the XSLT rule for complex content construction, where the recovery action in the event ofconflicts 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. |
| processingInstruction | | public void processingInstruction(String name, CharSequence data, int locationId, int properties) throws XPathException(Code) | | Output a processing instruction
Parameters:
name - The PI name. This must be a legal name (it will not be checked).
Parameters:
data - The data portion of the processing instruction
Parameters:
locationId - an integer which can be interpreted using a LocationMap to returninformation such as line number and system ID. If no location information is available,the value zero is supplied.
Parameters:
properties - Additional information about the PI. The following bits aredefined:CHECKED Data is known to be legal (e.g. doesn't contain "?>")
throws:
IllegalArgumentException - : the content is invalid for an XML processing instruction |
| setSystemId | | public void setSystemId(String systemId)(Code) | | Set the System ID of the destination tree
|
| setUnparsedEntity | | public void setUnparsedEntity(String name, String systemID, String publicID) throws XPathException(Code) | | Notify an unparsed entity URI.
Parameters:
name - The name of the unparsed entity
Parameters:
systemID - The system identifier of the unparsed entity
Parameters:
publicID - The public identifier of the unparsed entity |
| startContent | | public void startContent() throws XPathException(Code) | | 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(Code) | | Notify the start of a document node
|
| startElement | | public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException(Code) | | Notify the start of an element
Parameters:
nameCode - integer code identifying the name of the element within the name pool.
Parameters:
typeCode - integer code identifying the element's type within the name pool. The value -1indicates the default type, xdt:untyped.
Parameters:
locationId - an integer which can be interpreted using a LocationMap to returninformation such as line number and system ID. If no location information is available,the value zero is supplied.
Parameters:
properties - bit-significant properties of the element node. If there are no revelantproperties, zero is supplied. |
|
|