<!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.adjunct
</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.adjunct";
}
}
</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/stream/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../com/saxonica/stream/feed/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/adjunct/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.adjunct
</H2>
This package contains classes used to support streaming.
<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/adjunct/AdjacentTextNodeMergerAdjunct.html" title="class in com.saxonica.stream.adjunct">AdjacentTextNodeMergerAdjunct</A></B></TD>
<TD>Compile an AdjacentTextNodeMerger expression to Java source code
Needed only for streaming - this class is not used in XQuery</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/AdjunctClassMapper.html" title="class in com.saxonica.stream.adjunct">AdjunctClassMapper</A></B></TD>
<TD>For each class of expression found on the expression tree, deliver a corresponding instance of the
helper class used to generate streaming code for the expression</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ApplyImportsAdjunct.html" title="class in com.saxonica.stream.adjunct">ApplyImportsAdjunct</A></B></TD>
<TD>Compile an xsl:apply-imports expression/instruction to Java source code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ApplyTemplatesAdjunct.html" title="class in com.saxonica.stream.adjunct">ApplyTemplatesAdjunct</A></B></TD>
<TD>Compile an apply-templates expression/instruction to Java source code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/AtomicSequenceConverterAdjunct.html" title="class in com.saxonica.stream.adjunct">AtomicSequenceConverterAdjunct</A></B></TD>
<TD>Compile a AtomicSequenceConverter expression to streaming code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/AtomizerAdjunct.html" title="class in com.saxonica.stream.adjunct">AtomizerAdjunct</A></B></TD>
<TD>Watch factory class for an atomizer</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/AverageAdjunct.html" title="class in com.saxonica.stream.adjunct">AverageAdjunct</A></B></TD>
<TD>Generate streaming code for the avg() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/BlockAdjunct.html" title="class in com.saxonica.stream.adjunct">BlockAdjunct</A></B></TD>
<TD>Generate streaming code for a Block, that is a sequence of expressions or instructions</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/CardinalityCheckerAdjunct.html" title="class in com.saxonica.stream.adjunct">CardinalityCheckerAdjunct</A></B></TD>
<TD>Generate streaming code for a cardinality checker</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ChooseAdjunct.html" title="class in com.saxonica.stream.adjunct">ChooseAdjunct</A></B></TD>
<TD>Streaming code to implement a conditional ("if/choose") expression</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/CopyAdjunct.html" title="class in com.saxonica.stream.adjunct">CopyAdjunct</A></B></TD>
<TD>Compile an xsl:copy expression/instruction to streaming code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/CopyOfAdjunct.html" title="class in com.saxonica.stream.adjunct">CopyOfAdjunct</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/CountAdjunct.html" title="class in com.saxonica.stream.adjunct">CountAdjunct</A></B></TD>
<TD>Generate streaming code for the count() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/DistinctValuesAdjunct.html" title="class in com.saxonica.stream.adjunct">DistinctValuesAdjunct</A></B></TD>
<TD>Compile a distinct-values expression/instruction to streaming code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/DocumentInstrAdjunct.html" title="class in com.saxonica.stream.adjunct">DocumentInstrAdjunct</A></B></TD>
<TD>Compile a xsl:document instruction to streaming code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ElementInstrAdjunct.html" title="class in com.saxonica.stream.adjunct">ElementInstrAdjunct</A></B></TD>
<TD>Generate streaming code for an xsl:element instruction</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/EmptyAdjunct.html" title="class in com.saxonica.stream.adjunct">EmptyAdjunct</A></B></TD>
<TD>Generate Java code for an empty() function call</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/EmptyTextNodeRemoverAdjunct.html" title="class in com.saxonica.stream.adjunct">EmptyTextNodeRemoverAdjunct</A></B></TD>
<TD>Compile an AdjacentTextNodeMerger expression to Java source code
Needed only for streaming - this class is not used in XQuery</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ExistsAdjunct.html" title="class in com.saxonica.stream.adjunct">ExistsAdjunct</A></B></TD>
<TD>Generate streaming code for an exists() function call</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/FilterExpressionAdjunct.html" title="class in com.saxonica.stream.adjunct">FilterExpressionAdjunct</A></B></TD>
<TD>Generate streaming code for a filter expression (when not part of a Watch).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ForEachAdjunct.html" title="class in com.saxonica.stream.adjunct">ForEachAdjunct</A></B></TD>
<TD>Compile an xsl:for-each instruction to streaming code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ForkAdjunct.html" title="class in com.saxonica.stream.adjunct">ForkAdjunct</A></B></TD>
<TD>Streaming code to implement an xsl:fork expression</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/GeneralComparisonAdjunct.html" title="class in com.saxonica.stream.adjunct">GeneralComparisonAdjunct</A></B></TD>
<TD>Watch factory class for a general comparison</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ItemCheckerAdjunct.html" title="class in com.saxonica.stream.adjunct">ItemCheckerAdjunct</A></B></TD>
<TD>Generate streaming code for an item checker</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/IterateAdjunct.html" title="class in com.saxonica.stream.adjunct">IterateAdjunct</A></B></TD>
<TD>Compile an xsl:iterate instruction to streaming code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/LetExpressionAdjunct.html" title="class in com.saxonica.stream.adjunct">LetExpressionAdjunct</A></B></TD>
<TD>Compiles streaming code to implement a Let expression</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/MinimaxAdjunct.html" title="class in com.saxonica.stream.adjunct">MinimaxAdjunct</A></B></TD>
<TD>Generate streaming code for the min() and max() functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/NextIterationAdjunct.html" title="class in com.saxonica.stream.adjunct">NextIterationAdjunct</A></B></TD>
<TD>Compile a xsl:next-intruction instruction to streaming code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/NextMatchAdjunct.html" title="class in com.saxonica.stream.adjunct">NextMatchAdjunct</A></B></TD>
<TD>Compile an xsl:next-match expression/instruction to streaming code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/ResultDocumentAdjunct.html" title="class in com.saxonica.stream.adjunct">ResultDocumentAdjunct</A></B></TD>
<TD>Handle an xsl:result-document expression/instruction for XSLT streaming capability.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/SimpleNodeConstructorAdjunct.html" title="class in com.saxonica.stream.adjunct">SimpleNodeConstructorAdjunct</A></B></TD>
<TD>Generate streaming code for an xsl:value-of, xsl:comment, xsl:processing-instruction instruction, etc</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/SingletonAtomizerAdjunct.html" title="class in com.saxonica.stream.adjunct">SingletonAtomizerAdjunct</A></B></TD>
<TD>Watch factory class for a singleton atomizer</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/StreamingAdjunct.html" title="class in com.saxonica.stream.adjunct">StreamingAdjunct</A></B></TD>
<TD>This abstract class supplements an <A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr"><CODE>Expression</CODE></A> with methods used at compile-time
to support streaming, by generating a <A HREF="../../../../com/saxonica/stream/watch/Watch.html" title="interface in com.saxonica.stream.watch"><CODE>Watch</CODE></A> or <A HREF="../../../../com/saxonica/stream/feed/Feed.html" title="interface in com.saxonica.stream.feed"><CODE>Feed</CODE></A>
that allows the expression to be evaluated in push mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/StringFnAdjunct.html" title="class in com.saxonica.stream.adjunct">StringFnAdjunct</A></B></TD>
<TD>Generate Java code to implement the XPath string() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/StringJoinAdjunct.html" title="class in com.saxonica.stream.adjunct">StringJoinAdjunct</A></B></TD>
<TD>Generate streaming code for the string-join() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/SumAdjunct.html" title="class in com.saxonica.stream.adjunct">SumAdjunct</A></B></TD>
<TD>Generate streaming code for the avg() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/UnsupportedOperationAdjunct.html" title="class in com.saxonica.stream.adjunct">UnsupportedOperationAdjunct</A></B></TD>
<TD>Streaming code for an expression that does not support streaming</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/stream/adjunct/WithParamAdjunct.html" title="class in com.saxonica.stream.adjunct">WithParamAdjunct</A></B></TD>
<TD>Compile a xsl:with-param instruction to streaming code.</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package com.saxonica.stream.adjunct Description
</H2>
<P>
<p>This package contains classes used to support streaming. For every kind of expression
that can appear in the expression tree, there is an auxiliary or adjunct class that contains
the code needed to support streaming (if any).</p>
<p>None of these classes will be used directly by typical user applications.</p>
<p>The interface to these adjunct classes is defined in the abstract class
<A HREF="../../../../com/saxonica/stream/adjunct/StreamingAdjunct.html" title="class in com.saxonica.stream.adjunct"><CODE>StreamingAdjunct</CODE></A>. The main methods
are <code>getWatchMaker()</code> and <code>getFeedMaker()</code> which return
a factory for respectively a <code>Watch</code> and a <code>Feed</code>;
a Watch is used to evaluate the expression in decomposed push mode, an event
at a time, while a Feed is used to evaluate it in composed push mode, an item
at a time.</p>
<p>The association between an expression class and its corresponding adjunct is
made by the <A HREF="../../../../com/saxonica/stream/adjunct/AdjunctClassMapper.html" title="class in com.saxonica.stream.adjunct"><CODE>AdjunctClassMapper</CODE></A> class.</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/stream/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../com/saxonica/stream/feed/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/adjunct/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>
