Package net.sf.saxon.event

Class EventBuffer

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.EventBuffer

All Implemented Interfaces:

Result, Receiver

public class EventBuffer
extends SequenceReceiver

An EventBuffer is a receiver of events that records the events in memory for subsequent replay. It is used, for example, in the implementation of try/catch, where events cannot be written directly to the final serializer in case an error occurs and is caught.

Note that events are retained along with their properties, so the class implements "sticky disable-output-escaping" - text nodes can have selected characters marked with the disable-escaping property.

Since:

9.9

Field Summary

Fields

Modifier and Type	Field	Description
(package private) List<Event>	buffer

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	Description
EventBuffer(PipelineConfiguration pipe)

Method Summary

Modifier and Type	Method	Description
void	append(Item item, Location location, 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.
void	namespace(NamespaceBindingSet namespaceBindings, int properties)	Notify one or more namespaces.
void	processingInstruction(String name, CharSequence data, Location location, int properties)	Output a processing instruction
void	replay(Receiver out)	Replay the captured events to a supplied destination
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

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

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getNamePool, getPipelineConfiguration, getSystemId, handlesAppend, open, setPipelineConfiguration, setSystemId, setUnparsedEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.event.Receiver

usesTypeAnnotations

Field Detail

buffer

List<Event> buffer

Constructor Detail

EventBuffer

public EventBuffer(PipelineConfiguration pipe)

Method Detail

startDocument

public void startDocument(int properties)
                   throws XPathException

Description copied from interface: Receiver

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

public void endDocument()
                 throws XPathException

Description copied from interface: Receiver

Notify the end of a document node

Throws:

XPathException - if an error occurs

startElement

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

Description copied from interface: Receiver

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

public void namespace(NamespaceBindingSet namespaceBindings,
                      int properties)
               throws XPathException

Description copied from interface: Receiver

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

attribute

public void attribute(NodeName attName,
                      SimpleType typeCode,
                      CharSequence value,
                      Location location,
                      int properties)
               throws XPathException

Description copied from interface: Receiver

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

public void startContent()
                  throws XPathException

Description copied from interface: Receiver

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

public void endElement()
                throws XPathException

Description copied from interface: Receiver

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

public void characters(CharSequence chars,
                       Location location,
                       int properties)
                throws XPathException

Description copied from interface: Receiver

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

public void processingInstruction(String name,
                                  CharSequence data,
                                  Location location,
                                  int properties)
                           throws XPathException

Description copied from interface: Receiver

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

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

Description copied from interface: Receiver

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

public void append(Item item,
                   Location location,
                   int properties)
            throws XPathException

Description copied from class: SequenceReceiver

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

Specified by:

append in interface Receiver

Specified by:

append in class SequenceReceiver

Parameters:

item - the item to be appended

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

close

public void close()
           throws XPathException

Description copied from interface: Receiver

Notify the end of the event stream

Throws:

XPathException - if an error occurs

replay

public void replay(Receiver out)
            throws XPathException

Replay the captured events to a supplied destination

Parameters:

out - the destination Receiver to receive the events

Throws:

XPathException - if any error occurs