Package com.saxonica.ee.stream.adjunct
Class FeedToEventBuffer
java.lang.Object
net.sf.saxon.event.Outputter
net.sf.saxon.event.ProxyOutputter
com.saxonica.ee.stream.feed.ItemFeed
com.saxonica.ee.stream.adjunct.FeedToEventBuffer
An ItemFeed that captures all written events in a buffer for subsequent replay.
-
Field Summary
Fields inherited from class net.sf.saxon.event.Outputter
pipelineConfiguration, systemId
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
ConstructorsConstructorDescriptionFeedToEventBuffer
(Outputter next, ItemFeed agglomerator, XPathContext context) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Supply one item towards the streamed input of the expressionvoid
attribute
(NodeName name, SimpleType type, String value, Location location, int properties) Notify an attribute.void
characters
(UnicodeString chars, Location location, int properties) Notify character data.void
close()
Finish evaluating the expression.void
comment
(UnicodeString content, Location location, int properties) Notify a comment.void
Notify the end of a document nodevoid
Notify the end of an element.void
namespace
(String prefix, NamespaceUri uri, int properties) Notify a namespace binding.void
processingInstruction
(String name, UnicodeString data, Location location, int properties) Output a processing instructionvoid
Replay the captured events to a supplied destinationvoid
setBuffer
(List<OutputterEvent> buffer) void
Mark this feed as having failed (that is, as having detected and reported a dynamic error).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 type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Notify the start of an element, supplying all attributes and namespacesvoid
startElement
(NodeName elemName, SchemaType typeCode, Location location, int properties) Notify the start of an elementMethods inherited from class com.saxonica.ee.stream.feed.ItemFeed
append, dynamicError, endSelectedParentNode, getContext, getExpression, getResultFeed, getTerminator, hasFailed, open, processItems, setExpression, setTerminator, startSelectedParentNode
Methods inherited from class net.sf.saxon.event.ProxyOutputter
getNextOutputter, open, setUnparsedEntity, usesTypeAnnotations
Methods inherited from class net.sf.saxon.event.Outputter
getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId, spreadStartElement
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
handlesAppend
-
Constructor Details
-
FeedToEventBuffer
-
-
Method Details
-
setBuffer
-
startDocument
Description copied from class:ProxyOutputter
Notify the start of a document node- Specified by:
startDocument
in interfaceReceiver
- Overrides:
startDocument
in classProxyOutputter
- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-
endDocument
Description copied from class:ProxyOutputter
Notify the end of a document node- Specified by:
endDocument
in interfaceReceiver
- Overrides:
endDocument
in classProxyOutputter
- Throws:
XPathException
- if an error occurs
-
startElement
Description copied from class:ProxyOutputter
Notify the start of an element- Overrides:
startElement
in classProxyOutputter
- 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 originatedproperties
- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException Description copied from class:ProxyOutputter
Notify the start of an element, supplying all attributes and namespaces- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classProxyOutputter
- Parameters:
elemName
- the name of the element.type
- the type annotation of the element.attributes
- the attributes of this elementnamespaces
- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation
- an object providing information about the module, line, and column where the node originatedproperties
- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-
attribute
public void attribute(NodeName name, SimpleType type, String value, Location location, int properties) Description copied from class:ProxyOutputter
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Overrides:
attribute
in classProxyOutputter
- Parameters:
name
- The name of the attributetype
- The type annotation of the attributevalue
- the string value of the attributelocation
- 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
-
namespace
Description copied from class:ProxyOutputter
Notify a namespace binding. This method is called at some point after startElement(). The semantics are similar to the xsl:namespace instruction in XSLT, or the namespace node constructor in XQuery. A namespace must not conflict with any namespaces already used for element or attribute names.- Overrides:
namespace
in classProxyOutputter
- Parameters:
prefix
- The namespace prefix; zero-length string for the default namespaceuri
- The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.properties
- The REJECT_DUPLICATES property: if 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:
-
startContent
public void startContent()Description copied from class:ProxyOutputter
Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial Outputter 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.- Overrides:
startContent
in classProxyOutputter
-
endElement
Description copied from class:ProxyOutputter
Notify the end of an element. The Outputter must maintain a stack if it needs to know which element is ending.- Specified by:
endElement
in interfaceReceiver
- Overrides:
endElement
in classProxyOutputter
- Throws:
XPathException
- if an error occurs
-
characters
Description copied from class:ProxyOutputter
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.- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyOutputter
- Parameters:
chars
- The characterslocation
- 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(String name, UnicodeString data, Location location, int properties) Description copied from class:ProxyOutputter
Output a processing instruction- Specified by:
processingInstruction
in interfaceReceiver
- Overrides:
processingInstruction
in classProxyOutputter
- Parameters:
name
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocation
- provides information such as line number and system ID.properties
- Additional information about the PI.
-
comment
Description copied from class:ProxyOutputter
Notify a comment. Comments are only notified if they are outside the DTD.- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyOutputter
- Parameters:
content
- The content of the commentlocation
- provides information such as line number and system ID.properties
- Additional information about the comment.
-
append
Supply one item towards the streamed input of the expression- Specified by:
append
in interfaceReceiver
- Specified by:
append
in classItemFeed
- Parameters:
item
- the item to be supplied- Throws:
XPathException
- if the operation fails
-
close
Description copied from class:ItemFeed
Finish evaluating the expression.- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classItemFeed
- Throws:
XPathException
- if a dynamic error occurs
-
replay
Replay the captured events to a supplied destination- Parameters:
out
- the destinationReceiver
to receive the events- Throws:
XPathException
- if any error occurs
-
setHasFailed
public void setHasFailed()Mark this feed as having failed (that is, as having detected and reported a dynamic error). Once the feed is marked as having failed, it should not attempt to process any further input.- Overrides:
setHasFailed
in classItemFeed
-