com.saxonica.ee.validate

Class CatchingReceiver

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

com.saxonica.ee.validate.CatchingReceiver

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class CatchingReceiver
extends ProxyReceiver

This class catches all errors thrown by a Receiver pipeline, and reports them to a specified ErrorListener; after an error has occurred, all further events are ignored. The class is added to a validation pipeline when validation of a streamed input document is requested, to allow a try/catch expression to catch validation errors.

Field Summary

Fields inherited from class net.sf.saxon.event.ProxyReceiver

nextReceiver

Fields inherited from class net.sf.saxon.event.SequenceReceiver

pipelineConfiguration, previousAtomic, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor and Description
CatchingReceiver(Receiver next, UnfailingErrorListener listener)

Method Summary

Modifier and Type	Method and Description
void	append(Item item, Location locationId, int copyNamespaces) Append an arbitrary item (node or atomic value) to the output
void	attribute(NodeName nameCode, SimpleType typeCode, java.lang.CharSequence value, Location locationId, int properties) Notify an attribute.
void	characters(java.lang.CharSequence chars, Location locationId, int properties) Character data
void	close() End of output.
void	comment(java.lang.CharSequence chars, Location locationId, int properties) Output a comment
void	endDocument() Notify the end of a document node
void	endElement() End of element
void	namespace(NamespaceBindingSet namespaceBindings, int properties) Notify a namespace.
void	open() Start of event stream
void	processingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) Processing Instruction
void	startContent() Notify the start of the content, that is, the completion of all attributes and namespaces.
void	startDocument(int properties) Start of a document node.
void	startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) Notify the start of an element

Methods inherited from class net.sf.saxon.event.ProxyReceiver

getNamePool, getUnderlyingReceiver, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, usesTypeAnnotations

Methods inherited from class net.sf.saxon.event.SequenceReceiver

append, getConfiguration, getPipelineConfiguration, getSystemId, isTrueSequenceReceiver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CatchingReceiver

public CatchingReceiver(Receiver next,
                        UnfailingErrorListener listener)

Method Detail

open

public void open()

Description copied from class: ProxyReceiver

Start of event stream

Specified by:

open in interface Receiver

Overrides:

open in class ProxyReceiver

close

public void close()

Description copied from class: ProxyReceiver

End of output. Note that closing this receiver also closes the rest of the pipeline.

Specified by:

close in interface Receiver

Overrides:

close in class ProxyReceiver

startDocument

public void startDocument(int properties)

Description copied from class: ProxyReceiver

Start of a document node.

Specified by:

startDocument in interface Receiver

Overrides:

startDocument in class ProxyReceiver

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions

endDocument

public void endDocument()

Description copied from class: ProxyReceiver

Notify the end of a document node

Specified by:

endDocument in interface Receiver

Overrides:

endDocument in class ProxyReceiver

startElement

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

Description copied from class: ProxyReceiver

Notify the start of an element

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyReceiver

Parameters:

elemName - integer code identifying the name of the element within the name pool.

typeCode - integer code identifying the element's type within the name pool.

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

properties - properties of the element node

namespace

public void namespace(NamespaceBindingSet namespaceBindings,
                      int properties)

Description copied from class: ProxyReceiver

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; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.

Specified by:

namespace in interface Receiver

Overrides:

namespace in class ProxyReceiver

Parameters:

namespaceBindings - the prefix/uri pair representing the namespace binding

properties - any special properties to be passed on this call

attribute

public void attribute(NodeName nameCode,
                      SimpleType typeCode,
                      java.lang.CharSequence value,
                      Location locationId,
                      int properties)

Description copied from class: ProxyReceiver

Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.

Specified by:

attribute in interface Receiver

Overrides:

attribute in class ProxyReceiver

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

value - the string value of the attribute

locationId - 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 IllegalStateException: attempt to output an attribute when there is no open element start tag

startContent

public void startContent()

Description copied from class: ProxyReceiver

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.

Specified by:

startContent in interface Receiver

Overrides:

startContent in class ProxyReceiver

endElement

public void endElement()

Description copied from class: ProxyReceiver

End of element

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

characters

public void characters(java.lang.CharSequence chars,
                       Location locationId,
                       int properties)

Description copied from class: ProxyReceiver

Character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

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

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.CharSequence data,
                                  Location locationId,
                                  int properties)

Description copied from class: ProxyReceiver

Processing Instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyReceiver

Parameters:

target - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

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

properties - Additional information about the PI.

comment

public void comment(java.lang.CharSequence chars,
                    Location locationId,
                    int properties)

Description copied from class: ProxyReceiver

Output a comment

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

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

properties - Additional information about the comment.

append

public void append(Item item,
                   Location locationId,
                   int copyNamespaces)

Description copied from class: ProxyReceiver

Append an arbitrary item (node or atomic value) to the output

Overrides:

append in class ProxyReceiver

Parameters:

item - the item to be appended

locationId - the location of the calling instruction, for diagnostics

copyNamespaces - if the item is an element node, this indicates whether its namespaces need to be copied. Values are NodeInfo.ALL_NAMESPACES, NodeInfo.LOCAL_NAMESPACES, NodeInfo.NO_NAMESPACES