Sophie

Sophie

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

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>JAXBReader xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/dom4j/jaxb/JAXBReader.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/jaxb/package-summary.html">org.dom4j.jaxb</a>;
<a name="9" href="#9">9</a>   
<a name="10" href="#10">10</a>  <strong>import</strong> java.io.File;
<a name="11" href="#11">11</a>  <strong>import</strong> java.io.FileInputStream;
<a name="12" href="#12">12</a>  <strong>import</strong> java.io.FileNotFoundException;
<a name="13" href="#13">13</a>  <strong>import</strong> java.io.InputStream;
<a name="14" href="#14">14</a>  <strong>import</strong> java.io.InputStreamReader;
<a name="15" href="#15">15</a>  <strong>import</strong> java.io.Reader;
<a name="16" href="#16">16</a>  <strong>import</strong> java.net.URL;
<a name="17" href="#17">17</a>  <strong>import</strong> java.nio.charset.Charset;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <strong>import</strong> org.dom4j.Document;
<a name="20" href="#20">20</a>  <strong>import</strong> org.dom4j.DocumentException;
<a name="21" href="#21">21</a>  <strong>import</strong> org.dom4j.Element;
<a name="22" href="#22">22</a>  <strong>import</strong> org.dom4j.ElementHandler;
<a name="23" href="#23">23</a>  <strong>import</strong> org.dom4j.ElementPath;
<a name="24" href="#24">24</a>  <strong>import</strong> org.dom4j.io.SAXReader;
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  <strong>import</strong> org.xml.sax.InputSource;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <em>/**<em>*</em></em>
<a name="29" href="#29">29</a>  <em> * Reads an XML document and creates a DOM4J tree from SAX parsing events.</em>
<a name="30" href="#30">30</a>  <em> * {@link JAXBObjectHandler}objects can be registered to automatically receive</em>
<a name="31" href="#31">31</a>  <em> * unmarshalled XML fragments. Registered {@linkorg.dom4j.ElementHandler}</em>
<a name="32" href="#32">32</a>  <em> * implementations are notified when a certain element path is encountered</em>
<a name="33" href="#33">33</a>  <em> * </em>
<a name="34" href="#34">34</a>  <em> * @author Wonne Keysers (Realsoftware.be)</em>
<a name="35" href="#35">35</a>  <em> * </em>
<a name="36" href="#36">36</a>  <em> * @see org.dom4j.io.SAXReader</em>
<a name="37" href="#37">37</a>  <em> * @see javax.xml.bind.JAXBContext</em>
<a name="38" href="#38">38</a>  <em> */</em>
<a name="39" href="#39">39</a>  <strong>public</strong> <strong>class</strong> <a href="../../../org/dom4j/jaxb/JAXBReader.html">JAXBReader</a> <strong>extends</strong> <a href="../../../org/dom4j/jaxb/JAXBSupport.html">JAXBSupport</a> {
<a name="40" href="#40">40</a>      <strong>private</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a> reader;
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>      <strong>private</strong> <strong>boolean</strong> pruneElements;
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <em>/**<em>*</em></em>
<a name="45" href="#45">45</a>  <em>     * Creates a new JAXBReader for the given JAXB context path. This is the</em>
<a name="46" href="#46">46</a>  <em>     * Java package where JAXB can find the generated XML classes. This package</em>
<a name="47" href="#47">47</a>  <em>     * MUST contain jaxb.properties!</em>
<a name="48" href="#48">48</a>  <em>     * </em>
<a name="49" href="#49">49</a>  <em>     * @param contextPath</em>
<a name="50" href="#50">50</a>  <em>     *            context path to be used</em>
<a name="51" href="#51">51</a>  <em>     * </em>
<a name="52" href="#52">52</a>  <em>     * @see javax.xml.bind.JAXBContext</em>
<a name="53" href="#53">53</a>  <em>     */</em>
<a name="54" href="#54">54</a>      <strong>public</strong> <a href="../../../org/dom4j/jaxb/JAXBReader.html">JAXBReader</a>(String contextPath) {
<a name="55" href="#55">55</a>          <strong>super</strong>(contextPath);
<a name="56" href="#56">56</a>      }
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <em>/**<em>*</em></em>
<a name="59" href="#59">59</a>  <em>     * Creates a new JAXBReader for the given JAXB context path, using the</em>
<a name="60" href="#60">60</a>  <em>     * specified {@link java.lang.Classloader}. This is the Java package where</em>
<a name="61" href="#61">61</a>  <em>     * JAXB can find the generated XML classes. This package MUST contain</em>
<a name="62" href="#62">62</a>  <em>     * jaxb.properties!</em>
<a name="63" href="#63">63</a>  <em>     * </em>
<a name="64" href="#64">64</a>  <em>     * @param contextPath</em>
<a name="65" href="#65">65</a>  <em>     *            to be used</em>
<a name="66" href="#66">66</a>  <em>     * @param classloader</em>
<a name="67" href="#67">67</a>  <em>     *            to be used</em>
<a name="68" href="#68">68</a>  <em>     * </em>
<a name="69" href="#69">69</a>  <em>     * @see javax.xml.bind.JAXBContext</em>
<a name="70" href="#70">70</a>  <em>     */</em>
<a name="71" href="#71">71</a>      <strong>public</strong> <a href="../../../org/dom4j/jaxb/JAXBReader.html">JAXBReader</a>(String contextPath, ClassLoader classloader) {
<a name="72" href="#72">72</a>          <strong>super</strong>(contextPath, classloader);
<a name="73" href="#73">73</a>      }
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <em>/**<em>*</em></em>
<a name="76" href="#76">76</a>  <em>     * Parses the specified {@link java.io.File}</em>
<a name="77" href="#77">77</a>  <em>     * </em>
<a name="78" href="#78">78</a>  <em>     * @param source</em>
<a name="79" href="#79">79</a>  <em>     *            the file to parse</em>
<a name="80" href="#80">80</a>  <em>     * </em>
<a name="81" href="#81">81</a>  <em>     * @return the resulting DOM4J document</em>
<a name="82" href="#82">82</a>  <em>     * </em>
<a name="83" href="#83">83</a>  <em>     * @throws DocumentException</em>
<a name="84" href="#84">84</a>  <em>     *             when an error occurs while parsing</em>
<a name="85" href="#85">85</a>  <em>     */</em>
<a name="86" href="#86">86</a>      <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(File source) throws DocumentException {
<a name="87" href="#87">87</a>          <strong>return</strong> getReader().read(source);
<a name="88" href="#88">88</a>      }
<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>     * Parses the specified {@link java.io.File}, using the given {@link</em>
<a name="92" href="#92">92</a>  <em>     * java.nio.charset.Charset}.</em>
<a name="93" href="#93">93</a>  <em>     * </em>
<a name="94" href="#94">94</a>  <em>     * @param file</em>
<a name="95" href="#95">95</a>  <em>     *            the file to parse</em>
<a name="96" href="#96">96</a>  <em>     * @param charset</em>
<a name="97" href="#97">97</a>  <em>     *            the charset to be used</em>
<a name="98" href="#98">98</a>  <em>     * </em>
<a name="99" href="#99">99</a>  <em>     * @return the resulting DOM4J document</em>
<a name="100" href="#100">100</a> <em>     * </em>
<a name="101" href="#101">101</a> <em>     * @throws DocumentException</em>
<a name="102" href="#102">102</a> <em>     *             when an error occurs while parsing</em>
<a name="103" href="#103">103</a> <em>     */</em>
<a name="104" href="#104">104</a>     <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(File file, Charset charset) throws DocumentException {
<a name="105" href="#105">105</a>         <strong>try</strong> {
<a name="106" href="#106">106</a>             Reader xmlReader = <strong>new</strong> InputStreamReader(<strong>new</strong> FileInputStream(file),
<a name="107" href="#107">107</a>                     charset);
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>             <strong>return</strong> getReader().read(xmlReader);
<a name="110" href="#110">110</a>         } <strong>catch</strong> (JAXBRuntimeException ex) {
<a name="111" href="#111">111</a>             Throwable cause = ex.getCause();
<a name="112" href="#112">112</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(cause.getMessage(), cause);
<a name="113" href="#113">113</a>         } <strong>catch</strong> (FileNotFoundException ex) {
<a name="114" href="#114">114</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(ex.getMessage(), ex);
<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>/**<em>*</em></em>
<a name="119" href="#119">119</a> <em>     * Parses the specified {@link org.xml.sax.InputSource}</em>
<a name="120" href="#120">120</a> <em>     * </em>
<a name="121" href="#121">121</a> <em>     * @param source</em>
<a name="122" href="#122">122</a> <em>     *            the source to parse</em>
<a name="123" href="#123">123</a> <em>     * </em>
<a name="124" href="#124">124</a> <em>     * @return the resulting DOM4J document</em>
<a name="125" href="#125">125</a> <em>     * </em>
<a name="126" href="#126">126</a> <em>     * @throws DocumentException</em>
<a name="127" href="#127">127</a> <em>     *             when an error occurs while parsing</em>
<a name="128" href="#128">128</a> <em>     */</em>
<a name="129" href="#129">129</a>     <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(InputSource source) throws DocumentException {
<a name="130" href="#130">130</a>         <strong>try</strong> {
<a name="131" href="#131">131</a>             <strong>return</strong> getReader().read(source);
<a name="132" href="#132">132</a>         } <strong>catch</strong> (JAXBRuntimeException ex) {
<a name="133" href="#133">133</a>             Throwable cause = ex.getCause();
<a name="134" href="#134">134</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(cause.getMessage(), cause);
<a name="135" href="#135">135</a>         }
<a name="136" href="#136">136</a>     }
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a>     <em>/**<em>*</em></em>
<a name="139" href="#139">139</a> <em>     * Parses the specified {@link java.io.InputStream}</em>
<a name="140" href="#140">140</a> <em>     * </em>
<a name="141" href="#141">141</a> <em>     * @param source</em>
<a name="142" href="#142">142</a> <em>     *            the input stream to parse</em>
<a name="143" href="#143">143</a> <em>     * </em>
<a name="144" href="#144">144</a> <em>     * @return the resulting DOM4J document</em>
<a name="145" href="#145">145</a> <em>     * </em>
<a name="146" href="#146">146</a> <em>     * @throws DocumentException</em>
<a name="147" href="#147">147</a> <em>     *             when an error occurs while parsing</em>
<a name="148" href="#148">148</a> <em>     */</em>
<a name="149" href="#149">149</a>     <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(InputStream source) throws DocumentException {
<a name="150" href="#150">150</a>         <strong>try</strong> {
<a name="151" href="#151">151</a>             <strong>return</strong> getReader().read(source);
<a name="152" href="#152">152</a>         } <strong>catch</strong> (JAXBRuntimeException ex) {
<a name="153" href="#153">153</a>             Throwable cause = ex.getCause();
<a name="154" href="#154">154</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(cause.getMessage(), cause);
<a name="155" href="#155">155</a>         }
<a name="156" href="#156">156</a>     }
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a>     <em>/**<em>*</em></em>
<a name="159" href="#159">159</a> <em>     * Parses the specified {@link java.io.InputStream}</em>
<a name="160" href="#160">160</a> <em>     * </em>
<a name="161" href="#161">161</a> <em>     * @param source</em>
<a name="162" href="#162">162</a> <em>     *            the input stream to parse</em>
<a name="163" href="#163">163</a> <em>     * @param systemId</em>
<a name="164" href="#164">164</a> <em>     *            is the URI for the input</em>
<a name="165" href="#165">165</a> <em>     * </em>
<a name="166" href="#166">166</a> <em>     * @return the resulting DOM4J document</em>
<a name="167" href="#167">167</a> <em>     * </em>
<a name="168" href="#168">168</a> <em>     * @throws DocumentException</em>
<a name="169" href="#169">169</a> <em>     *             when an error occurs while parsing</em>
<a name="170" href="#170">170</a> <em>     */</em>
<a name="171" href="#171">171</a>     <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(InputStream source, String systemId)
<a name="172" href="#172">172</a>             throws <a href="../../../org/dom4j/DocumentException.html">DocumentException</a> {
<a name="173" href="#173">173</a>         <strong>try</strong> {
<a name="174" href="#174">174</a>             <strong>return</strong> getReader().read(source);
<a name="175" href="#175">175</a>         } <strong>catch</strong> (JAXBRuntimeException ex) {
<a name="176" href="#176">176</a>             Throwable cause = ex.getCause();
<a name="177" href="#177">177</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(cause.getMessage(), cause);
<a name="178" href="#178">178</a>         }
<a name="179" href="#179">179</a>     }
<a name="180" href="#180">180</a> 
<a name="181" href="#181">181</a>     <em>/**<em>*</em></em>
<a name="182" href="#182">182</a> <em>     * Parses the specified {@link java.io.Reader}</em>
<a name="183" href="#183">183</a> <em>     * </em>
<a name="184" href="#184">184</a> <em>     * @param source</em>
<a name="185" href="#185">185</a> <em>     *            the input reader to use</em>
<a name="186" href="#186">186</a> <em>     * </em>
<a name="187" href="#187">187</a> <em>     * @return the resulting DOM4J document</em>
<a name="188" href="#188">188</a> <em>     * </em>
<a name="189" href="#189">189</a> <em>     * @throws DocumentException</em>
<a name="190" href="#190">190</a> <em>     *             when an error occurs while parsing</em>
<a name="191" href="#191">191</a> <em>     */</em>
<a name="192" href="#192">192</a>     <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(Reader source) throws DocumentException {
<a name="193" href="#193">193</a>         <strong>try</strong> {
<a name="194" href="#194">194</a>             <strong>return</strong> getReader().read(source);
<a name="195" href="#195">195</a>         } <strong>catch</strong> (JAXBRuntimeException ex) {
<a name="196" href="#196">196</a>             Throwable cause = ex.getCause();
<a name="197" href="#197">197</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(cause.getMessage(), cause);
<a name="198" href="#198">198</a>         }
<a name="199" href="#199">199</a>     }
<a name="200" href="#200">200</a> 
<a name="201" href="#201">201</a>     <em>/**<em>*</em></em>
<a name="202" href="#202">202</a> <em>     * Parses the specified {@link java.io.Reader}</em>
<a name="203" href="#203">203</a> <em>     * </em>
<a name="204" href="#204">204</a> <em>     * @param source</em>
<a name="205" href="#205">205</a> <em>     *            the input reader to parse</em>
<a name="206" href="#206">206</a> <em>     * @param systemId</em>
<a name="207" href="#207">207</a> <em>     *            is the URI for the input</em>
<a name="208" href="#208">208</a> <em>     * </em>
<a name="209" href="#209">209</a> <em>     * @return the resulting DOM4J document</em>
<a name="210" href="#210">210</a> <em>     * </em>
<a name="211" href="#211">211</a> <em>     * @throws DocumentException</em>
<a name="212" href="#212">212</a> <em>     *             when an error occurs while parsing</em>
<a name="213" href="#213">213</a> <em>     */</em>
<a name="214" href="#214">214</a>     <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(Reader source, String systemId)
<a name="215" href="#215">215</a>             throws <a href="../../../org/dom4j/DocumentException.html">DocumentException</a> {
<a name="216" href="#216">216</a>         <strong>try</strong> {
<a name="217" href="#217">217</a>             <strong>return</strong> getReader().read(source);
<a name="218" href="#218">218</a>         } <strong>catch</strong> (JAXBRuntimeException ex) {
<a name="219" href="#219">219</a>             Throwable cause = ex.getCause();
<a name="220" href="#220">220</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(cause.getMessage(), cause);
<a name="221" href="#221">221</a>         }
<a name="222" href="#222">222</a>     }
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>     <em>/**<em>*</em></em>
<a name="225" href="#225">225</a> <em>     * Parses the the given URL or filename.</em>
<a name="226" href="#226">226</a> <em>     * </em>
<a name="227" href="#227">227</a> <em>     * @param source</em>
<a name="228" href="#228">228</a> <em>     *            the location to parse</em>
<a name="229" href="#229">229</a> <em>     * </em>
<a name="230" href="#230">230</a> <em>     * @return the resulting DOM4J document</em>
<a name="231" href="#231">231</a> <em>     * </em>
<a name="232" href="#232">232</a> <em>     * @throws DocumentException</em>
<a name="233" href="#233">233</a> <em>     *             when an error occurs while parsing</em>
<a name="234" href="#234">234</a> <em>     */</em>
<a name="235" href="#235">235</a>     <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(String source) throws DocumentException {
<a name="236" href="#236">236</a>         <strong>try</strong> {
<a name="237" href="#237">237</a>             <strong>return</strong> getReader().read(source);
<a name="238" href="#238">238</a>         } <strong>catch</strong> (JAXBRuntimeException ex) {
<a name="239" href="#239">239</a>             Throwable cause = ex.getCause();
<a name="240" href="#240">240</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(cause.getMessage(), cause);
<a name="241" href="#241">241</a>         }
<a name="242" href="#242">242</a>     }
<a name="243" href="#243">243</a> 
<a name="244" href="#244">244</a>     <em>/**<em>*</em></em>
<a name="245" href="#245">245</a> <em>     * Parses the the given URL.</em>
<a name="246" href="#246">246</a> <em>     * </em>
<a name="247" href="#247">247</a> <em>     * @param source</em>
<a name="248" href="#248">248</a> <em>     *            the URL to parse</em>
<a name="249" href="#249">249</a> <em>     * </em>
<a name="250" href="#250">250</a> <em>     * @return the resulting DOM4J document</em>
<a name="251" href="#251">251</a> <em>     * </em>
<a name="252" href="#252">252</a> <em>     * @throws DocumentException</em>
<a name="253" href="#253">253</a> <em>     *             when an error occurs while parsing</em>
<a name="254" href="#254">254</a> <em>     */</em>
<a name="255" href="#255">255</a>     <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(URL source) throws DocumentException {
<a name="256" href="#256">256</a>         <strong>try</strong> {
<a name="257" href="#257">257</a>             <strong>return</strong> getReader().read(source);
<a name="258" href="#258">258</a>         } <strong>catch</strong> (JAXBRuntimeException ex) {
<a name="259" href="#259">259</a>             Throwable cause = ex.getCause();
<a name="260" href="#260">260</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(cause.getMessage(), cause);
<a name="261" href="#261">261</a>         }
<a name="262" href="#262">262</a>     }
<a name="263" href="#263">263</a> 
<a name="264" href="#264">264</a>     <em>/**<em>*</em></em>
<a name="265" href="#265">265</a> <em>     * Registers a {@link JAXBObjectHandler}that will be supplied with the</em>
<a name="266" href="#266">266</a> <em>     * unmarshalled representation of the xml fragment whenever the specified</em>
<a name="267" href="#267">267</a> <em>     * path is encounted.</em>
<a name="268" href="#268">268</a> <em>     * </em>
<a name="269" href="#269">269</a> <em>     * @param path</em>
<a name="270" href="#270">270</a> <em>     *            the path to listen for</em>
<a name="271" href="#271">271</a> <em>     * @param handler</em>
<a name="272" href="#272">272</a> <em>     *            the handler to be notified</em>
<a name="273" href="#273">273</a> <em>     */</em>
<a name="274" href="#274">274</a>     <strong>public</strong> <strong>void</strong> addObjectHandler(String path, <a href="../../../org/dom4j/jaxb/JAXBObjectHandler.html">JAXBObjectHandler</a> handler) {
<a name="275" href="#275">275</a>         <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> eHandler = <strong>new</strong> UnmarshalElementHandler(<strong>this</strong>, handler);
<a name="276" href="#276">276</a>         getReader().addHandler(path, eHandler);
<a name="277" href="#277">277</a>     }
<a name="278" href="#278">278</a> 
<a name="279" href="#279">279</a>     <em>/**<em>*</em></em>
<a name="280" href="#280">280</a> <em>     * Removes the {@link JAXBObjectHandler}from the event based processor, for</em>
<a name="281" href="#281">281</a> <em>     * the specified element path.</em>
<a name="282" href="#282">282</a> <em>     * </em>
<a name="283" href="#283">283</a> <em>     * @param path</em>
<a name="284" href="#284">284</a> <em>     *            The path to remove the {@link JAXBObjectHandler}for</em>
<a name="285" href="#285">285</a> <em>     */</em>
<a name="286" href="#286">286</a>     <strong>public</strong> <strong>void</strong> removeObjectHandler(String path) {
<a name="287" href="#287">287</a>         getReader().removeHandler(path);
<a name="288" href="#288">288</a>     }
<a name="289" href="#289">289</a> 
<a name="290" href="#290">290</a>     <em>/**<em>*</em></em>
<a name="291" href="#291">291</a> <em>     * Adds the &lt;code>ElementHandler&lt;/code> to be called when the specified</em>
<a name="292" href="#292">292</a> <em>     * path is encounted.</em>
<a name="293" href="#293">293</a> <em>     * </em>
<a name="294" href="#294">294</a> <em>     * @param path</em>
<a name="295" href="#295">295</a> <em>     *            is the path to be handled</em>
<a name="296" href="#296">296</a> <em>     * @param handler</em>
<a name="297" href="#297">297</a> <em>     *            is the &lt;code>ElementHandler&lt;/code> to be called by the event</em>
<a name="298" href="#298">298</a> <em>     *            based processor.</em>
<a name="299" href="#299">299</a> <em>     */</em>
<a name="300" href="#300">300</a>     <strong>public</strong> <strong>void</strong> addHandler(String path, <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> handler) {
<a name="301" href="#301">301</a>         getReader().addHandler(path, handler);
<a name="302" href="#302">302</a>     }
<a name="303" href="#303">303</a> 
<a name="304" href="#304">304</a>     <em>/**<em>*</em></em>
<a name="305" href="#305">305</a> <em>     * Removes the &lt;code>ElementHandler&lt;/code> from the event based processor,</em>
<a name="306" href="#306">306</a> <em>     * for the specified path.</em>
<a name="307" href="#307">307</a> <em>     * </em>
<a name="308" href="#308">308</a> <em>     * @param path</em>
<a name="309" href="#309">309</a> <em>     *            is the path to remove the &lt;code>ElementHandler&lt;/code> for.</em>
<a name="310" href="#310">310</a> <em>     */</em>
<a name="311" href="#311">311</a>     <strong>public</strong> <strong>void</strong> removeHandler(String path) {
<a name="312" href="#312">312</a>         getReader().removeHandler(path);
<a name="313" href="#313">313</a>     }
<a name="314" href="#314">314</a> 
<a name="315" href="#315">315</a>     <em>/**<em>*</em></em>
<a name="316" href="#316">316</a> <em>     * Removes all registered {@link JAXBObjectHandler}and {@link</em>
<a name="317" href="#317">317</a> <em>     * org.dom4j.ElementHandler} instances from the event based processor.</em>
<a name="318" href="#318">318</a> <em>     */</em>
<a name="319" href="#319">319</a>     <strong>public</strong> <strong>void</strong> resetHandlers() {
<a name="320" href="#320">320</a>         getReader().resetHandlers();
<a name="321" href="#321">321</a>     }
<a name="322" href="#322">322</a> 
<a name="323" href="#323">323</a>     <em>/**<em>*</em></em>
<a name="324" href="#324">324</a> <em>     * When 'true', the DOM4J document will not be kept in memory while parsing.</em>
<a name="325" href="#325">325</a> <em>     * </em>
<a name="326" href="#326">326</a> <em>     * @return Returns the pruneElements.</em>
<a name="327" href="#327">327</a> <em>     */</em>
<a name="328" href="#328">328</a>     <strong>public</strong> <strong>boolean</strong> isPruneElements() {
<a name="329" href="#329">329</a>         <strong>return</strong> pruneElements;
<a name="330" href="#330">330</a>     }
<a name="331" href="#331">331</a> 
<a name="332" href="#332">332</a>     <em>/**<em>*</em></em>
<a name="333" href="#333">333</a> <em>     * Set to true when DOM4J elements must immediately be pruned from the tree.</em>
<a name="334" href="#334">334</a> <em>     * The {@link Document}will not be available afterwards!</em>
<a name="335" href="#335">335</a> <em>     * </em>
<a name="336" href="#336">336</a> <em>     * @param pruneElements</em>
<a name="337" href="#337">337</a> <em>     */</em>
<a name="338" href="#338">338</a>     <strong>public</strong> <strong>void</strong> setPruneElements(<strong>boolean</strong> pruneElements) {
<a name="339" href="#339">339</a>         <strong>this</strong>.pruneElements = pruneElements;
<a name="340" href="#340">340</a> 
<a name="341" href="#341">341</a>         <strong>if</strong> (pruneElements) {
<a name="342" href="#342">342</a>             getReader().setDefaultHandler(<strong>new</strong> PruningElementHandler());
<a name="343" href="#343">343</a>         }
<a name="344" href="#344">344</a>     }
<a name="345" href="#345">345</a> 
<a name="346" href="#346">346</a>     <strong>private</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a> getReader() {
<a name="347" href="#347">347</a>         <strong>if</strong> (reader == <strong>null</strong>) {
<a name="348" href="#348">348</a>             reader = <strong>new</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>();
<a name="349" href="#349">349</a>         }
<a name="350" href="#350">350</a> 
<a name="351" href="#351">351</a>         <strong>return</strong> reader;
<a name="352" href="#352">352</a>     }
<a name="353" href="#353">353</a> 
<a name="354" href="#354">354</a>     <strong>private</strong> <strong>class</strong> UnmarshalElementHandler implements <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> {
<a name="355" href="#355">355</a>         <strong>private</strong> <a href="../../../org/dom4j/jaxb/JAXBReader.html">JAXBReader</a> jaxbReader;
<a name="356" href="#356">356</a> 
<a name="357" href="#357">357</a>         <strong>private</strong> <a href="../../../org/dom4j/jaxb/JAXBObjectHandler.html">JAXBObjectHandler</a> handler;
<a name="358" href="#358">358</a> 
<a name="359" href="#359">359</a>         <strong>public</strong> UnmarshalElementHandler(<a href="../../../org/dom4j/jaxb/JAXBReader.html">JAXBReader</a> documentReader,
<a name="360" href="#360">360</a>                 <a href="../../../org/dom4j/jaxb/JAXBObjectHandler.html">JAXBObjectHandler</a> handler) {
<a name="361" href="#361">361</a>             <strong>this</strong>.jaxbReader = documentReader;
<a name="362" href="#362">362</a>             <strong>this</strong>.handler = handler;
<a name="363" href="#363">363</a>         }
<a name="364" href="#364">364</a> 
<a name="365" href="#365">365</a>         <strong>public</strong> <strong>void</strong> onStart(<a href="../../../org/dom4j/ElementPath.html">ElementPath</a> elementPath) {
<a name="366" href="#366">366</a>         }
<a name="367" href="#367">367</a> 
<a name="368" href="#368">368</a>         <strong>public</strong> <strong>void</strong> onEnd(<a href="../../../org/dom4j/ElementPath.html">ElementPath</a> elementPath) {
<a name="369" href="#369">369</a>             <strong>try</strong> {
<a name="370" href="#370">370</a>                 org.dom4j.Element elem = elementPath.getCurrent();
<a name="371" href="#371">371</a> 
<a name="372" href="#372">372</a>                 javax.xml.bind.Element jaxbObject 
<a name="373" href="#373">373</a>                         = (javax.xml.bind.Element) jaxbReader.unmarshal(elem);
<a name="374" href="#374">374</a> 
<a name="375" href="#375">375</a>                 <strong>if</strong> (jaxbReader.isPruneElements()) {
<a name="376" href="#376">376</a>                     elem.detach();
<a name="377" href="#377">377</a>                 }
<a name="378" href="#378">378</a> 
<a name="379" href="#379">379</a>                 handler.handleObject(jaxbObject);
<a name="380" href="#380">380</a>             } <strong>catch</strong> (Exception ex) {
<a name="381" href="#381">381</a>                 <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/jaxb/JAXBRuntimeException.html">JAXBRuntimeException</a>(ex);
<a name="382" href="#382">382</a>             }
<a name="383" href="#383">383</a>         }
<a name="384" href="#384">384</a>     }
<a name="385" href="#385">385</a> 
<a name="386" href="#386">386</a>     <strong>private</strong> <strong>class</strong> PruningElementHandler implements <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> {
<a name="387" href="#387">387</a>         <strong>public</strong> PruningElementHandler() {
<a name="388" href="#388">388</a>         }
<a name="389" href="#389">389</a> 
<a name="390" href="#390">390</a>         <strong>public</strong> <strong>void</strong> onStart(<a href="../../../org/dom4j/ElementPath.html">ElementPath</a> parm1) {
<a name="391" href="#391">391</a>         }
<a name="392" href="#392">392</a> 
<a name="393" href="#393">393</a>         <strong>public</strong> <strong>void</strong> onEnd(<a href="../../../org/dom4j/ElementPath.html">ElementPath</a> elementPath) {
<a name="394" href="#394">394</a>             <a href="../../../org/dom4j/Element.html">Element</a> elem = elementPath.getCurrent();
<a name="395" href="#395">395</a>             elem.detach();
<a name="396" href="#396">396</a>             elem = <strong>null</strong>;
<a name="397" href="#397">397</a>         }
<a name="398" href="#398">398</a>     }
<a name="399" href="#399">399</a> }
<a name="400" href="#400">400</a> 
<a name="401" href="#401">401</a> <em class="comment">/*</em>
<a name="402" href="#402">402</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="403" href="#403">403</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="404" href="#404">404</a> <em class="comment"> * following conditions are met:</em>
<a name="405" href="#405">405</a> <em class="comment"> * </em>
<a name="406" href="#406">406</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="407" href="#407">407</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="408" href="#408">408</a> <em class="comment"> * </em>
<a name="409" href="#409">409</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="410" href="#410">410</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="411" href="#411">411</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="412" href="#412">412</a> <em class="comment"> * </em>
<a name="413" href="#413">413</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="414" href="#414">414</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="415" href="#415">415</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="416" href="#416">416</a> <em class="comment"> * </em>
<a name="417" href="#417">417</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="418" href="#418">418</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="419" href="#419">419</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="420" href="#420">420</a> <em class="comment"> * </em>
<a name="421" href="#421">421</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="422" href="#422">422</a> <em class="comment"> * </em>
<a name="423" href="#423">423</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="424" href="#424">424</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="425" href="#425">425</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="426" href="#426">426</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="427" href="#427">427</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="428" href="#428">428</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="429" href="#429">429</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="430" href="#430">430</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="431" href="#431">431</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="432" href="#432">432</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="433" href="#433">433</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="434" href="#434">434</a> <em class="comment"> * </em>
<a name="435" href="#435">435</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="436" href="#436">436</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>