<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:48 GMT 2011 -->
<TITLE>
com.saxonica.stream
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="com.saxonica.stream";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/saxonica/serialize/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../com/saxonica/stream/adjunct/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/saxonica/stream/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package com.saxonica.stream
</H2>
This package and its subpackages contains classes used to support streaming
and document projection.
<P>
<B>See:</B>
<BR>
<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/Conduit.html" title="class in com.saxonica.stream">Conduit</A></B></TD>
<TD>A Conduit is a communication channel from a Producer to a Consumer: the channel is used to pass
a sequence of items (and possibly an exception) from the producer to the consumer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/ExpressionInverter.html" title="class in com.saxonica.stream">ExpressionInverter</A></B></TD>
<TD>This class performs inversion of an expression so that it can be evaluated in push mode as events are
received from the XML parser.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/InvertedExpression.html" title="class in com.saxonica.stream">InvertedExpression</A></B></TD>
<TD>This class represents an expression that has been "inverted" (in the Jackson sense) so that its
execution is push-driven, that is, driven by events from the streamed document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/ManualIterator.html" title="class in com.saxonica.stream">ManualIterator</A></B></TD>
<TD>ManualIterator: a pseudo-iterator used while streaming.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/Projector.html" title="class in com.saxonica.stream">Projector</A></B></TD>
<TD>This class uses a <A HREF="../../../net/sf/saxon/expr/parser/PathMap.html" title="class in net.sf.saxon.expr.parser"><CODE>PathMap</CODE></A> to do document projection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/SequenceExchanger.html" title="class in com.saxonica.stream">SequenceExchanger</A></B></TD>
<TD>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/SequenceExchanger.Consumer.html" title="class in com.saxonica.stream">SequenceExchanger.Consumer</A></B></TD>
<TD>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/SequenceExchanger.EvaluationThread.html" title="class in com.saxonica.stream">SequenceExchanger.EvaluationThread</A></B></TD>
<TD>EvaluationThread is a producer that evaluates an expression in "push" mode, writing the results
to a Conduit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/SequenceExchanger.Producer.html" title="class in com.saxonica.stream">SequenceExchanger.Producer</A></B></TD>
<TD>The class Producer represents the thread that pushes items onto the Conduit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/SequenceExchanger.SequencePusher.html" title="class in com.saxonica.stream">SequenceExchanger.SequencePusher</A></B></TD>
<TD>A SequenceReceiver that accepts a sequence of events and writes them to a Conduit</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/SequenceFilter.html" title="class in com.saxonica.stream">SequenceFilter</A></B></TD>
<TD>A sequence writer that passes on only those items that satisfy a filter predicate.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/SequenceTransmitter.html" title="class in com.saxonica.stream">SequenceTransmitter</A></B></TD>
<TD>This is a SequenceWriter that passes items through to a supplied SequenceReceiver</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/StreamingApplyTemplates.html" title="class in com.saxonica.stream">StreamingApplyTemplates</A></B></TD>
<TD>Streaming version of the xsl:apply-templates instruction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/StreamingCopy.html" title="class in com.saxonica.stream">StreamingCopy</A></B></TD>
<TD>This class performs a streaming copy of selected nodes within a document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/StreamingPatternMaker.html" title="class in com.saxonica.stream">StreamingPatternMaker</A></B></TD>
<TD>Factory class to make a streaming pattern from an expression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/StreamingRoute.html" title="class in com.saxonica.stream">StreamingRoute</A></B></TD>
<TD>A StreamingRoute represents the path of events through an expression tree being
evaluated in streaming mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/StreamingRoute.PushAction.html" title="class in com.saxonica.stream">StreamingRoute.PushAction</A></B></TD>
<TD>A PushAction is a collection of data that together represents the strategy for how an expression should be
evaluated in push mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../com/saxonica/stream/TemplateInversion.html" title="class in com.saxonica.stream">TemplateInversion</A></B></TD>
<TD>This class represents the inversion of a template body</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package com.saxonica.stream Description
</H2>
<P>
<p>This package and its subpackages 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.</p>
<p>None of these classes will be used directly by typical user applications.</p>
<p>This package contains classes that watch for events coming from the streamed document. Different
kinds of watch are associated with different expressions and perform differing actions with these events;
for example a <A HREF="../../../com/saxonica/stream/watch/CopyOfWatch.html" title="class in com.saxonica.stream.watch"><CODE>CopyOfWatch</CODE></A> builds a subtree representing an element
and passes this to a feed that expects a stream of element nodes, while a <A HREF="../../../com/saxonica/stream/watch/CountWatch.html" title="class in com.saxonica.stream.watch"><CODE>CountWatch</CODE></A>
counts the nodes and passes an integer to the next expression in the pipeline; a <A HREF="../../../com/saxonica/stream/watch/TypedValueWatch.html" title="class in com.saxonica.stream.watch"><CODE>TypedValueWatch</CODE></A>
atomizes nodes and feeds the resulting atomic values to the next stage.</p>
<p>The instantiation of watch classes, calling them to test whether they are interested in particular events,
and remembering when to de-activate them, is all handled by the <A HREF="../../../com/saxonica/stream/watch/WatchManager.html" title="class in com.saxonica.stream.watch"><CODE>WatchManager</CODE></A>.</p>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
30 July 2010</i></p>
<P>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/saxonica/serialize/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../com/saxonica/stream/adjunct/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/saxonica/stream/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
