Package com.saxonica.ee.stream.watch
Class IterateAction
java.lang.Object
net.sf.saxon.event.Outputter
net.sf.saxon.event.ProxyOutputter
com.saxonica.ee.stream.feed.ItemFeed
com.saxonica.ee.stream.watch.ForEachAction
com.saxonica.ee.stream.watch.IterateAction
This watch implements xsl:iterate in streaming mode. It watches for the nodes selected by the
xsl:iterate instruction; when such a node is encountered, it locates the relevant (inverted)
template, and activates it.
The watch is capable of handling a select expression that selects non-peer nodes (that is, one selected node that is a descendant of another). A top-level selected node is processed directly to the output receiver; a nested node is processed to create a temporary result tree, which is then appended to the output sequence when the processing of the outer selected node is complete.
-
Field Summary
Fields inherited from class com.saxonica.ee.stream.watch.ForEachAction
actionPuller, bodyContext, watchManager
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
ConstructorsConstructorDescriptionIterateAction
(WatchManager watchManager, Expression expression, ItemFeed result, XPathContext context) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Signal that a node (other than an element) that matches the selection has been found.void
close()
Finish evaluating the expression.void
endSelectedParentNode
(Location locationId) Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.void
open
(Terminator terminator) Start evaluating the expression.startSelectedParentNode
(FleetingParentNode node, Location locationId) Signal that an element has been found that matches the selection that this Watch is looking for.Methods inherited from class com.saxonica.ee.stream.watch.ForEachAction
getAction, getBodyContext, getInversion, getWatchManager, isActionConsuming, makeBodyContext, setInversion
Methods inherited from class com.saxonica.ee.stream.feed.ItemFeed
append, dynamicError, getContext, getExpression, getResultFeed, getTerminator, hasFailed, processItems, setExpression, setHasFailed, setTerminator
Methods inherited from class net.sf.saxon.event.ProxyOutputter
attribute, characters, comment, endDocument, endElement, getNextOutputter, namespace, open, processingInstruction, setUnparsedEntity, startContent, startDocument, startElement, startElement, 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
-
IterateAction
public IterateAction(WatchManager watchManager, Expression expression, ItemFeed result, XPathContext context)
-
-
Method Details
-
open
Description copied from class:ItemFeed
Start evaluating the expression. The default implementation does nothing.- Overrides:
open
in classForEachAction
- Parameters:
terminator
- used to achieve early exit- Throws:
XPathException
- if a dynamic error occurs
-
startSelectedParentNode
public Receiver startSelectedParentNode(FleetingParentNode node, Location locationId) throws XPathException Signal that an element has been found that matches the selection that this Watch is looking for. This method is called by the WatchManager while processing the startElement event that matches the selection. For this purpose, any attributes selected by the last step in the selection are ignored- Overrides:
startSelectedParentNode
in classForEachAction
- Parameters:
node
- the element or document node whose start event has been matchedlocationId
- the location associated with the element or document node (may be the location of the instruction that created it)- Returns:
- a receiver that collects the contents of the selected node, or null
- Throws:
ValidationException
- May be raised if the constraint implemented by this Watch is violated @param locationId the location of the node in the source, or of the instruction that created itXPathException
- May be raised if a dynamic error occurs
-
append
Signal that a node (other than an element) that matches the selection has been found.- Specified by:
append
in interfaceReceiver
- Overrides:
append
in classForEachAction
- Parameters:
it
- the node that was matched.- Throws:
XPathException
- if the operation fails
-
endSelectedParentNode
Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.- Overrides:
endSelectedParentNode
in classForEachAction
- Parameters:
locationId
- the location of the node in the source, or of the instruction that created it- Throws:
ValidationException
- May be raised if the constraint implemented by this Watch is violated @param locationId the location of the node in the source, or of the instruction that created itXPathException
- May be raised if a constraint implemented by this Watch is violated
-
close
Description copied from class:ItemFeed
Finish evaluating the expression.- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classForEachAction
- Throws:
XPathException
- if a dynamic error occurs
-