Sophie

Sophie

distrib > Mageia > 6 > i586 > by-pkgid > 7b6fbeb5bb1ddcee15f256a4dc55a3df > files > 305

dom4j-manual-1.6.1-28.mga6.noarch.rpm

<!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>XPath xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/dom4j/XPath.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="3" href="#3">3</a>   <em class="comment"> *</em>
<a name="4" href="#4">4</a>   <em class="comment"> * This software is open source.</em>
<a name="5" href="#5">5</a>   <em class="comment"> * See the bottom of this file for the licence.</em>
<a name="6" href="#6">6</a>   <em class="comment"> */</em>
<a name="7" href="#7">7</a>   
<a name="8" href="#8">8</a>   <strong>package</strong> <a href="../../org/dom4j/package-summary.html">org.dom4j</a>;
<a name="9" href="#9">9</a>   
<a name="10" href="#10">10</a>  <strong>import</strong> java.util.List;
<a name="11" href="#11">11</a>  <strong>import</strong> java.util.Map;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <strong>import</strong> org.jaxen.FunctionContext;
<a name="14" href="#14">14</a>  <strong>import</strong> org.jaxen.NamespaceContext;
<a name="15" href="#15">15</a>  <strong>import</strong> org.jaxen.VariableContext;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <em>/**<em>*</em></em>
<a name="18" href="#18">18</a>  <em> * &lt;p></em>
<a name="19" href="#19">19</a>  <em> * &lt;code>XPath&lt;/code> represents an XPath expression after it has been parsed</em>
<a name="20" href="#20">20</a>  <em> * from a String.</em>
<a name="21" href="#21">21</a>  <em> * &lt;/p></em>
<a name="22" href="#22">22</a>  <em> * </em>
<a name="23" href="#23">23</a>  <em> * @author &lt;a href="<a href="mailto:james.strachan@metastuff.com" target="alexandria_uri">mailto:james.strachan@metastuff.com</a>">James Strachan &lt;/a></em>
<a name="24" href="#24">24</a>  <em> * @version $Revision: 1.20 $</em>
<a name="25" href="#25">25</a>  <em> */</em>
<a name="26" href="#26">26</a>  <strong>public</strong> <strong>interface</strong> <a href="../../org/dom4j/XPath.html">XPath</a> <strong>extends</strong> <a href="../../org/dom4j/NodeFilter.html">NodeFilter</a> {
<a name="27" href="#27">27</a>      <em>/**<em>*</em></em>
<a name="28" href="#28">28</a>  <em>     * &lt;p></em>
<a name="29" href="#29">29</a>  <em>     * &lt;code>getText&lt;/code> will return the textual version of the XPath</em>
<a name="30" href="#30">30</a>  <em>     * expression.</em>
<a name="31" href="#31">31</a>  <em>     * &lt;/p></em>
<a name="32" href="#32">32</a>  <em>     * </em>
<a name="33" href="#33">33</a>  <em>     * @return the textual format of the XPath expression.</em>
<a name="34" href="#34">34</a>  <em>     */</em>
<a name="35" href="#35">35</a>      String getText();
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>      <em>/**<em>*</em></em>
<a name="38" href="#38">38</a>  <em>     * &lt;p></em>
<a name="39" href="#39">39</a>  <em>     * &lt;code>matches&lt;/code> returns true if the given node matches the XPath</em>
<a name="40" href="#40">40</a>  <em>     * expression. To be more precise when evaluating this XPath expression on</em>
<a name="41" href="#41">41</a>  <em>     * the given node the result set must include the node.</em>
<a name="42" href="#42">42</a>  <em>     * &lt;/p></em>
<a name="43" href="#43">43</a>  <em>     * </em>
<a name="44" href="#44">44</a>  <em>     * @param node</em>
<a name="45" href="#45">45</a>  <em>     *            DOCUMENT ME!</em>
<a name="46" href="#46">46</a>  <em>     * </em>
<a name="47" href="#47">47</a>  <em>     * @return true if the given node matches this XPath expression</em>
<a name="48" href="#48">48</a>  <em>     */</em>
<a name="49" href="#49">49</a>      <strong>boolean</strong> matches(<a href="../../org/dom4j/Node.html">Node</a> node);
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>      <em>/**<em>*</em></em>
<a name="52" href="#52">52</a>  <em>     * &lt;p></em>
<a name="53" href="#53">53</a>  <em>     * &lt;code>evaluate&lt;/code> evaluates an XPath expression and returns the</em>
<a name="54" href="#54">54</a>  <em>     * result as an {@link Object}. The object returned can either be a {@link</em>
<a name="55" href="#55">55</a>  <em>     * List} of {@link Node}instances, a {@link Node}instance, a {@link</em>
<a name="56" href="#56">56</a>  <em>     * String} or a {@link Number}instance depending on the XPath expression.</em>
<a name="57" href="#57">57</a>  <em>     * &lt;/p></em>
<a name="58" href="#58">58</a>  <em>     * </em>
<a name="59" href="#59">59</a>  <em>     * @param context</em>
<a name="60" href="#60">60</a>  <em>     *            is either a node or a list of nodes on which to evalute the</em>
<a name="61" href="#61">61</a>  <em>     *            XPath</em>
<a name="62" href="#62">62</a>  <em>     * </em>
<a name="63" href="#63">63</a>  <em>     * @return the value of the XPath expression as a {@link List}of {@link</em>
<a name="64" href="#64">64</a>  <em>     *         Node} instances, a {@link Node}instance, a {@link String}or a</em>
<a name="65" href="#65">65</a>  <em>     *         {@link Number}instance depending on the XPath expression.</em>
<a name="66" href="#66">66</a>  <em>     */</em>
<a name="67" href="#67">67</a>      Object evaluate(Object context);
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <em>/**<em>*</em></em>
<a name="70" href="#70">70</a>  <em>     * &lt;p></em>
<a name="71" href="#71">71</a>  <em>     * &lt;code>selectObject&lt;/code> evaluates an XPath expression and returns the</em>
<a name="72" href="#72">72</a>  <em>     * result as an {@link Object}. The object returned can either be a {@link</em>
<a name="73" href="#73">73</a>  <em>     * List} of {@link Node}instances, a {@link Node}instance, a {@link</em>
<a name="74" href="#74">74</a>  <em>     * String} or a {@link Number}instance depending on the XPath expression.</em>
<a name="75" href="#75">75</a>  <em>     * &lt;/p></em>
<a name="76" href="#76">76</a>  <em>     * </em>
<a name="77" href="#77">77</a>  <em>     * @param context</em>
<a name="78" href="#78">78</a>  <em>     *            is either a node or a list of nodes on which to evalute the</em>
<a name="79" href="#79">79</a>  <em>     *            XPath</em>
<a name="80" href="#80">80</a>  <em>     * </em>
<a name="81" href="#81">81</a>  <em>     * @return the value of the XPath expression as a {@link List}of {@link</em>
<a name="82" href="#82">82</a>  <em>     *         Node} instances, a {@link Node}instance, a {@link String}or a</em>
<a name="83" href="#83">83</a>  <em>     *         {@link Number}instance depending on the XPath expression.</em>
<a name="84" href="#84">84</a>  <em>     * </em>
<a name="85" href="#85">85</a>  <em>     * @deprecated please use evaluate(Object) instead. WILL BE REMOVED IN</em>
<a name="86" href="#86">86</a>  <em>     *             dom4j-1.6 !!</em>
<a name="87" href="#87">87</a>  <em>     */</em>
<a name="88" href="#88">88</a>      Object selectObject(Object context);
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>      <em>/**<em>*</em></em>
<a name="91" href="#91">91</a>  <em>     * &lt;p></em>
<a name="92" href="#92">92</a>  <em>     * &lt;code>selectNodes&lt;/code> performs this XPath expression on the given</em>
<a name="93" href="#93">93</a>  <em>     * {@link Node}or {@link List}of {@link Node}s instances appending all</em>
<a name="94" href="#94">94</a>  <em>     * the results together into a single list.</em>
<a name="95" href="#95">95</a>  <em>     * &lt;/p></em>
<a name="96" href="#96">96</a>  <em>     * </em>
<a name="97" href="#97">97</a>  <em>     * @param context</em>
<a name="98" href="#98">98</a>  <em>     *            is either a node or a list of nodes on which to evalute the</em>
<a name="99" href="#99">99</a>  <em>     *            XPath</em>
<a name="100" href="#100">100</a> <em>     * </em>
<a name="101" href="#101">101</a> <em>     * @return the results of all the XPath evaluations as a single list</em>
<a name="102" href="#102">102</a> <em>     */</em>
<a name="103" href="#103">103</a>     List selectNodes(Object context);
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>     <em>/**<em>*</em></em>
<a name="106" href="#106">106</a> <em>     * &lt;p></em>
<a name="107" href="#107">107</a> <em>     * &lt;code>selectNodes&lt;/code> evaluates the XPath expression on the given</em>
<a name="108" href="#108">108</a> <em>     * {@link Node}or {@link List}of {@link Node}s and returns the result as</em>
<a name="109" href="#109">109</a> <em>     * a &lt;code>List&lt;/code> of &lt;code>Node&lt;/code> s sorted by the sort XPath</em>
<a name="110" href="#110">110</a> <em>     * expression.</em>
<a name="111" href="#111">111</a> <em>     * &lt;/p></em>
<a name="112" href="#112">112</a> <em>     * </em>
<a name="113" href="#113">113</a> <em>     * @param context</em>
<a name="114" href="#114">114</a> <em>     *            is either a node or a list of nodes on which to evalute the</em>
<a name="115" href="#115">115</a> <em>     *            XPath</em>
<a name="116" href="#116">116</a> <em>     * @param sortXPath</em>
<a name="117" href="#117">117</a> <em>     *            is the XPath expression to sort by</em>
<a name="118" href="#118">118</a> <em>     * </em>
<a name="119" href="#119">119</a> <em>     * @return a list of &lt;code>Node&lt;/code> instances</em>
<a name="120" href="#120">120</a> <em>     */</em>
<a name="121" href="#121">121</a>     List selectNodes(Object context, <a href="../../org/dom4j/XPath.html">XPath</a> sortXPath);
<a name="122" href="#122">122</a> 
<a name="123" href="#123">123</a>     <em>/**<em>*</em></em>
<a name="124" href="#124">124</a> <em>     * &lt;p></em>
<a name="125" href="#125">125</a> <em>     * &lt;code>selectNodes&lt;/code> evaluates the XPath expression on the given</em>
<a name="126" href="#126">126</a> <em>     * {@link Node}or {@link List}of {@link Node}s and returns the result as</em>
<a name="127" href="#127">127</a> <em>     * a &lt;code>List&lt;/code> of &lt;code>Node&lt;/code> s sorted by the sort XPath</em>
<a name="128" href="#128">128</a> <em>     * expression.</em>
<a name="129" href="#129">129</a> <em>     * &lt;/p></em>
<a name="130" href="#130">130</a> <em>     * </em>
<a name="131" href="#131">131</a> <em>     * @param context</em>
<a name="132" href="#132">132</a> <em>     *            is either a node or a list of nodes on which to evalute the</em>
<a name="133" href="#133">133</a> <em>     *            XPath</em>
<a name="134" href="#134">134</a> <em>     * @param sortXPath</em>
<a name="135" href="#135">135</a> <em>     *            is the XPath expression to sort by</em>
<a name="136" href="#136">136</a> <em>     * @param distinct</em>
<a name="137" href="#137">137</a> <em>     *            specifies whether or not duplicate values of the sort</em>
<a name="138" href="#138">138</a> <em>     *            expression are allowed. If this parameter is true then only</em>
<a name="139" href="#139">139</a> <em>     *            distinct sort expressions values are included in the result</em>
<a name="140" href="#140">140</a> <em>     * </em>
<a name="141" href="#141">141</a> <em>     * @return a list of &lt;code>Node&lt;/code> instances</em>
<a name="142" href="#142">142</a> <em>     */</em>
<a name="143" href="#143">143</a>     List selectNodes(Object context, <a href="../../org/dom4j/XPath.html">XPath</a> sortXPath, <strong>boolean</strong> distinct);
<a name="144" href="#144">144</a> 
<a name="145" href="#145">145</a>     <em>/**<em>*</em></em>
<a name="146" href="#146">146</a> <em>     * &lt;p></em>
<a name="147" href="#147">147</a> <em>     * &lt;code>selectSingleNode&lt;/code> evaluates this XPath expression on the</em>
<a name="148" href="#148">148</a> <em>     * given {@link Node}or {@link List}of {@link Node}s and returns the</em>
<a name="149" href="#149">149</a> <em>     * result as a single &lt;code>Node&lt;/code> instance.</em>
<a name="150" href="#150">150</a> <em>     * &lt;/p></em>
<a name="151" href="#151">151</a> <em>     * </em>
<a name="152" href="#152">152</a> <em>     * @param context</em>
<a name="153" href="#153">153</a> <em>     *            is either a node or a list of nodes on which to evalute the</em>
<a name="154" href="#154">154</a> <em>     *            XPath</em>
<a name="155" href="#155">155</a> <em>     * </em>
<a name="156" href="#156">156</a> <em>     * @return a single matching &lt;code>Node&lt;/code> instance</em>
<a name="157" href="#157">157</a> <em>     */</em>
<a name="158" href="#158">158</a>     <a href="../../org/dom4j/Node.html">Node</a> selectSingleNode(Object context);
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>     <em>/**<em>*</em></em>
<a name="161" href="#161">161</a> <em>     * &lt;p></em>
<a name="162" href="#162">162</a> <em>     * &lt;code>valueOf&lt;/code> evaluates this XPath expression and returns the</em>
<a name="163" href="#163">163</a> <em>     * textual representation of the results using the XPath string() function.</em>
<a name="164" href="#164">164</a> <em>     * &lt;/p></em>
<a name="165" href="#165">165</a> <em>     * </em>
<a name="166" href="#166">166</a> <em>     * @param context</em>
<a name="167" href="#167">167</a> <em>     *            is either a node or a list of nodes on which to evalute the</em>
<a name="168" href="#168">168</a> <em>     *            XPath</em>
<a name="169" href="#169">169</a> <em>     * </em>
<a name="170" href="#170">170</a> <em>     * @return the string representation of the results of the XPath expression</em>
<a name="171" href="#171">171</a> <em>     */</em>
<a name="172" href="#172">172</a>     String valueOf(Object context);
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>     <em>/**<em>*</em></em>
<a name="175" href="#175">175</a> <em>     * &lt;p></em>
<a name="176" href="#176">176</a> <em>     * &lt;code>numberValueOf&lt;/code> evaluates an XPath expression and returns</em>
<a name="177" href="#177">177</a> <em>     * the numeric value of the XPath expression if the XPath expression results</em>
<a name="178" href="#178">178</a> <em>     * is a number, or null if the result is not a number.</em>
<a name="179" href="#179">179</a> <em>     * &lt;/p></em>
<a name="180" href="#180">180</a> <em>     * </em>
<a name="181" href="#181">181</a> <em>     * @param context</em>
<a name="182" href="#182">182</a> <em>     *            is either a node or a list of nodes on which to evalute the</em>
<a name="183" href="#183">183</a> <em>     *            XPath</em>
<a name="184" href="#184">184</a> <em>     * </em>
<a name="185" href="#185">185</a> <em>     * @return the numeric result of the XPath expression or null if the result</em>
<a name="186" href="#186">186</a> <em>     *         is not a number.</em>
<a name="187" href="#187">187</a> <em>     */</em>
<a name="188" href="#188">188</a>     Number numberValueOf(Object context);
<a name="189" href="#189">189</a> 
<a name="190" href="#190">190</a>     <em>/**<em>*</em></em>
<a name="191" href="#191">191</a> <em>     * Retrieve a boolean-value interpretation of this XPath expression when</em>
<a name="192" href="#192">192</a> <em>     * evaluated against a given context.</em>
<a name="193" href="#193">193</a> <em>     * </em>
<a name="194" href="#194">194</a> <em>     * &lt;p></em>
<a name="195" href="#195">195</a> <em>     * The boolean-value of the expression is determined per the</em>
<a name="196" href="#196">196</a> <em>     * &lt;code>boolean(..)&lt;/code> core function as defined in the XPath</em>
<a name="197" href="#197">197</a> <em>     * specification. This means that an expression that selects zero nodes will</em>
<a name="198" href="#198">198</a> <em>     * return &lt;code>false&lt;/code>, while an expression that selects</em>
<a name="199" href="#199">199</a> <em>     * one-or-more nodes will return &lt;code>true&lt;/code>.</em>
<a name="200" href="#200">200</a> <em>     * &lt;/p></em>
<a name="201" href="#201">201</a> <em>     * </em>
<a name="202" href="#202">202</a> <em>     * @param context</em>
<a name="203" href="#203">203</a> <em>     *            The node, nodeset or Context object for evaluation. This value</em>
<a name="204" href="#204">204</a> <em>     *            can be null</em>
<a name="205" href="#205">205</a> <em>     * </em>
<a name="206" href="#206">206</a> <em>     * @return The boolean-value interpretation of this expression.</em>
<a name="207" href="#207">207</a> <em>     * </em>
<a name="208" href="#208">208</a> <em>     * @since 1.5</em>
<a name="209" href="#209">209</a> <em>     */</em>
<a name="210" href="#210">210</a>     <strong>boolean</strong> <strong>boolean</strong>ValueOf(Object context);
<a name="211" href="#211">211</a> 
<a name="212" href="#212">212</a>     <em>/**<em>*</em></em>
<a name="213" href="#213">213</a> <em>     * &lt;p></em>
<a name="214" href="#214">214</a> <em>     * &lt;code>sort&lt;/code> sorts the given List of Nodes using this XPath</em>
<a name="215" href="#215">215</a> <em>     * expression as a {@link java.util.Comparator}.</em>
<a name="216" href="#216">216</a> <em>     * &lt;/p></em>
<a name="217" href="#217">217</a> <em>     * </em>
<a name="218" href="#218">218</a> <em>     * @param list</em>
<a name="219" href="#219">219</a> <em>     *            is the list of Nodes to sort</em>
<a name="220" href="#220">220</a> <em>     */</em>
<a name="221" href="#221">221</a>     <strong>void</strong> sort(List list);
<a name="222" href="#222">222</a> 
<a name="223" href="#223">223</a>     <em>/**<em>*</em></em>
<a name="224" href="#224">224</a> <em>     * &lt;p></em>
<a name="225" href="#225">225</a> <em>     * &lt;code>sort&lt;/code> sorts the given List of Nodes using this XPath</em>
<a name="226" href="#226">226</a> <em>     * expression as a {@link java.util.Comparator}and optionally removing</em>
<a name="227" href="#227">227</a> <em>     * duplicates.</em>
<a name="228" href="#228">228</a> <em>     * &lt;/p></em>
<a name="229" href="#229">229</a> <em>     * </em>
<a name="230" href="#230">230</a> <em>     * @param list</em>
<a name="231" href="#231">231</a> <em>     *            is the list of Nodes to sort</em>
<a name="232" href="#232">232</a> <em>     * @param distinct</em>
<a name="233" href="#233">233</a> <em>     *            if true then duplicate values (using the sortXPath for</em>
<a name="234" href="#234">234</a> <em>     *            comparisions) will be removed from the List</em>
<a name="235" href="#235">235</a> <em>     */</em>
<a name="236" href="#236">236</a>     <strong>void</strong> sort(List list, <strong>boolean</strong> distinct);
<a name="237" href="#237">237</a> 
<a name="238" href="#238">238</a>     <em>/**<em>*</em></em>
<a name="239" href="#239">239</a> <em>     * DOCUMENT ME!</em>
<a name="240" href="#240">240</a> <em>     * </em>
<a name="241" href="#241">241</a> <em>     * @return the current function context</em>
<a name="242" href="#242">242</a> <em>     */</em>
<a name="243" href="#243">243</a>     FunctionContext getFunctionContext();
<a name="244" href="#244">244</a> 
<a name="245" href="#245">245</a>     <em>/**<em>*</em></em>
<a name="246" href="#246">246</a> <em>     * Sets the function context to be used when evaluating XPath expressions</em>
<a name="247" href="#247">247</a> <em>     * </em>
<a name="248" href="#248">248</a> <em>     * @param functionContext</em>
<a name="249" href="#249">249</a> <em>     *            DOCUMENT ME!</em>
<a name="250" href="#250">250</a> <em>     */</em>
<a name="251" href="#251">251</a>     <strong>void</strong> setFunctionContext(FunctionContext functionContext);
<a name="252" href="#252">252</a> 
<a name="253" href="#253">253</a>     <em>/**<em>*</em></em>
<a name="254" href="#254">254</a> <em>     * DOCUMENT ME!</em>
<a name="255" href="#255">255</a> <em>     * </em>
<a name="256" href="#256">256</a> <em>     * @return the current namespace context</em>
<a name="257" href="#257">257</a> <em>     */</em>
<a name="258" href="#258">258</a>     NamespaceContext getNamespaceContext();
<a name="259" href="#259">259</a> 
<a name="260" href="#260">260</a>     <em>/**<em>*</em></em>
<a name="261" href="#261">261</a> <em>     * Sets the namespace context to be used when evaluating XPath expressions</em>
<a name="262" href="#262">262</a> <em>     * </em>
<a name="263" href="#263">263</a> <em>     * @param namespaceContext</em>
<a name="264" href="#264">264</a> <em>     *            DOCUMENT ME!</em>
<a name="265" href="#265">265</a> <em>     */</em>
<a name="266" href="#266">266</a>     <strong>void</strong> setNamespaceContext(NamespaceContext namespaceContext);
<a name="267" href="#267">267</a> 
<a name="268" href="#268">268</a>     <em>/**<em>*</em></em>
<a name="269" href="#269">269</a> <em>     * &lt;p></em>
<a name="270" href="#270">270</a> <em>     * Sets the current NamespaceContext from a Map where the keys are the</em>
<a name="271" href="#271">271</a> <em>     * String namespace prefixes and the values are the namespace URIs.</em>
<a name="272" href="#272">272</a> <em>     * &lt;/p></em>
<a name="273" href="#273">273</a> <em>     * </em>
<a name="274" href="#274">274</a> <em>     * &lt;p></em>
<a name="275" href="#275">275</a> <em>     * For example:</em>
<a name="276" href="#276">276</a> <em>     * </em>
<a name="277" href="#277">277</a> <em>     * &lt;pre></em>
<a name="278" href="#278">278</a> <em>     * Map uris = new HashMap();</em>
<a name="279" href="#279">279</a> <em>     * uris.put("SOAP-ENV", "<a href="http://schemas.xmlsoap.org/soap/envelope/" target="alexandria_uri">http://schemas.xmlsoap.org/soap/envelope/</a>");</em>
<a name="280" href="#280">280</a> <em>     * uris.put("m", "urn:xmethodsBabelFish");</em>
<a name="281" href="#281">281</a> <em>     * XPath xpath = document</em>
<a name="282" href="#282">282</a> <em>     *         .createXPath("SOAP-ENV:Envelope/SOAP-ENV:Body/m:BabelFish");</em>
<a name="283" href="#283">283</a> <em>     * xpath.setNamespaceURIs(uris);</em>
<a name="284" href="#284">284</a> <em>     * Node babelfish = xpath.selectSingleNode(document);</em>
<a name="285" href="#285">285</a> <em>     * &lt;/pre></em>
<a name="286" href="#286">286</a> <em>     * </em>
<a name="287" href="#287">287</a> <em>     * &lt;/p></em>
<a name="288" href="#288">288</a> <em>     * </em>
<a name="289" href="#289">289</a> <em>     * @param map</em>
<a name="290" href="#290">290</a> <em>     *            the map containing the namespace mappings</em>
<a name="291" href="#291">291</a> <em>     */</em>
<a name="292" href="#292">292</a>     <strong>void</strong> setNamespaceURIs(Map map);
<a name="293" href="#293">293</a> 
<a name="294" href="#294">294</a>     <em>/**<em>*</em></em>
<a name="295" href="#295">295</a> <em>     * DOCUMENT ME!</em>
<a name="296" href="#296">296</a> <em>     * </em>
<a name="297" href="#297">297</a> <em>     * @return the current variable context</em>
<a name="298" href="#298">298</a> <em>     */</em>
<a name="299" href="#299">299</a>     VariableContext getVariableContext();
<a name="300" href="#300">300</a> 
<a name="301" href="#301">301</a>     <em>/**<em>*</em></em>
<a name="302" href="#302">302</a> <em>     * Sets the variable context to be used when evaluating XPath expressions</em>
<a name="303" href="#303">303</a> <em>     * </em>
<a name="304" href="#304">304</a> <em>     * @param variableContext</em>
<a name="305" href="#305">305</a> <em>     *            DOCUMENT ME!</em>
<a name="306" href="#306">306</a> <em>     */</em>
<a name="307" href="#307">307</a>     <strong>void</strong> setVariableContext(VariableContext variableContext);
<a name="308" href="#308">308</a> }
<a name="309" href="#309">309</a> 
<a name="310" href="#310">310</a> <em class="comment">/*</em>
<a name="311" href="#311">311</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="312" href="#312">312</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="313" href="#313">313</a> <em class="comment"> * following conditions are met:</em>
<a name="314" href="#314">314</a> <em class="comment"> * </em>
<a name="315" href="#315">315</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="316" href="#316">316</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="317" href="#317">317</a> <em class="comment"> * </em>
<a name="318" href="#318">318</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="319" href="#319">319</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="320" href="#320">320</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="321" href="#321">321</a> <em class="comment"> * </em>
<a name="322" href="#322">322</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="323" href="#323">323</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="324" href="#324">324</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="325" href="#325">325</a> <em class="comment"> * </em>
<a name="326" href="#326">326</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="327" href="#327">327</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="328" href="#328">328</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="329" href="#329">329</a> <em class="comment"> * </em>
<a name="330" href="#330">330</a> <em class="comment"> * 5. Due credit should be given to the DOM4J Project - <a href="http://www.dom4j.org" target="alexandria_uri">http://www.dom4j.org</a></em>
<a name="331" href="#331">331</a> <em class="comment"> * </em>
<a name="332" href="#332">332</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="333" href="#333">333</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="334" href="#334">334</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="335" href="#335">335</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="336" href="#336">336</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="337" href="#337">337</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="338" href="#338">338</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="339" href="#339">339</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="340" href="#340">340</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="341" href="#341">341</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="342" href="#342">342</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="343" href="#343">343</a> <em class="comment"> * </em>
<a name="344" href="#344">344</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="345" href="#345">345</a> <em class="comment"> */</em>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>