Package com.saxonica.stream

The package com.saxonica.stream contains classes used to support streaming and document projection.

See:
Description

Interface Summary

Selection	A selection represents the restricted form of path expression permitted in XML Schema (both the selector and field variants)
Watch	A Watch represents a class that is interested in looking at nodes passing down a push pipeline, typically for the purpose of evaluating uniqueness and key constraints.

Class Summary

AttributeCopier	A Checker is a Receiver used to check the content of elements and attributes, especially those that participate in uniqueness, key, and keyref constraints.
ManualIterator	ManualIterator: a pseudo-iterator used while streaming.
PathSelection	A PathSelection is a Selection that applies a NodeTest to each element between the context element and the node being tested, and returns true if they all match.
Projector	This class uses a PathMap to do document projection.
SequenceExchanger	This class enables one thread to produce a sequence of items in push mode, and another thread to read the sequence of items in pull mode, using a producer/consumer model.
SequenceExchanger.Consumer	The Consumer is a SequenceIterator that reads a sequence of items from the Conduit: that is, it allows its caller to make a sequence of calls on next(), each of which will return the next item pushed onto the Conduit by the corresponding Producer.
SequenceExchanger.EvaluationThread	EvaluationThread is a producer that evaluates an expression in "push" mode, writing the results to a Conduit.
SequenceExchanger.Producer	The class Producer represents the thread that pushes items onto the Conduit.
SequenceExchanger.SequencePusher	A SequenceReceiver that accepts a sequence of events and writes them to a Conduit
SequenceFilter	A sequence writer that passes on only those items that satisfy a filter predicate.
SequenceTransmitter	This is a SequenceWriter that passes items through to a supplied SequenceReceiver
StreamingApplyTemplates	Streaming version of the xsl:apply-templates instruction.
StreamingCopy	This class performs a streaming copy of selected nodes within a document.
StreamingDespatcher	This class receives events from streamed processing of an input file, and fires off template rules in streaming mode to process the nodes as they are read.
SubtreeCopyWatch	This class is used when optimizing a SequentialCopy, that is, when evaluating a construct of the form saxon:stream(doc('a.xml')/a/b/c).
TemplateInversion	This class takes as input the expression tree representing the content of a streamable template, and analyses it.
UnionSelection	A union selection is a selection consisting of several alternatives separated by "|"
WatchManager	This class sits on a push pipeline and evaluates the passing element and attribute nodes.

Package com.saxonica.stream Description

The package com.saxonica.stream contains classes used to support streaming and document projection. In principle these facilities are applicable both to XSLT and XQuery; the streamed evaluation of XPath expressions is also used during schema validation, to process identity constraints.

None of these classes will be used directly by typical user applications.