Package com.saxonica.ee.stream.watch
Class ForEachAction
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
- Direct Known Subclasses:
ForEachGroupParallelAction
,IterateAction
This watch implements xsl:for-each in streaming mode. It is informed of the nodes or other items selected by the
xsl:for-each instruction; when such an item is encountered, it locates the relevant (inverted)
action representing the body of the for-each, and activates it.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected PullEvaluator
protected XPathContext
protected final 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
ConstructorsConstructorDescriptionForEachAction
(WatchManager watchManager, Expression expression, ItemFeed result, XPathContext context) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Method called by the feed for a subexpression to supply a grounded item from the streamed input.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.protected Expression
protected XPathContext
protected Inversion
protected WatchManager
protected boolean
protected void
void
open
(Terminator terminator) Start evaluating the expression.void
setInversion
(Inversion inversion) Set the inversion of the for-each action (the body of the loop)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.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
-
Field Details
-
bodyContext
-
watchManager
-
actionPuller
-
-
Constructor Details
-
ForEachAction
public ForEachAction(WatchManager watchManager, Expression expression, ItemFeed result, XPathContext context)
-
-
Method Details
-
setInversion
Set the inversion of the for-each action (the body of the loop)- Parameters:
inversion
- the inverted code implementing the body of the for-each
-
getInversion
-
getWatchManager
-
getAction
-
isActionConsuming
protected boolean isActionConsuming() -
getBodyContext
-
open
Description copied from class:ItemFeed
Start evaluating the expression. The default implementation does nothing.- Overrides:
open
in classItemFeed
- Parameters:
terminator
- used to achieve early exit- Throws:
XPathException
- if a dynamic error occurs
-
makeBodyContext
protected void makeBodyContext() -
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 classItemFeed
- 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:
- always null for this method, but may be non-null in subclasses
- 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
Method called by the feed for a subexpression to supply a grounded item from the streamed input.- Specified by:
append
in interfaceReceiver
- Specified by:
append
in classItemFeed
- Parameters:
it
- the grounded item.- 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 classItemFeed
- 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 classItemFeed
- Throws:
XPathException
- if a dynamic error occurs
-