<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ElemForEach.hpp</h1><a href="ElemForEach_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/*</font>
00002 <font class="comment"> * Copyright 1999-2004 The Apache Software Foundation.</font>
00003 <font class="comment"> *</font>
00004 <font class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</font>
00005 <font class="comment"> * you may not use this file except in compliance with the License.</font>
00006 <font class="comment"> * You may obtain a copy of the License at</font>
00007 <font class="comment"> *</font>
00008 <font class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</font>
00009 <font class="comment"> *</font>
00010 <font class="comment"> * Unless required by applicable law or agreed to in writing, software</font>
00011 <font class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</font>
00012 <font class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</font>
00013 <font class="comment"> * See the License for the specific language governing permissions and</font>
00014 <font class="comment"> * limitations under the License.</font>
00015 <font class="comment"> */</font>
00016 <font class="preprocessor">#if !defined(XALAN_ELEMFOREACH_HEADER_GUARD)</font>
<a name="l00017"></a><a class="code" href="ElemForEach_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_ELEMFOREACH_HEADER_GUARD </font>
00018 <font class="preprocessor"></font>
00019 
00020 
00021 <font class="comment">// Base include file.  Must be first.</font>
00022 <font class="preprocessor">#include "<a class="code" href="XSLTDefinitions_8hpp.html">XSLTDefinitions.hpp</a>"</font>
00023 
00024 
00025 
00026 <font class="preprocessor">#include &lt;<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>&gt;</font>
00027 
00028 
00029 
00030 <font class="comment">// Base class header file.</font>
00031 <font class="preprocessor">#include "<a class="code" href="ElemTemplateElement_8hpp.html">ElemTemplateElement.hpp</a>"</font>
00032 
00033 
00034 
00035 <font class="preprocessor">#include &lt;<a class="code" href="NodeRefListBase_8hpp.html">xalanc/XPath/NodeRefListBase.hpp</a>&gt;</font>
00036 <font class="preprocessor">#include &lt;<a class="code" href="MutableNodeRefList_8hpp.html">xalanc/XPath/MutableNodeRefList.hpp</a>&gt;</font>
00037 <font class="preprocessor">#include &lt;<a class="code" href="XObject_8hpp.html">xalanc/XPath/XObject.hpp</a>&gt;</font>
00038 
00039 
00040 
00041 <font class="preprocessor">#include "<a class="code" href="Constants_8hpp.html">Constants.hpp</a>"</font>
00042 
00043 
00044 
00045 XALAN_CPP_NAMESPACE_BEGIN
00046 
00047 
00048 
<a name="l00049"></a><a class="code" href="ElemForEach_8hpp.html#a1">00049</a> <font class="keyword">class </font><a class="code" href="classElemSort.html">ElemSort</a>;
00050 <font class="keyword">class </font><a class="code" href="classElemTemplate.html">ElemTemplate</a>;
00051 <font class="keyword">class </font>NodeSorter;
00052 <font class="keyword">class </font><a class="code" href="classXPath.html">XPath</a>;
00053 
00054 
00055 
<a name="l00056"></a><a class="code" href="classElemForEach.html">00056</a> <font class="keyword">class </font><a class="code" href="classElemForEach.html">ElemForEach</a>: <font class="keyword">public</font> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>
00057 {
00058 <font class="keyword">public</font>:
00059 
00069     <a class="code" href="classElemForEach.html#a0">ElemForEach</a>(
00070             <a class="code" href="classStylesheetConstructionContext.html">StylesheetConstructionContext</a>&amp;  constructionContext,
00071             Stylesheet&amp;                     stylesheetTree,
00072             <font class="keyword">const</font> AttributeListType&amp;        atts,
00073             <font class="keywordtype">int</font>                             lineNumber,
00074             <font class="keywordtype">int</font>                             columnNumber);
00075 
00076     <font class="keyword">virtual</font>
00077     <a class="code" href="classElemForEach.html#a1">~ElemForEach</a>();
00078 
<a name="l00079"></a><a class="code" href="classElemForEach.html#s0">00079</a>     <font class="keyword">typedef</font> XalanVector&lt;ElemSort*&gt;      SortElemsVectorType;
00080 
00081     <font class="comment">// These methods are inherited from ElemTemplateElement ...</font>
00082 
00083     <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00084     <a class="code" href="classElemTemplateElement.html#a13">getElementName</a>() <font class="keyword">const</font>;
00085 
00086     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00087     <a class="code" href="classElemTemplateElement.html#a16">processSortElement</a>(
00088             <a class="code" href="classStylesheetConstructionContext.html">StylesheetConstructionContext</a>&amp;  constructionContext,
00089             Stylesheet&amp;                     theStylesheet,
00090             <font class="keyword">const</font> AttributeListType&amp;        atts,
00091             <font class="keyword">const</font> LocatorType*              locator = 0);
00092 
00093     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00094     <a class="code" href="classElemTemplateElement.html#a22">postConstruction</a>(
00095             <a class="code" href="classStylesheetConstructionContext.html">StylesheetConstructionContext</a>&amp;  constructionContext,
00096             <font class="keyword">const</font> <a class="code" href="classNamespacesHandler.html">NamespacesHandler</a>&amp;        theParentHandler);
00097 
00098 <font class="preprocessor">#if !defined(XALAN_RECURSIVE_STYLESHEET_EXECUTION)</font>
00099 <font class="preprocessor"></font>    <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>*
00100     <a class="code" href="classElemTemplateElement.html#a6">startElement</a>(<a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;    executionContext) <font class="keyword">const</font>;
00101     
00102     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00103     <a class="code" href="classElemTemplateElement.html#a7">endElement</a>(<a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;      executionContext) <font class="keyword">const</font>;
00104 
00105     <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>*
00106     <a class="code" href="classElemTemplateElement.html#a31">getNextChildElemToExecute</a>(
00107                <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;  executionContext,
00108                <font class="keyword">const</font> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>*   currentElem) <font class="keyword">const</font>;
00109 <font class="preprocessor">#else</font>
00110 <font class="preprocessor"></font>    <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00111     <a class="code" href="classElemTemplateElement.html#a8">execute</a>(<a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;     executionContext) <font class="keyword">const</font>;
00112 <font class="preprocessor">#endif</font>
00113 <font class="preprocessor"></font>    
00114     <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXPath.html">XPath</a>*
00115     <a class="code" href="classElemTemplateElement.html#a40">getXPath</a>(<font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>   index = 0) <font class="keyword">const</font>;
00116 
00117 <font class="keyword">protected</font>:
00118 
00128     <a class="code" href="classElemForEach.html#a0">ElemForEach</a>(
00129             <a class="code" href="classStylesheetConstructionContext.html">StylesheetConstructionContext</a>&amp;  constructionContext,
00130             Stylesheet&amp;                     stylesheetTree,
00131             <font class="keywordtype">int</font>                             lineNumber,
00132             <font class="keywordtype">int</font>                             columnNumber,
00133             <font class="keywordtype">int</font>                             xslToken);
00134 
00135 <font class="preprocessor">#if !defined(XALAN_RECURSIVE_STYLESHEET_EXECUTION)</font>
00136 <font class="preprocessor"></font>
00137     <font class="comment">/*</font>
00138 <font class="comment">     * Returns a pointer to a list of the selected nodes.  The</font>
00139 <font class="comment">     * nodes are sorted if required. </font>
00140 <font class="comment">     * </font>
00141 <font class="comment">     * @param executionContext  context for executing this element</font>
00142 <font class="comment">     * @return pointer to the list of selected (and sorted) nodes</font>
00143 <font class="comment">     */</font>
00144     <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classNodeRefListBase.html">NodeRefListBase</a>*
00145     <a class="code" href="classElemForEach.html#b1">createSelectedAndSortedNodeList</a>(
00146             <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;     executionContext) <font class="keyword">const</font>;
00147     
00148     <font class="comment">/*</font>
00149 <font class="comment">     * Release any objects used to maintain the last selected </font>
00150 <font class="comment">     * (and sorted) node list to be created</font>
00151 <font class="comment">     * </font>
00152 <font class="comment">     * @param executionContext  context for executing this element</font>
00153 <font class="comment">     */</font>
00154     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00155     <a class="code" href="classElemForEach.html#b2">releaseSelectedAndSortedNodeList</a>(
00156             <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;     executionContext) <font class="keyword">const</font>;
00157 
00158     <font class="comment">/*</font>
00159 <font class="comment">     * Sorts a list of nodes </font>
00160 <font class="comment">     *</font>
00161 <font class="comment">     * @param executionContext  context for executing this element</font>
00162 <font class="comment">     * @param selectedNodeList  list of nodes to be sorted</font>
00163 <font class="comment">     * @param sortedNodeList    list for sorted nodes</font>
00164 <font class="comment">     *</font>
00165 <font class="comment">     * @returns pointer to list of sorted nodes</font>
00166 <font class="comment">     */</font>
00167     <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classNodeRefListBase.html">NodeRefListBase</a>*
00168     <a class="code" href="classElemForEach.html#b3">sortChildren</a>(   
00169             <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;     executionContext,
00170             <font class="keyword">const</font> <a class="code" href="classNodeRefListBase.html">NodeRefListBase</a>&amp;          selectedNodeList,
00171             <a class="code" href="classMutableNodeRefList.html">MutableNodeRefList</a>&amp;             sortedNodeList) <font class="keyword">const</font>;
00172 
00173 <font class="preprocessor">#else</font>
00174 <font class="preprocessor"></font>
00181     <font class="keywordtype">void</font>
00182     transformSelectedChildren(
00183             <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;     executionContext,
00184             <font class="keyword">const</font> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>*      theTemplate) <font class="keyword">const</font>;
00185 
00194     <font class="keywordtype">void</font>
00195     transformSelectedChildren(
00196             <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;     executionContext,
00197             <font class="keyword">const</font> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>*      theTemplate,
00198             <font class="keyword">const</font> <a class="code" href="classNodeRefListBase.html">NodeRefListBase</a>&amp;          sourceNodes,
00199             NodeRefListBase::size_type      sourceNodesCount) <font class="keyword">const</font>;
00200 
00210     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00211     selectAndSortChildren(
00212             <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp;     executionContext,
00213             <font class="keyword">const</font> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>*      theTemplate,
00214             NodeSorter*                     sorter,
00215             <font class="keywordtype">int</font>                             selectStackFrameIndex) <font class="keyword">const</font>;
00216 <font class="preprocessor">#endif</font>
00217 <font class="preprocessor"></font>
<a name="l00218"></a><a class="code" href="classElemForEach.html#n0">00218</a>     <font class="keyword">const</font> <a class="code" href="classXPath.html">XPath</a>*            m_selectPattern;
00219 
00220 <font class="keyword">private</font>:
00221 
00222     SortElemsVectorType             m_sortElems;
00223 
00224     SortElemsVectorType::size_type  m_sortElemsCount;
00225 
00226 };
00227 
00228 
00229 
00230 XALAN_CPP_NAMESPACE_END
00231 
00232 
00233 
00234 <font class="preprocessor">#endif  // XALAN_ELEMFOREACH_HEADER_GUARD</font>
</font></pre></div><p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and 
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>

<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
	<TR>
		<TD WIDTH="80%" VALIGN="TOP">
			<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
			Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
		</TD>
	</TR>
	<TR>
		<TD WIDTH="100%">
			<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
		</TD>
	</TR>
</TABLE>