Package com.saxonica.ee.stream.feed

Class ItemMappingFeed

java.lang.Object

net.sf.saxon.event.Outputter

net.sf.saxon.event.ProxyOutputter

com.saxonica.ee.stream.feed.ItemFeed

com.saxonica.ee.stream.feed.GroundedItemFeed

com.saxonica.ee.stream.feed.ItemMappingFeed

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class ItemMappingFeed
extends GroundedItemFeed

A Feed which applies an ItemMappingFunction to each supplied item. This produces zero or one output items for each input item. The ItemMappingFunction must be one that is capable of handling streamed nodes (otherwise an UnsupportedOperationException is likely).

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

Constructors

Constructor	Description
ItemMappingFeed(Expression expr, ItemFeed result, XPathContext context, ItemMappingFunction function)

Method Summary

Modifier and Type	Method	Description
void	append(Item item)	Supply an item to the feed
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.
Receiver	startSelectedParentNode(FleetingParentNode node, Location locationId)	Signal that an element or document node has been found that matches the selection that this Watch is looking for.

Methods inherited from class com.saxonica.ee.stream.feed.GroundedItemFeed

attribute, characters, comment, endDocument, endElement, namespace, processingInstruction, setUnparsedEntity, startContent, startDocument, startElement, startElement

Methods inherited from class com.saxonica.ee.stream.feed.ItemFeed

append, dynamicError, getContext, getExpression, getResult, getTerminator, hasFailed, open, processItems, setExpression, setHasFailed, setTerminator

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

getNextOutputter, open, setLocation, usesTypeAnnotations

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

getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId

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 Detail

ItemMappingFeed

public ItemMappingFeed(Expression expr,
                       ItemFeed result,
                       XPathContext context,
                       ItemMappingFunction function)

Method Detail

startSelectedParentNode

public Receiver startSelectedParentNode(FleetingParentNode node,
                                        Location locationId)
                                 throws XPathException

Description copied from class: ItemFeed

Signal that an element or document node has been found that matches the selection that this Watch is looking for. This method is called by the WatchManager while processing the startElement or startDocument event that matches the selection.

Overrides:

startSelectedParentNode in class ItemFeed

Parameters:

node - the element or document node whose start event has been matched

locationId - the location associated with the element or document node (may be the location of the instruction that created it)

Returns:

a Receiver to be notified of all events starting with the startElement/startDocument event for the matched element, and ending with the endElement event for that element; or null if this feature is not required.

Throws:

XPathException - May be raised if a dynamic error occurs

endSelectedParentNode

public void endSelectedParentNode(Location locationId)
                           throws XPathException

Description copied from class: ItemFeed

Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.

Overrides:

endSelectedParentNode in class ItemFeed

Parameters:

locationId - the location of the element

Throws:

XPathException - May be raised if a constraint implemented by this Watch is violated

append

public void append(Item item)
            throws XPathException

Supply an item to the feed

Specified by:

append in interface Receiver

Specified by:

append in class ItemFeed

Parameters:

item - the item being fed

Throws:

XPathException - to report any failure

close

public void close()
           throws XPathException

Finish evaluating the expression. The default implementation does nothing.

Specified by:

close in interface Receiver

Overrides:

close in class ItemFeed

Throws:

XPathException - if a dynamic error occurs