Package net.sf.saxon.event

Interface Receiver

All Superinterfaces:

Result

All Known Subinterfaces:

ReceiverWithOutputProperties

All Known Implementing Classes:

AdaptiveEmitter, BinaryTextDecoder, Builder, BuilderMonitor, CDATAFilter, CharacterMapExpander, CheckSumFilter, CloseNotifier, CommentStripper, ComplexContentOutputter, ContentHandlerProxy, CountingFilter, DocumentValidator, DOM4JWriter, DOMWriter, Emitter, EventBuffer, EventMonitor, HTML40Emitter, HTML50Emitter, HTMLEmitter, HTMLIndenter, HTMLURIEscaper, IDFilter, IgnorableWhitespaceStripper, JDOM2Writer, JDOMWriter, JsonReceiver, JSONSerializer, LinkedBuilderMonitor, LinkedTreeBuilder, MessageEmitter, MessageListener2Proxy, MessageListenerProxy, MessageWarner, MetaTagAdjuster, NamePoolConverter, NamespaceReducer, PackageInspector, PathMaintainer, PIGrabber, PrincipalOutputGatekeeper, ProxyReceiver, ReceiverToXMLStreamWriter, RegularSequenceChecker, SequenceNormalizer, SequenceNormalizerWithItemSeparator, SequenceNormalizerWithSpaceSeparator, SequenceOutputter, SequenceReceiver, SequenceWrapper, SequenceWriter, SignificantItemDetector, Sink, StartTagBuffer, Stripper, TeeOutputter, TEXTEmitter, TinyBuilder, TinyBuilderCondensed, TinyBuilderMonitor, TracingFilter, TransformerReceiver, TreeReceiver, TypeCheckingFilter, UncommittedSerializer, UnicodeNormalizer, UseWhenFilter, Valve, XHTML1Emitter, XHTML5Emitter, XHTMLPrefixRemover, XHTMLURIEscaper, XML10ContentChecker, XMLEmitter, XMLIndenter, XOMWriter

public interface Receiver
extends Result

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. 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.

Since:

8.0. Extended in 9.9 to support additional methods with default implementations.

Field Summary

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Method Summary

Modifier and Type	Method	Description
default void	append(Item item)	Append an arbitrary item (node, atomic value, or function) to the output.
default void	append(Item item, Location locationId, int properties)	Append an arbitrary item (node, atomic value, or function) to the output.
void	attribute(NodeName attName, SimpleType typeCode, CharSequence value, Location location, int properties)	Notify an attribute.
void	characters(CharSequence chars, Location location, int properties)	Notify character data.
void	close()	Notify the end of the event stream
void	comment(CharSequence content, Location location, 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
default boolean	handlesAppend()	Ask whether this Receiver can handle arbitrary items in its append(net.sf.saxon.om.Item, net.sf.saxon.expr.parser.Location, int) and append(Item, Location, int) methods.
void	namespace(NamespaceBindingSet namespaceBindings, int properties)	Notify one or more namespaces.
void	open()	Notify the start of the event stream
void	processingInstruction(String name, CharSequence data, Location location, 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, Location location, int properties)	Notify the start of an element
default 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

setPipelineConfiguration

void setPipelineConfiguration(PipelineConfiguration pipe)

Set the pipeline configuration

Parameters:

pipe - the pipeline configuration

getPipelineConfiguration

PipelineConfiguration getPipelineConfiguration()

Get the pipeline configuration

Returns:

the pipeline configuration

setSystemId

void setSystemId(String systemId)

Set the System ID of the tree represented by this event stream

Specified by:

setSystemId in interface Result

Parameters:

systemId - the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)

open

void open()
   throws XPathException

Notify the start of the event stream

Throws:

XPathException - if an error occurs

startDocument

void startDocument(int properties)
            throws XPathException

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 class ReceiverOptions

Throws:

XPathException - if an error occurs

endDocument

void endDocument()
          throws XPathException

Notify the end of a document node

Throws:

XPathException - if an error occurs

setUnparsedEntity

void setUnparsedEntity(String name,
                       String systemID,
                       String publicID)
                throws XPathException

Notify an unparsed entity URI.

Parameters:

name - The name of the unparsed entity

systemID - The system identifier of the unparsed entity

publicID - The identifier of the unparsed entity

Throws:

XPathException - if an error occurs

startElement

void startElement(NodeName elemName,
                  SchemaType typeCode,
                  Location location,
                  int properties)
           throws XPathException

Notify the start of an element

Parameters:

elemName - the name of the element.

typeCode - the type annotation of the element.

location - an object providing information about the module, line, and column where the node originated

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

Throws:

XPathException - if an error occurs

namespace

void namespace(NamespaceBindingSet namespaceBindings,
               int properties)
        throws XPathException

Notify one or more namespaces. 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:

namespaceBindings - contains the namespace prefix and namespace URI

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:

Throws:

XPathException - if an error occurs

Since:

9.8: changed in 9.8 to allow multiple namespace bindings to be supplied in a single call

attribute

void attribute(NodeName attName,
               SimpleType typeCode,
               CharSequence value,
               Location location,
               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 attribute

typeCode - The type annotation of the attribute

value - the string value of the attribute

location - provides information such as line number and system ID.

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

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.

Throws:

XPathException - if an error occurs

endElement

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.

Throws:

XPathException - if an error occurs

characters

void characters(CharSequence chars,
                Location location,
                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.

Parameters:

chars - The characters

location - provides information such as line number and system ID.

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,
                           Location location,
                           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 instruction

location - provides information such as line number and system ID.

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

comment

void comment(CharSequence content,
             Location location,
             int properties)
      throws XPathException

Notify a comment. Comments are only notified if they are outside the DTD.

Parameters:

content - The content of the comment

location - provides information such as line number and system ID.

properties - Additional information about the comment.

Throws:

XPathException - if an error occurs

append

default void append(Item item,
                    Location locationId,
                    int properties)
             throws XPathException

Append an arbitrary item (node, atomic value, or function) to the output. The default implementation throws UnsupportedOperationException.

Parameters:

item - the item to be appended

locationId - the location of the calling instruction, for diagnostics

properties - if the item is an element node, this indicates whether its namespaces need to be copied. Values are ReceiverOptions.ALL_NAMESPACES, ReceiverOptions.LOCAL_NAMESPACES; the default (0) means no namespaces

Throws:

XPathException

append

default void append(Item item)
             throws XPathException

Append an arbitrary item (node, atomic value, or function) to the output. By default, if the item is an element node, it is copied with all namespaces. The default implementation calls append(Item, Location, int), whose default implementation throws UnsupportedOperationException

Parameters:

item - the item to be appended

Throws:

XPathException - if the operation fails

close

void close()
    throws XPathException

Notify the end of the event stream

Throws:

XPathException - if an error occurs

usesTypeAnnotations

default boolean usesTypeAnnotations()

Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events. The default implementation of this method returns false.

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)

handlesAppend

default boolean handlesAppend()

Ask whether this Receiver can handle arbitrary items in its append(net.sf.saxon.om.Item, net.sf.saxon.expr.parser.Location, int) and append(Item, Location, int) methods. If it cannot, then calling these methods will raise an exception (typically but not necessarily an UnsupportedOperationException). The default implementation of this method returns false.

Returns:

true if the Receiver is able to handle items supplied to its append(net.sf.saxon.om.Item, net.sf.saxon.expr.parser.Location, int) and append(Item, Location, int) methods. A receiver that returns true may still reject some kinds of item, for example it may reject function items.