| <!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>EvaluateContext xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/velocity/context/EvaluateContext.html">View Javadoc</a></div><pre> |
|
|
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.context;
|
| <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.util.HashSet;
|
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Set;
|
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.List;
|
| <a name="25" href="#25">25</a>
|
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.VelocityContext;
|
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.EventCartridge;
|
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeConstants;
|
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeServices;
|
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.Resource;
|
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ClassUtils;
|
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.IntrospectionCacheData;
|
| <a name="33" href="#33">33</a>
|
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * This is a special, internal-use-only context implementation to be</em>
|
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * used for the #evaluate directive.</em>
|
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * We use this context to chain the existing context, preventing any changes</em>
|
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * from impacting the parent context. By separating this context into a </em>
|
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * separate class it also allows for the future possibility of changing</em>
|
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * the context behavior for the #evaluate directive.</em>
|
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * Note that the context used to store values local to #evaluate()</em>
|
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * is user defined but defaults to {@link VelocityContext}.</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:wglass@forio.com" target="alexandria_uri">mailto:wglass@forio.com</a>">Will Glass-Husain</a></em>
|
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @version $Id: EvaluateContext.java 691519 2008-09-03 05:36:11Z nbubna $</em>
|
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/velocity/context/EvaluateContext.html">EvaluateContext</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/velocity/context/ChainedInternalContextAdapter.html">ChainedInternalContextAdapter</a>
|
| <a name="51" href="#51">51</a> {
|
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> container for any local items */</em>
|
| <a name="53" href="#53">53</a> <a href="../../../../org/apache/velocity/context/Context.html">Context</a> localContext;
|
| <a name="54" href="#54">54</a> <strong class="jxr_keyword">boolean</strong> allowRendering = <strong class="jxr_keyword">true</strong>;
|
| <a name="55" href="#55">55</a>
|
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * CTOR, wraps an ICA</em>
|
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @param inner context for parent template</em>
|
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @param rsvc </em>
|
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/context/EvaluateContext.html">EvaluateContext</a>( InternalContextAdapter <strong class="jxr_keyword">inner</strong>, RuntimeServices rsvc )
|
| <a name="62" href="#62">62</a> {
|
| <a name="63" href="#63">63</a> <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">inner</strong>);
|
| <a name="64" href="#64">64</a> initContext(rsvc);
|
| <a name="65" href="#65">65</a> }
|
| <a name="66" href="#66">66</a>
|
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Initialize the context based on user-configured class </em>
|
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @param rsvc</em>
|
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initContext( RuntimeServices rsvc )
|
| <a name="72" href="#72">72</a> {
|
| <a name="73" href="#73">73</a> String contextClass = rsvc.getString(RuntimeConstants.EVALUATE_CONTEXT_CLASS);
|
| <a name="74" href="#74">74</a>
|
| <a name="75" href="#75">75</a> <strong class="jxr_keyword">if</strong> (contextClass != <strong class="jxr_keyword">null</strong> && contextClass.length() > 0)
|
| <a name="76" href="#76">76</a> {
|
| <a name="77" href="#77">77</a> Object o = <strong class="jxr_keyword">null</strong>;
|
| <a name="78" href="#78">78</a>
|
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">try</strong>
|
| <a name="80" href="#80">80</a> {
|
| <a name="81" href="#81">81</a> o = ClassUtils.getNewInstance( contextClass );
|
| <a name="82" href="#82">82</a> }
|
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">catch</strong> (ClassNotFoundException cnfe)
|
| <a name="84" href="#84">84</a> {
|
| <a name="85" href="#85">85</a> String err = <span class="jxr_string">"The specified class for #evaluate() context ("</span> + contextClass
|
| <a name="86" href="#86">86</a> + <span class="jxr_string">") does not exist or is not accessible to the current classloader."</span>;
|
| <a name="87" href="#87">87</a> rsvc.getLog().error(err);
|
| <a name="88" href="#88">88</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(err,cnfe);
|
| <a name="89" href="#89">89</a> }
|
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">catch</strong> (Exception e)
|
| <a name="91" href="#91">91</a> {
|
| <a name="92" href="#92">92</a> String err = <span class="jxr_string">"The specified class for #evaluate() context ("</span> + contextClass
|
| <a name="93" href="#93">93</a> + <span class="jxr_string">") can not be loaded."</span>;
|
| <a name="94" href="#94">94</a> rsvc.getLog().error(err,e);
|
| <a name="95" href="#95">95</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(err);
|
| <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">if</strong> (!(o instanceof Context))
|
| <a name="99" href="#99">99</a> {
|
| <a name="100" href="#100">100</a> String err = <span class="jxr_string">"The specified class for #evaluate() context ("</span> + contextClass
|
| <a name="101" href="#101">101</a> + <span class="jxr_string">") does not implement "</span> + Context.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"."</span>;
|
| <a name="102" href="#102">102</a> rsvc.getLog().error(err);
|
| <a name="103" href="#103">103</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(err);
|
| <a name="104" href="#104">104</a> }
|
| <a name="105" href="#105">105</a>
|
| <a name="106" href="#106">106</a> localContext = (Context) o;
|
| <a name="107" href="#107">107</a>
|
| <a name="108" href="#108">108</a> }
|
| <a name="109" href="#109">109</a> <strong class="jxr_keyword">else</strong>
|
| <a name="110" href="#110">110</a> {
|
| <a name="111" href="#111">111</a> String err = <span class="jxr_string">"No class specified for #evaluate() context."</span>;
|
| <a name="112" href="#112">112</a> rsvc.getLog().error(err);
|
| <a name="113" href="#113">113</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(err);
|
| <a name="114" href="#114">114</a> }
|
| <a name="115" href="#115">115</a>
|
| <a name="116" href="#116">116</a> }
|
| <a name="117" href="#117">117</a>
|
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Put method also stores values in local scope </em>
|
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param key name of item to set</em>
|
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @param value object to set to key</em>
|
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @return old stored object</em>
|
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="125" href="#125">125</a> <strong class="jxr_keyword">public</strong> Object put(String key, Object value)
|
| <a name="126" href="#126">126</a> {
|
| <a name="127" href="#127">127</a> <em class="jxr_comment">/*</em>
|
| <a name="128" href="#128">128</a> <em class="jxr_comment"> * just put in the local context</em>
|
| <a name="129" href="#129">129</a> <em class="jxr_comment"> */</em>
|
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">return</strong> localContext.put(key, value);
|
| <a name="131" href="#131">131</a>
|
| <a name="132" href="#132">132</a> }
|
| <a name="133" href="#133">133</a>
|
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * Retrieves from local or global context.</em>
|
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @param key name of item to get</em>
|
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * @return stored object or null</em>
|
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="140" href="#140">140</a> <strong class="jxr_keyword">public</strong> Object get( String key )
|
| <a name="141" href="#141">141</a> {
|
| <a name="142" href="#142">142</a> <em class="jxr_comment">/*</em>
|
| <a name="143" href="#143">143</a> <em class="jxr_comment"> * always try the local context then innerContext</em>
|
| <a name="144" href="#144">144</a> <em class="jxr_comment"> */</em>
|
| <a name="145" href="#145">145</a>
|
| <a name="146" href="#146">146</a> Object o = localContext.get( key );
|
| <a name="147" href="#147">147</a>
|
| <a name="148" href="#148">148</a> <strong class="jxr_keyword">if</strong> ( o == <strong class="jxr_keyword">null</strong>)
|
| <a name="149" href="#149">149</a> {
|
| <a name="150" href="#150">150</a> o = <strong class="jxr_keyword">super</strong>.get( key );
|
| <a name="151" href="#151">151</a> }
|
| <a name="152" href="#152">152</a>
|
| <a name="153" href="#153">153</a> <strong class="jxr_keyword">return</strong> o;
|
| <a name="154" href="#154">154</a> }
|
| <a name="155" href="#155">155</a>
|
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.Context#containsKey(java.lang.Object)</em>
|
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="159" href="#159">159</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> containsKey(Object key)
|
| <a name="160" href="#160">160</a> {
|
| <a name="161" href="#161">161</a> <strong class="jxr_keyword">return</strong> localContext.containsKey(key) || <strong class="jxr_keyword">super</strong>.containsKey(key);
|
| <a name="162" href="#162">162</a> }
|
| <a name="163" href="#163">163</a>
|
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.Context#getKeys()</em>
|
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="167" href="#167">167</a> <strong class="jxr_keyword">public</strong> Object[] getKeys()
|
| <a name="168" href="#168">168</a> {
|
| <a name="169" href="#169">169</a> Set keys = <strong class="jxr_keyword">new</strong> HashSet();
|
| <a name="170" href="#170">170</a> Object[] localKeys = localContext.getKeys();
|
| <a name="171" href="#171">171</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i=0; i < localKeys.length; i++)
|
| <a name="172" href="#172">172</a> {
|
| <a name="173" href="#173">173</a> keys.add(localKeys[i]);
|
| <a name="174" href="#174">174</a> }
|
| <a name="175" href="#175">175</a>
|
| <a name="176" href="#176">176</a> Object[] innerKeys = <strong class="jxr_keyword">super</strong>.getKeys();
|
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i=0; i < innerKeys.length; i++)
|
| <a name="178" href="#178">178</a> {
|
| <a name="179" href="#179">179</a> keys.add(innerKeys[i]);
|
| <a name="180" href="#180">180</a> }
|
| <a name="181" href="#181">181</a> <strong class="jxr_keyword">return</strong> keys.toArray();
|
| <a name="182" href="#182">182</a> }
|
| <a name="183" href="#183">183</a>
|
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.Context#remove(java.lang.Object)</em>
|
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="187" href="#187">187</a> <strong class="jxr_keyword">public</strong> Object remove(Object key)
|
| <a name="188" href="#188">188</a> {
|
| <a name="189" href="#189">189</a> <strong class="jxr_keyword">return</strong> localContext.remove( key );
|
| <a name="190" href="#190">190</a> }
|
| <a name="191" href="#191">191</a>
|
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * Allows callers to explicitly put objects in the local context.</em>
|
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * Objects added to the context through this method always end up</em>
|
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * in the top-level context of possible wrapped contexts.</em>
|
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * @param key name of item to set.</em>
|
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * @param value object to set to key.</em>
|
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * @return old stored object</em>
|
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="201" href="#201">201</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="202" href="#202">202</a> {
|
| <a name="203" href="#203">203</a> <strong class="jxr_keyword">return</strong> localContext.put(key, value);
|
| <a name="204" href="#204">204</a> }
|
| <a name="205" href="#205">205</a>
|
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalHousekeepingContext#getAllowRendering()</em>
|
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="209" href="#209">209</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getAllowRendering()
|
| <a name="210" href="#210">210</a> {
|
| <a name="211" href="#211">211</a> <strong class="jxr_keyword">return</strong> allowRendering && innerContext.getAllowRendering();
|
| <a name="212" href="#212">212</a> }
|
| <a name="213" href="#213">213</a>
|
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.InternalHousekeepingContext#setAllowRendering(boolean)</em>
|
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="217" href="#217">217</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAllowRendering(<strong class="jxr_keyword">boolean</strong> v)
|
| <a name="218" href="#218">218</a> {
|
| <a name="219" href="#219">219</a> allowRendering = false;
|
| <a name="220" href="#220">220</a> }
|
| <a name="221" href="#221">221</a>
|
| <a name="222" href="#222">222</a> }
|
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
|
|
