Package net.sf.saxon.event
Interface Receiver
- All Superinterfaces:
Result
- All Known Implementing Classes:
BinaryTextDecoder
,Builder
,BuilderMonitor
,CDATAFilter
,CharacterMapExpander
,CommentStripper
,ComplexContentOutputter
,ContentHandlerProxy
,DOM4JWriter
,DOMWriter
,Emitter
,HTMLEmitter
,HTMLIndenter
,HTMLURIEscaper
,IDFilter
,ImplicitResultChecker
,JDOMWriter
,LinkedBuilderMonitor
,LinkedTreeBuilder
,MessageEmitter
,MessageListenerProxy
,MessageWarner
,MetaTagAdjuster
,NamePoolConverter
,NamespaceReducer
,PathMaintainer
,PIGrabber
,ProxyReceiver
,SequenceOutputter
,SequenceReceiver
,SequenceWrapper
,SequenceWriter
,Sink
,StartTagBuffer
,Stripper
,TeeOutputter
,TEXTEmitter
,TinyBuilder
,TinyBuilderCondensed
,TinyBuilderMonitor
,TracingFilter
,TransformerReceiver
,TreeReceiver
,TypeCheckingFilter
,UncommittedSerializer
,UnicodeNormalizer
,UseWhenFilter
,XHTMLEmitter
,XHTMLURIEscaper
,XML10ContentChecker
,XMLEmitter
,XMLIndenter
,XOMWriter
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
-
Field Summary
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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 streamvoid
comment
(CharSequence content, int locationId, int properties) Notify a comment.void
Notify the end of a document nodevoid
Notify the end of an element.Get the pipeline configurationvoid
namespace
(NamespaceBinding namespaceBinding, int properties) Notify a namespace.void
open()
Notify the start of the event streamvoid
processingInstruction
(String name, CharSequence data, int locationId, int properties) Output a processing instructionvoid
Set the pipeline configurationvoid
setSystemId
(String systemId) Set the System ID of the tree represented by this event streamvoid
setUnparsedEntity
(String name, String systemID, String publicID) Notify an unparsed entity URI.void
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 nodevoid
startElement
(NodeName elemName, SchemaType typeCode, int locationId, int properties) Notify the start of an elementboolean
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute eventsMethods inherited from interface javax.xml.transform.Result
getSystemId
-
Method Details
-
setPipelineConfiguration
Set the pipeline configuration- Parameters:
pipe
- the pipeline configuration
-
getPipelineConfiguration
PipelineConfiguration getPipelineConfiguration()Get the pipeline configuration- Returns:
- the pipeline configuration
-
setSystemId
Set the System ID of the tree represented by this event stream- Specified by:
setSystemId
in interfaceResult
- Parameters:
systemId
- the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)
-
open
Notify the start of the event stream- Throws:
XPathException
- if an error occurs
-
startDocument
Notify the start of a document node- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOptions
- Throws:
XPathException
- if an error occurs
-
endDocument
Notify the end of a document node- Throws:
XPathException
- if an error occurs
-
setUnparsedEntity
Notify an unparsed entity URI.- Parameters:
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity- Throws:
XPathException
- if an error occurs
-
startElement
void startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties) throws XPathException Notify the start of an element- Parameters:
elemName
- the name of the element.typeCode
- the type annotation of the element.locationId
- an integer which can be interpreted using aLocationProvider
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 classReceiverOptions
- Throws:
XPathException
- if an error occurs
-
namespace
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:
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:- Throws:
XPathException
- if an error occurs
-
attribute
void attribute(NodeName attName, SimpleType 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.- Parameters:
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 aLocationProvider
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:- DISABLE_ESCAPING
- Disable escaping for this attribute
- NO_SPECIAL_CHARACTERS
- Attribute value contains no special characters
- Throws:
XPathException
- if an error occurs
-
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. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.- Throws:
XPathException
- if an error occurs
-
endElement
Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.- Throws:
XPathException
- if an error occurs
-
characters
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 characterslocationId
- an integer which can be interpreted using aLocationProvider
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:- DISABLE_ESCAPING
- Disable escaping for this text node
- USE_CDATA
- Output as a CDATA section
- Throws:
XPathException
- if an error occurs
-
processingInstruction
void processingInstruction(String name, CharSequence data, int locationId, int properties) throws XPathException Output a processing instruction- Parameters:
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 aLocationProvider
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.- Throws:
XPathException
- if an error occurs
-
comment
Notify a comment. Comments are only notified if they are outside the DTD.- Parameters:
content
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
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.- Throws:
XPathException
- if an error occurs
-
close
Notify the end of the event stream- Throws:
XPathException
- if an error occurs
-
usesTypeAnnotations
boolean usesTypeAnnotations()Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events- 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 (or conversely, it may avoid stripping unwanted type annotations)
-