| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>Foreach xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/velocity/runtime/directive/Foreach.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.runtime.directive; |
| <a name="2" href="#2">2</a> |
| <a name="3" href="#3">3</a> <em class="jxr_comment">/*</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> *</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License. </em> |
| <a name="20" href="#20">20</a> <em class="jxr_comment"> */</em> |
| <a name="21" href="#21">21</a> |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.Writer; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.EventCartridge; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.Context; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.InternalContextAdapter; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.MethodInvocationException; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.ParseErrorException; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.ResourceNotFoundException; |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.TemplateInitException; |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeConstants; |
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeServices; |
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.ASTReference; |
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.Node; |
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.SimpleNode; |
| <a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.Resource; |
| <a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.Info; |
| <a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.IntrospectionCacheData; |
| <a name="41" href="#41">41</a> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * Foreach directive used for moving through arrays,</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * or objects that provide an Iterator.</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>">Jason van Zyl</a></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:geirm@optonline.net" target="alexandria_uri">mailto:geirm@optonline.net</a>">Geir Magnusson Jr.</a></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @author Daniel Rall</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @version $Id: Foreach.java 479060 2006-11-25 00:30:19Z henning $</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/velocity/runtime/directive/Foreach.html">Foreach</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a> |
| <a name="52" href="#52">52</a> { |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * A special context to use when the foreach iterator returns a null. This</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * is required since the standard context may not support nulls.</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * All puts and gets are passed through, except for the foreach iterator key.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/velocity/runtime/directive/Foreach.html">NullHolderContext</a> implements <a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> |
| <a name="59" href="#59">59</a> { |
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> innerContext = <strong class="jxr_keyword">null</strong>; |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> String loopVariableKey = <span class="jxr_string">""</span>; |
| <a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> active = <strong class="jxr_keyword">true</strong>; |
| <a name="63" href="#63">63</a> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Create the context as a wrapper to be used within the foreach</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @param key the reference used in the foreach</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param context the parent context</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/velocity/runtime/directive/Foreach.html">NullHolderContext</a>( String key, InternalContextAdapter context ) |
| <a name="70" href="#70">70</a> { |
| <a name="71" href="#71">71</a> innerContext = context; |
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">if</strong>( key != <strong class="jxr_keyword">null</strong> ) |
| <a name="73" href="#73">73</a> loopVariableKey = key; |
| <a name="74" href="#74">74</a> } |
| <a name="75" href="#75">75</a> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Get an object from the context, or null if the key is equal to the loop variable</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#get(java.lang.String)</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @exception MethodInvocationException passes on potential exception from reference method call</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="81" href="#81">81</a> <strong class="jxr_keyword">public</strong> Object get( String key ) <strong class="jxr_keyword">throws</strong> MethodInvocationException |
| <a name="82" href="#82">82</a> { |
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">return</strong> ( active && loopVariableKey.equals(key) ) |
| <a name="84" href="#84">84</a> ? <strong class="jxr_keyword">null</strong> |
| <a name="85" href="#85">85</a> : innerContext.get(key); |
| <a name="86" href="#86">86</a> } |
| <a name="87" href="#87">87</a> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#put(java.lang.String key, java.lang.Object value)</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> Object put( String key, Object value ) |
| <a name="92" href="#92">92</a> { |
| <a name="93" href="#93">93</a> <strong class="jxr_keyword">if</strong>( loopVariableKey.equals(key) && (value == <strong class="jxr_keyword">null</strong>) ) |
| <a name="94" href="#94">94</a> { |
| <a name="95" href="#95">95</a> active = <strong class="jxr_keyword">true</strong>; |
| <a name="96" href="#96">96</a> } |
| <a name="97" href="#97">97</a> |
| <a name="98" href="#98">98</a> <strong class="jxr_keyword">return</strong> innerContext.put( key, value ); |
| <a name="99" href="#99">99</a> } |
| <a name="100" href="#100">100</a> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * Allows callers to explicitly put objects in the local context.</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Objects added to the context through this method always end up</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * in the top-level context of possible wrapped contexts.</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @param key name of item to set.</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * @param value object to set to key.</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalWrapperContext#localPut(String, Object)</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="110" href="#110">110</a> <strong class="jxr_keyword">public</strong> Object localPut(<strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> Object value) |
| <a name="111" href="#111">111</a> { |
| <a name="112" href="#112">112</a> <strong class="jxr_keyword">return</strong> put(key, value); |
| <a name="113" href="#113">113</a> } |
| <a name="114" href="#114">114</a> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Does the context contain the key</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#containsKey(java.lang.Object key)</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="119" href="#119">119</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> containsKey( Object key ) |
| <a name="120" href="#120">120</a> { |
| <a name="121" href="#121">121</a> <strong class="jxr_keyword">return</strong> innerContext.containsKey(key); |
| <a name="122" href="#122">122</a> } |
| <a name="123" href="#123">123</a> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#getKeys()</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="127" href="#127">127</a> <strong class="jxr_keyword">public</strong> Object[] getKeys() |
| <a name="128" href="#128">128</a> { |
| <a name="129" href="#129">129</a> <strong class="jxr_keyword">return</strong> innerContext.getKeys(); |
| <a name="130" href="#130">130</a> } |
| <a name="131" href="#131">131</a> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * Remove an object from the context</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#remove(java.lang.Object key)</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong> Object remove(Object key) |
| <a name="137" href="#137">137</a> { |
| <a name="138" href="#138">138</a> <strong class="jxr_keyword">if</strong>( loopVariableKey.equals(key) ) |
| <a name="139" href="#139">139</a> { |
| <a name="140" href="#140">140</a> active = false; |
| <a name="141" href="#141">141</a> } |
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">return</strong> innerContext.remove(key); |
| <a name="143" href="#143">143</a> } |
| <a name="144" href="#144">144</a> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#pushCurrentTemplateName(java.lang.String s)</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="148" href="#148">148</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> pushCurrentTemplateName(String s) |
| <a name="149" href="#149">149</a> { |
| <a name="150" href="#150">150</a> innerContext.pushCurrentTemplateName(s); |
| <a name="151" href="#151">151</a> } |
| <a name="152" href="#152">152</a> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#popCurrentTemplateName()</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="156" href="#156">156</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> popCurrentTemplateName() |
| <a name="157" href="#157">157</a> { |
| <a name="158" href="#158">158</a> innerContext.popCurrentTemplateName(); |
| <a name="159" href="#159">159</a> } |
| <a name="160" href="#160">160</a> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#getCurrentTemplateName()</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="164" href="#164">164</a> <strong class="jxr_keyword">public</strong> String getCurrentTemplateName() |
| <a name="165" href="#165">165</a> { |
| <a name="166" href="#166">166</a> <strong class="jxr_keyword">return</strong> innerContext.getCurrentTemplateName(); |
| <a name="167" href="#167">167</a> } |
| <a name="168" href="#168">168</a> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#getTemplateNameStack()</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="172" href="#172">172</a> <strong class="jxr_keyword">public</strong> Object[] getTemplateNameStack() |
| <a name="173" href="#173">173</a> { |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">return</strong> innerContext.getTemplateNameStack(); |
| <a name="175" href="#175">175</a> } |
| <a name="176" href="#176">176</a> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#icacheGet(java.lang.Object key)</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="180" href="#180">180</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/velocity/util/introspection/IntrospectionCacheData.html">IntrospectionCacheData</a> icacheGet(Object key) |
| <a name="181" href="#181">181</a> { |
| <a name="182" href="#182">182</a> <strong class="jxr_keyword">return</strong> innerContext.icacheGet(key); |
| <a name="183" href="#183">183</a> } |
| <a name="184" href="#184">184</a> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#icachePut(java.lang.Object key, org.apache.velocity.util.introspection.IntrospectionCacheData o)</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="188" href="#188">188</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> icachePut(Object key, <a href="../../../../../org/apache/velocity/util/introspection/IntrospectionCacheData.html">IntrospectionCacheData</a> o) |
| <a name="189" href="#189">189</a> { |
| <a name="190" href="#190">190</a> innerContext.icachePut(key,o); |
| <a name="191" href="#191">191</a> } |
| <a name="192" href="#192">192</a> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#setCurrentResource(org.apache.velocity.runtime.resource.Resource r)</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="196" href="#196">196</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCurrentResource( Resource r ) |
| <a name="197" href="#197">197</a> { |
| <a name="198" href="#198">198</a> innerContext.setCurrentResource(r); |
| <a name="199" href="#199">199</a> } |
| <a name="200" href="#200">200</a> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#getCurrentResource()</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="204" href="#204">204</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</a> getCurrentResource() |
| <a name="205" href="#205">205</a> { |
| <a name="206" href="#206">206</a> <strong class="jxr_keyword">return</strong> innerContext.getCurrentResource(); |
| <a name="207" href="#207">207</a> } |
| <a name="208" href="#208">208</a> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#getBaseContext()</em> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="212" href="#212">212</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> getBaseContext() |
| <a name="213" href="#213">213</a> { |
| <a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> innerContext.getBaseContext(); |
| <a name="215" href="#215">215</a> } |
| <a name="216" href="#216">216</a> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#getInternalUserContext()</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="220" href="#220">220</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/velocity/context/Context.html">Context</a> getInternalUserContext() |
| <a name="221" href="#221">221</a> { |
| <a name="222" href="#222">222</a> <strong class="jxr_keyword">return</strong> innerContext.getInternalUserContext(); |
| <a name="223" href="#223">223</a> } |
| <a name="224" href="#224">224</a> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#attachEventCartridge(org.apache.velocity.app.event.EventCartridge ec)</em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="228" href="#228">228</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</a> attachEventCartridge(<a href="../../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</a> ec) |
| <a name="229" href="#229">229</a> { |
| <a name="230" href="#230">230</a> <a href="../../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</a> cartridge = innerContext.attachEventCartridge( ec ); |
| <a name="231" href="#231">231</a> |
| <a name="232" href="#232">232</a> <strong class="jxr_keyword">return</strong> cartridge; |
| <a name="233" href="#233">233</a> } |
| <a name="234" href="#234">234</a> |
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#getEventCartridge()</em> |
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</a> getEventCartridge() |
| <a name="239" href="#239">239</a> { |
| <a name="240" href="#240">240</a> <strong class="jxr_keyword">return</strong> innerContext.getEventCartridge(); |
| <a name="241" href="#241">241</a> } |
| <a name="242" href="#242">242</a> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#getAllowRendering()</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="246" href="#246">246</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getAllowRendering() |
| <a name="247" href="#247">247</a> { |
| <a name="248" href="#248">248</a> <strong class="jxr_keyword">return</strong> innerContext.getAllowRendering(); |
| <a name="249" href="#249">249</a> } |
| <a name="250" href="#250">250</a> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalContextAdapter#setAllowRendering(boolean v)</em> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="254" href="#254">254</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAllowRendering(<strong class="jxr_keyword">boolean</strong> v) |
| <a name="255" href="#255">255</a> { |
| <a name="256" href="#256">256</a> innerContext.setAllowRendering(v); |
| <a name="257" href="#257">257</a> } |
| <a name="258" href="#258">258</a> |
| <a name="259" href="#259">259</a> } |
| <a name="260" href="#260">260</a> |
| <a name="261" href="#261">261</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * Return name of this directive.</em> |
| <a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * @return The name of this directive.</em> |
| <a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="265" href="#265">265</a> <strong class="jxr_keyword">public</strong> String getName() |
| <a name="266" href="#266">266</a> { |
| <a name="267" href="#267">267</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"foreach"</span>; |
| <a name="268" href="#268">268</a> } |
| <a name="269" href="#269">269</a> |
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * Return type of this directive.</em> |
| <a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @return The type of this directive.</em> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="274" href="#274">274</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getType() |
| <a name="275" href="#275">275</a> { |
| <a name="276" href="#276">276</a> <strong class="jxr_keyword">return</strong> BLOCK; |
| <a name="277" href="#277">277</a> } |
| <a name="278" href="#278">278</a> |
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * The name of the variable to use when placing</em> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * the counter value into the context. Right</em> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * now the default is $velocityCount.</em> |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="284" href="#284">284</a> <strong class="jxr_keyword">private</strong> String counterName; |
| <a name="285" href="#285">285</a> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * What value to start the loop counter at.</em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="289" href="#289">289</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> counterInitialValue; |
| <a name="290" href="#290">290</a> |
| <a name="291" href="#291">291</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="292" href="#292">292</a> <em class="jxr_javadoccomment"> * The maximum number of times we're allowed to loop.</em> |
| <a name="293" href="#293">293</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="294" href="#294">294</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxNbrLoops; |
| <a name="295" href="#295">295</a> |
| <a name="296" href="#296">296</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * The reference name used to access each</em> |
| <a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * of the elements in the list object. It</em> |
| <a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * is the $item in the following:</em> |
| <a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> * #foreach ($item in $list)</em> |
| <a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="303" href="#303">303</a> <em class="jxr_javadoccomment"> * This can be used class wide because</em> |
| <a name="304" href="#304">304</a> <em class="jxr_javadoccomment"> * it is immutable.</em> |
| <a name="305" href="#305">305</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="306" href="#306">306</a> <strong class="jxr_keyword">private</strong> String elementKey; |
| <a name="307" href="#307">307</a> |
| <a name="308" href="#308">308</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * immutable, so create in init</em> |
| <a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="311" href="#311">311</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/velocity/util/introspection/Info.html">Info</a> uberInfo; |
| <a name="312" href="#312">312</a> |
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * simple init - init the tree and get the elementKey from</em> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * the AST</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * @param rs</em> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * @param context</em> |
| <a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * @param node</em> |
| <a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> * @throws TemplateInitException</em> |
| <a name="320" href="#320">320</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="321" href="#321">321</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(<a href="../../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rs, <a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> context, <a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> node) |
| <a name="322" href="#322">322</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/velocity/exception/TemplateInitException.html">TemplateInitException</a> |
| <a name="323" href="#323">323</a> { |
| <a name="324" href="#324">324</a> <strong class="jxr_keyword">super</strong>.init(rs, context, node); |
| <a name="325" href="#325">325</a> |
| <a name="326" href="#326">326</a> counterName = rsvc.getString(RuntimeConstants.COUNTER_NAME); |
| <a name="327" href="#327">327</a> counterInitialValue = rsvc.getInt(RuntimeConstants.COUNTER_INITIAL_VALUE); |
| <a name="328" href="#328">328</a> maxNbrLoops = rsvc.getInt(RuntimeConstants.MAX_NUMBER_LOOPS, |
| <a name="329" href="#329">329</a> Integer.MAX_VALUE); |
| <a name="330" href="#330">330</a> <strong class="jxr_keyword">if</strong> (maxNbrLoops < 1) |
| <a name="331" href="#331">331</a> { |
| <a name="332" href="#332">332</a> maxNbrLoops = Integer.MAX_VALUE; |
| <a name="333" href="#333">333</a> } |
| <a name="334" href="#334">334</a> |
| <a name="335" href="#335">335</a> <em class="jxr_comment">/*</em> |
| <a name="336" href="#336">336</a> <em class="jxr_comment"> * this is really the only thing we can do here as everything</em> |
| <a name="337" href="#337">337</a> <em class="jxr_comment"> * else is context sensitive</em> |
| <a name="338" href="#338">338</a> <em class="jxr_comment"> */</em> |
| <a name="339" href="#339">339</a> |
| <a name="340" href="#340">340</a> <a href="../../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> sn = (SimpleNode) node.jjtGetChild(0); |
| <a name="341" href="#341">341</a> |
| <a name="342" href="#342">342</a> <strong class="jxr_keyword">if</strong> (sn instanceof ASTReference) |
| <a name="343" href="#343">343</a> { |
| <a name="344" href="#344">344</a> elementKey = ((ASTReference) sn).getRootString(); |
| <a name="345" href="#345">345</a> } |
| <a name="346" href="#346">346</a> <strong class="jxr_keyword">else</strong> |
| <a name="347" href="#347">347</a> { |
| <a name="348" href="#348">348</a> <em class="jxr_comment">/*</em> |
| <a name="349" href="#349">349</a> <em class="jxr_comment"> * the default, error-prone way which we'll remove</em> |
| <a name="350" href="#350">350</a> <em class="jxr_comment"> * TODO : remove if all goes well</em> |
| <a name="351" href="#351">351</a> <em class="jxr_comment"> */</em> |
| <a name="352" href="#352">352</a> elementKey = sn.getFirstToken().image.substring(1); |
| <a name="353" href="#353">353</a> } |
| <a name="354" href="#354">354</a> |
| <a name="355" href="#355">355</a> <em class="jxr_comment">/*</em> |
| <a name="356" href="#356">356</a> <em class="jxr_comment"> * make an uberinfo - saves new's later on</em> |
| <a name="357" href="#357">357</a> <em class="jxr_comment"> */</em> |
| <a name="358" href="#358">358</a> |
| <a name="359" href="#359">359</a> uberInfo = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/util/introspection/Info.html">Info</a>(context.getCurrentTemplateName(), |
| <a name="360" href="#360">360</a> getLine(),getColumn()); |
| <a name="361" href="#361">361</a> } |
| <a name="362" href="#362">362</a> |
| <a name="363" href="#363">363</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="364" href="#364">364</a> <em class="jxr_javadoccomment"> * renders the #foreach() block</em> |
| <a name="365" href="#365">365</a> <em class="jxr_javadoccomment"> * @param context</em> |
| <a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> * @param writer</em> |
| <a name="367" href="#367">367</a> <em class="jxr_javadoccomment"> * @param node</em> |
| <a name="368" href="#368">368</a> <em class="jxr_javadoccomment"> * @return True if the directive rendered successfully.</em> |
| <a name="369" href="#369">369</a> <em class="jxr_javadoccomment"> * @throws IOException</em> |
| <a name="370" href="#370">370</a> <em class="jxr_javadoccomment"> * @throws MethodInvocationException</em> |
| <a name="371" href="#371">371</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException</em> |
| <a name="372" href="#372">372</a> <em class="jxr_javadoccomment"> * @throws ParseErrorException</em> |
| <a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="374" href="#374">374</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> render(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> context, |
| <a name="375" href="#375">375</a> Writer writer, <a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> node) |
| <a name="376" href="#376">376</a> <strong class="jxr_keyword">throws</strong> IOException, MethodInvocationException, ResourceNotFoundException, |
| <a name="377" href="#377">377</a> ParseErrorException |
| <a name="378" href="#378">378</a> { |
| <a name="379" href="#379">379</a> <em class="jxr_comment">/*</em> |
| <a name="380" href="#380">380</a> <em class="jxr_comment"> * do our introspection to see what our collection is</em> |
| <a name="381" href="#381">381</a> <em class="jxr_comment"> */</em> |
| <a name="382" href="#382">382</a> |
| <a name="383" href="#383">383</a> Object listObject = node.jjtGetChild(2).value(context); |
| <a name="384" href="#384">384</a> |
| <a name="385" href="#385">385</a> <strong class="jxr_keyword">if</strong> (listObject == <strong class="jxr_keyword">null</strong>) |
| <a name="386" href="#386">386</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="387" href="#387">387</a> |
| <a name="388" href="#388">388</a> Iterator i = <strong class="jxr_keyword">null</strong>; |
| <a name="389" href="#389">389</a> |
| <a name="390" href="#390">390</a> <strong class="jxr_keyword">try</strong> |
| <a name="391" href="#391">391</a> { |
| <a name="392" href="#392">392</a> i = rsvc.getUberspect().getIterator(listObject, uberInfo); |
| <a name="393" href="#393">393</a> } |
| <a name="394" href="#394">394</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * pass through application level runtime exceptions</em> |
| <a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="397" href="#397">397</a> <strong class="jxr_keyword">catch</strong>( RuntimeException e ) |
| <a name="398" href="#398">398</a> { |
| <a name="399" href="#399">399</a> <strong class="jxr_keyword">throw</strong> e; |
| <a name="400" href="#400">400</a> } |
| <a name="401" href="#401">401</a> <strong class="jxr_keyword">catch</strong>(Exception ee) |
| <a name="402" href="#402">402</a> { |
| <a name="403" href="#403">403</a> rsvc.getLog().error(<span class="jxr_string">"Error getting iterator for #foreach"</span>, ee); |
| <a name="404" href="#404">404</a> } |
| <a name="405" href="#405">405</a> |
| <a name="406" href="#406">406</a> <strong class="jxr_keyword">if</strong> (i == <strong class="jxr_keyword">null</strong>) |
| <a name="407" href="#407">407</a> { |
| <a name="408" href="#408">408</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="409" href="#409">409</a> } |
| <a name="410" href="#410">410</a> |
| <a name="411" href="#411">411</a> <strong class="jxr_keyword">int</strong> counter = counterInitialValue; |
| <a name="412" href="#412">412</a> <strong class="jxr_keyword">boolean</strong> maxNbrLoopsExceeded = false; |
| <a name="413" href="#413">413</a> |
| <a name="414" href="#414">414</a> <em class="jxr_comment">/*</em> |
| <a name="415" href="#415">415</a> <em class="jxr_comment"> * save the element key if there is one, and the loop counter</em> |
| <a name="416" href="#416">416</a> <em class="jxr_comment"> */</em> |
| <a name="417" href="#417">417</a> Object o = context.get(elementKey); |
| <a name="418" href="#418">418</a> Object savedCounter = context.get(counterName); |
| <a name="419" href="#419">419</a> |
| <a name="420" href="#420">420</a> <em class="jxr_comment">/*</em> |
| <a name="421" href="#421">421</a> <em class="jxr_comment"> * Instantiate the null holder context if a null value</em> |
| <a name="422" href="#422">422</a> <em class="jxr_comment"> * is returned by the foreach iterator. Only one instance is</em> |
| <a name="423" href="#423">423</a> <em class="jxr_comment"> * created - it's reused for every null value.</em> |
| <a name="424" href="#424">424</a> <em class="jxr_comment"> */</em> |
| <a name="425" href="#425">425</a> <a href="../../../../../org/apache/velocity/runtime/directive/Foreach.html">NullHolderContext</a> nullHolderContext = <strong class="jxr_keyword">null</strong>; |
| <a name="426" href="#426">426</a> |
| <a name="427" href="#427">427</a> <strong class="jxr_keyword">while</strong> (!maxNbrLoopsExceeded && i.hasNext()) |
| <a name="428" href="#428">428</a> { |
| <a name="429" href="#429">429</a> <em class="jxr_comment">// TODO: JDK 1.4+ -> valueOf()</em> |
| <a name="430" href="#430">430</a> context.localPut(counterName , <strong class="jxr_keyword">new</strong> Integer(counter)); |
| <a name="431" href="#431">431</a> Object value = i.next(); |
| <a name="432" href="#432">432</a> context.localPut(elementKey, value); |
| <a name="433" href="#433">433</a> |
| <a name="434" href="#434">434</a> <em class="jxr_comment">/*</em> |
| <a name="435" href="#435">435</a> <em class="jxr_comment"> * If the value is null, use the special null holder context</em> |
| <a name="436" href="#436">436</a> <em class="jxr_comment"> */</em> |
| <a name="437" href="#437">437</a> <strong class="jxr_keyword">if</strong>( value == <strong class="jxr_keyword">null</strong> ) |
| <a name="438" href="#438">438</a> { |
| <a name="439" href="#439">439</a> <strong class="jxr_keyword">if</strong>( nullHolderContext == <strong class="jxr_keyword">null</strong> ) |
| <a name="440" href="#440">440</a> { |
| <a name="441" href="#441">441</a> <em class="jxr_comment">// lazy instantiation</em> |
| <a name="442" href="#442">442</a> nullHolderContext = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/runtime/directive/Foreach.html">NullHolderContext</a>(elementKey, context); |
| <a name="443" href="#443">443</a> } |
| <a name="444" href="#444">444</a> node.jjtGetChild(3).render(nullHolderContext, writer); |
| <a name="445" href="#445">445</a> } |
| <a name="446" href="#446">446</a> <strong class="jxr_keyword">else</strong> |
| <a name="447" href="#447">447</a> { |
| <a name="448" href="#448">448</a> node.jjtGetChild(3).render(context, writer); |
| <a name="449" href="#449">449</a> } |
| <a name="450" href="#450">450</a> counter++; |
| <a name="451" href="#451">451</a> |
| <a name="452" href="#452">452</a> <em class="jxr_comment">// Determine whether we're allowed to continue looping.</em> |
| <a name="453" href="#453">453</a> <em class="jxr_comment">// ASSUMPTION: counterInitialValue is not negative!</em> |
| <a name="454" href="#454">454</a> maxNbrLoopsExceeded = (counter - counterInitialValue) >= maxNbrLoops; |
| <a name="455" href="#455">455</a> } |
| <a name="456" href="#456">456</a> |
| <a name="457" href="#457">457</a> <em class="jxr_comment">/*</em> |
| <a name="458" href="#458">458</a> <em class="jxr_comment"> * restores the loop counter (if we were nested)</em> |
| <a name="459" href="#459">459</a> <em class="jxr_comment"> * if we have one, else just removes</em> |
| <a name="460" href="#460">460</a> <em class="jxr_comment"> */</em> |
| <a name="461" href="#461">461</a> |
| <a name="462" href="#462">462</a> <strong class="jxr_keyword">if</strong> (savedCounter != <strong class="jxr_keyword">null</strong>) |
| <a name="463" href="#463">463</a> { |
| <a name="464" href="#464">464</a> context.put(counterName, savedCounter); |
| <a name="465" href="#465">465</a> } |
| <a name="466" href="#466">466</a> <strong class="jxr_keyword">else</strong> |
| <a name="467" href="#467">467</a> { |
| <a name="468" href="#468">468</a> context.remove(counterName); |
| <a name="469" href="#469">469</a> } |
| <a name="470" href="#470">470</a> |
| <a name="471" href="#471">471</a> |
| <a name="472" href="#472">472</a> <em class="jxr_comment">/*</em> |
| <a name="473" href="#473">473</a> <em class="jxr_comment"> * restores element key if exists</em> |
| <a name="474" href="#474">474</a> <em class="jxr_comment"> * otherwise just removes</em> |
| <a name="475" href="#475">475</a> <em class="jxr_comment"> */</em> |
| <a name="476" href="#476">476</a> |
| <a name="477" href="#477">477</a> <strong class="jxr_keyword">if</strong> (o != <strong class="jxr_keyword">null</strong>) |
| <a name="478" href="#478">478</a> { |
| <a name="479" href="#479">479</a> context.put(elementKey, o); |
| <a name="480" href="#480">480</a> } |
| <a name="481" href="#481">481</a> <strong class="jxr_keyword">else</strong> |
| <a name="482" href="#482">482</a> { |
| <a name="483" href="#483">483</a> context.remove(elementKey); |
| <a name="484" href="#484">484</a> } |
| <a name="485" href="#485">485</a> |
| <a name="486" href="#486">486</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="487" href="#487">487</a> } |
| <a name="488" href="#488">488</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
