Sophie

Sophie

distrib > Mageia > 6 > armv5tl > by-pkgid > cacbe0cdc7cef785f91dc4ba8bcbc61e > files > 361

dom4j-manual-1.6.1-28.1.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>PruningElementStack xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/dom4j/io/PruningElementStack.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/io/package-summary.html">org.dom4j.io</a>;
<a name="9" href="#9">9</a>   
<a name="10" href="#10">10</a>  <strong>import</strong> org.dom4j.Element;
<a name="11" href="#11">11</a>  <strong>import</strong> org.dom4j.ElementHandler;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <em>/**<em>*</em></em>
<a name="14" href="#14">14</a>  <em> * &lt;p></em>
<a name="15" href="#15">15</a>  <em> * &lt;code>PruningElementStack&lt;/code> is a stack of {@link Element}instances</em>
<a name="16" href="#16">16</a>  <em> * which will prune the tree when a path expression is reached. This is useful</em>
<a name="17" href="#17">17</a>  <em> * for parsing very large documents where children of the root element can be</em>
<a name="18" href="#18">18</a>  <em> * processed individually rather than keeping them all in memory at the same</em>
<a name="19" href="#19">19</a>  <em> * time.</em>
<a name="20" href="#20">20</a>  <em> * &lt;/p></em>
<a name="21" href="#21">21</a>  <em> * </em>
<a name="22" href="#22">22</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="23" href="#23">23</a>  <em> * @version $Revision: 1.11 $</em>
<a name="24" href="#24">24</a>  <em> */</em>
<a name="25" href="#25">25</a>  <strong>class</strong> <a href="../../../org/dom4j/io/PruningElementStack.html">PruningElementStack</a> <strong>extends</strong> <a href="../../../org/dom4j/io/ElementStack.html">ElementStack</a> {
<a name="26" href="#26">26</a>      <em>/**<em>* <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> to call when pruning occurs */</em></em>
<a name="27" href="#27">27</a>      <strong>private</strong> <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> elementHandler;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>      <em>/**<em>*</em></em>
<a name="30" href="#30">30</a>  <em>     * the element name path which denotes the node to remove from its parent</em>
<a name="31" href="#31">31</a>  <em>     * when it is complete (i.e. when it is popped from the stack). The first</em>
<a name="32" href="#32">32</a>  <em>     * entry in the path will be a child of the root node</em>
<a name="33" href="#33">33</a>  <em>     */</em>
<a name="34" href="#34">34</a>      <strong>private</strong> String[] path;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>      <em>/**<em>*</em></em>
<a name="37" href="#37">37</a>  <em>     * The level at which a path match can occur. We match when we have popped</em>
<a name="38" href="#38">38</a>  <em>     * the selected node so the and the lastElementIndex points to its parent so</em>
<a name="39" href="#39">39</a>  <em>     * this value should be path.length - 2</em>
<a name="40" href="#40">40</a>  <em>     */</em>
<a name="41" href="#41">41</a>      <strong>private</strong> <strong>int</strong> matchingElementIndex;
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>      <strong>public</strong> <a href="../../../org/dom4j/io/PruningElementStack.html">PruningElementStack</a>(String[] path, <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> elementHandler) {
<a name="44" href="#44">44</a>          <strong>this</strong>.path = path;
<a name="45" href="#45">45</a>          <strong>this</strong>.elementHandler = elementHandler;
<a name="46" href="#46">46</a>          checkPath();
<a name="47" href="#47">47</a>      }
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>      <strong>public</strong> <a href="../../../org/dom4j/io/PruningElementStack.html">PruningElementStack</a>(String[] path, <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> elementHandler,
<a name="50" href="#50">50</a>              <strong>int</strong> defaultCapacity) {
<a name="51" href="#51">51</a>          <strong>super</strong>(defaultCapacity);
<a name="52" href="#52">52</a>          <strong>this</strong>.path = path;
<a name="53" href="#53">53</a>          <strong>this</strong>.elementHandler = elementHandler;
<a name="54" href="#54">54</a>          checkPath();
<a name="55" href="#55">55</a>      }
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>      <strong>public</strong> <a href="../../../org/dom4j/Element.html">Element</a> popElement() {
<a name="58" href="#58">58</a>          <a href="../../../org/dom4j/Element.html">Element</a> answer = <strong>super</strong>.popElement();
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>          <strong>if</strong> ((lastElementIndex == matchingElementIndex)
<a name="61" href="#61">61</a>                  &amp;&amp; (lastElementIndex >= 0)) {
<a name="62" href="#62">62</a>              <em class="comment">// we are popping the correct level in the tree</em>
<a name="63" href="#63">63</a>              <em class="comment">// lets check if the path fits</em>
<a name="64" href="#64">64</a>              <em class="comment">//</em>
<a name="65" href="#65">65</a>              <em class="comment">// NOTE: this is an inefficient way of doing it - we could</em>
<a name="66" href="#66">66</a>              <em class="comment">// maintain a history of which parts matched?</em>
<a name="67" href="#67">67</a>              <strong>if</strong> (validElement(answer, lastElementIndex + 1)) {
<a name="68" href="#68">68</a>                  <a href="../../../org/dom4j/Element.html">Element</a> parent = <strong>null</strong>;
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>                  <strong>for</strong> (<strong>int</strong> i = 0; i &lt;= lastElementIndex; i++) {
<a name="71" href="#71">71</a>                      parent = stack[i];
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>                      <strong>if</strong> (!validElement(parent, i)) {
<a name="74" href="#74">74</a>                          parent = <strong>null</strong>;
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>                          <strong>break</strong>;
<a name="77" href="#77">77</a>                      }
<a name="78" href="#78">78</a>                  }
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>                  <strong>if</strong> (parent != <strong>null</strong>) {
<a name="81" href="#81">81</a>                      pathMatches(parent, answer);
<a name="82" href="#82">82</a>                  }
<a name="83" href="#83">83</a>              }
<a name="84" href="#84">84</a>          }
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>          <strong>return</strong> answer;
<a name="87" href="#87">87</a>      }
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <strong>protected</strong> <strong>void</strong> pathMatches(<a href="../../../org/dom4j/Element.html">Element</a> parent, <a href="../../../org/dom4j/Element.html">Element</a> selectedNode) {
<a name="90" href="#90">90</a>          elementHandler.onEnd(<strong>this</strong>);
<a name="91" href="#91">91</a>          parent.remove(selectedNode);
<a name="92" href="#92">92</a>      }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <strong>protected</strong> <strong>boolean</strong> validElement(<a href="../../../org/dom4j/Element.html">Element</a> element, <strong>int</strong> index) {
<a name="95" href="#95">95</a>          String requiredName = path[index];
<a name="96" href="#96">96</a>          String name = element.getName();
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>          <strong>if</strong> (requiredName == name) {
<a name="99" href="#99">99</a>              <strong>return</strong> <strong>true</strong>;
<a name="100" href="#100">100</a>         }
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>         <strong>if</strong> ((requiredName != <strong>null</strong>) &amp;&amp; (name != <strong>null</strong>)) {
<a name="103" href="#103">103</a>             <strong>return</strong> requiredName.equals(name);
<a name="104" href="#104">104</a>         }
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>         <strong>return</strong> false;
<a name="107" href="#107">107</a>     }
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>     <strong>private</strong> <strong>void</strong> checkPath() {
<a name="110" href="#110">110</a>         <strong>if</strong> (path.length &lt; 2) {
<a name="111" href="#111">111</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Invalid path of length: "</span> + path.length
<a name="112" href="#112">112</a>                     + <span class="string">" it must be greater than 2"</span>);
<a name="113" href="#113">113</a>         }
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>         matchingElementIndex = path.length - 2;
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a> }
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a> <em class="comment">/*</em>
<a name="120" href="#120">120</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="121" href="#121">121</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="122" href="#122">122</a> <em class="comment"> * following conditions are met:</em>
<a name="123" href="#123">123</a> <em class="comment"> * </em>
<a name="124" href="#124">124</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="125" href="#125">125</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="126" href="#126">126</a> <em class="comment"> * </em>
<a name="127" href="#127">127</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="128" href="#128">128</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="129" href="#129">129</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="130" href="#130">130</a> <em class="comment"> * </em>
<a name="131" href="#131">131</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="132" href="#132">132</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="133" href="#133">133</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="134" href="#134">134</a> <em class="comment"> * </em>
<a name="135" href="#135">135</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="136" href="#136">136</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="137" href="#137">137</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="138" href="#138">138</a> <em class="comment"> * </em>
<a name="139" href="#139">139</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="140" href="#140">140</a> <em class="comment"> * </em>
<a name="141" href="#141">141</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="142" href="#142">142</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="143" href="#143">143</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="144" href="#144">144</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="145" href="#145">145</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="146" href="#146">146</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="147" href="#147">147</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="148" href="#148">148</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="149" href="#149">149</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="150" href="#150">150</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="151" href="#151">151</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="152" href="#152">152</a> <em class="comment"> * </em>
<a name="153" href="#153">153</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="154" href="#154">154</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>