|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Receiver
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.
Field Summary |
---|
Fields inherited from interface javax.xml.transform.Result |
---|
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
Method Summary | |
---|---|
void |
attribute(NodeName attName,
SimpleType 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(NamespaceBinding namespaceBinding,
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(NodeName elemName,
SchemaType 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 |
Methods inherited from interface javax.xml.transform.Result |
---|
getSystemId |
Method Detail |
---|
void setPipelineConfiguration(PipelineConfiguration pipe)
pipe
- the pipeline configurationPipelineConfiguration getPipelineConfiguration()
void setSystemId(String systemId)
setSystemId
in interface Result
systemId
- the system ID (which is used as the base URI of the nodes
if there is no xml:base attribute)void open() throws XPathException
XPathException
- if an error occursvoid startDocument(int properties) throws XPathException
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occursvoid endDocument() throws XPathException
XPathException
- if an error occursvoid setUnparsedEntity(String name, String systemID, String publicID) throws XPathException
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity
XPathException
- if an error occursvoid startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties) throws XPathException
elemName
- the name of the element.typeCode
- the type annotation of the element.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
XPathException
- if an error occursvoid namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
namespaceBinding
- contains the namespace prefix and namespace URIproperties
- 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:
XPathException
- if an error occursvoid attribute(NodeName attName, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException
attName
- The name of the attributetypeCode
- 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:
IllegalStateException:
- attempt to output an attribute when there is no open element
start tag
XPathException
- if an error occursvoid startContent() throws XPathException
XPathException
- if an error occursvoid endElement() throws XPathException
XPathException
- if an error occursvoid characters(CharSequence chars, int locationId, int properties) throws XPathException
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:
XPathException
- if an error occursvoid processingInstruction(String name, CharSequence data, int locationId, int properties) throws XPathException
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.
IllegalArgumentException:
- the content is invalid for an XML processing instruction
XPathException
- if an error occursvoid comment(CharSequence content, int locationId, int properties) throws XPathException
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.
IllegalArgumentException:
- the content is invalid for an XML comment
XPathException
- if an error occursvoid close() throws XPathException
XPathException
- if an error occursboolean usesTypeAnnotations()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |