<!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>SAXReader xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/dom4j/io/SAXReader.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> 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.Reader;
<a name="15" href="#15">15</a> <strong>import</strong> java.io.Serializable;
<a name="16" href="#16">16</a> <strong>import</strong> java.net.URL;
<a name="17" href="#17">17</a>
<a name="18" href="#18">18</a> <strong>import</strong> org.dom4j.Document;
<a name="19" href="#19">19</a> <strong>import</strong> org.dom4j.DocumentException;
<a name="20" href="#20">20</a> <strong>import</strong> org.dom4j.DocumentFactory;
<a name="21" href="#21">21</a> <strong>import</strong> org.dom4j.ElementHandler;
<a name="22" href="#22">22</a>
<a name="23" href="#23">23</a> <strong>import</strong> org.xml.sax.EntityResolver;
<a name="24" href="#24">24</a> <strong>import</strong> org.xml.sax.ErrorHandler;
<a name="25" href="#25">25</a> <strong>import</strong> org.xml.sax.InputSource;
<a name="26" href="#26">26</a> <strong>import</strong> org.xml.sax.SAXException;
<a name="27" href="#27">27</a> <strong>import</strong> org.xml.sax.SAXParseException;
<a name="28" href="#28">28</a> <strong>import</strong> org.xml.sax.XMLFilter;
<a name="29" href="#29">29</a> <strong>import</strong> org.xml.sax.XMLReader;
<a name="30" href="#30">30</a> <strong>import</strong> org.xml.sax.helpers.DefaultHandler;
<a name="31" href="#31">31</a> <strong>import</strong> org.xml.sax.helpers.XMLReaderFactory;
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a> <em>/**<em>*</em></em>
<a name="34" href="#34">34</a> <em> * <p></em>
<a name="35" href="#35">35</a> <em> * <code>SAXReader</code> creates a DOM4J tree from SAX parsing events.</em>
<a name="36" href="#36">36</a> <em> * </p></em>
<a name="37" href="#37">37</a> <em> * </em>
<a name="38" href="#38">38</a> <em> * <p></em>
<a name="39" href="#39">39</a> <em> * The actual SAX parser that is used by this class is configurable so you can</em>
<a name="40" href="#40">40</a> <em> * use your favourite SAX parser if you wish. DOM4J comes configured with its</em>
<a name="41" href="#41">41</a> <em> * own SAX parser so you do not need to worry about configuring the SAX parser.</em>
<a name="42" href="#42">42</a> <em> * </p></em>
<a name="43" href="#43">43</a> <em> * </em>
<a name="44" href="#44">44</a> <em> * <p></em>
<a name="45" href="#45">45</a> <em> * To explicitly configure the SAX parser that is used via Java code you can use</em>
<a name="46" href="#46">46</a> <em> * a constructor or use the {@link #setXMLReader(XMLReader)}or {@link</em>
<a name="47" href="#47">47</a> <em> * #setXMLReaderClassName(String)} methods.</em>
<a name="48" href="#48">48</a> <em> * </p></em>
<a name="49" href="#49">49</a> <em> * </em>
<a name="50" href="#50">50</a> <em> * <p></em>
<a name="51" href="#51">51</a> <em> * If the parser is not specified explicitly then the standard SAX policy of</em>
<a name="52" href="#52">52</a> <em> * using the <code>org.xml.sax.driver</code> system property is used to</em>
<a name="53" href="#53">53</a> <em> * determine the implementation class of {@link XMLReader}.</em>
<a name="54" href="#54">54</a> <em> * </p></em>
<a name="55" href="#55">55</a> <em> * </em>
<a name="56" href="#56">56</a> <em> * <p></em>
<a name="57" href="#57">57</a> <em> * If the <code>org.xml.sax.driver</code> system property is not defined then</em>
<a name="58" href="#58">58</a> <em> * JAXP is used via reflection (so that DOM4J is not explicitly dependent on the</em>
<a name="59" href="#59">59</a> <em> * JAXP classes) to load the JAXP configured SAXParser. If there is any error</em>
<a name="60" href="#60">60</a> <em> * creating a JAXP SAXParser an informational message is output and then the</em>
<a name="61" href="#61">61</a> <em> * default (Aelfred) SAX parser is used instead.</em>
<a name="62" href="#62">62</a> <em> * </p></em>
<a name="63" href="#63">63</a> <em> * </em>
<a name="64" href="#64">64</a> <em> * <p></em>
<a name="65" href="#65">65</a> <em> * If you are trying to use JAXP to explicitly set your SAX parser and are</em>
<a name="66" href="#66">66</a> <em> * experiencing problems, you can turn on verbose error reporting by defining</em>
<a name="67" href="#67">67</a> <em> * the system property <code>org.dom4j.verbose</code> to be "true" which will</em>
<a name="68" href="#68">68</a> <em> * output a more detailed description of why JAXP could not find a SAX parser</em>
<a name="69" href="#69">69</a> <em> * </p></em>
<a name="70" href="#70">70</a> <em> * </em>
<a name="71" href="#71">71</a> <em> * <p></em>
<a name="72" href="#72">72</a> <em> * For more information on JAXP please go to <a</em>
<a name="73" href="#73">73</a> <em> * href="<a href="http://java.sun.com/xml/" target="alexandria_uri">http://java.sun.com/xml/</a>">Sun's Java &amp; XML site </a></em>
<a name="74" href="#74">74</a> <em> * </p></em>
<a name="75" href="#75">75</a> <em> * </em>
<a name="76" href="#76">76</a> <em> * @author <a href="<a href="mailto:james.strachan@metastuff.com" target="alexandria_uri">mailto:james.strachan@metastuff.com</a>">James Strachan </a></em>
<a name="77" href="#77">77</a> <em> * @version $Revision: 1.58 $</em>
<a name="78" href="#78">78</a> <em> */</em>
<a name="79" href="#79">79</a> <strong>public</strong> <strong>class</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a> {
<a name="80" href="#80">80</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String SAX_STRING_INTERNING =
<a name="81" href="#81">81</a> <span class="string">"http://xml.org/sax/features/string-interning"</span>;
<a name="82" href="#82">82</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String SAX_NAMESPACE_PREFIXES =
<a name="83" href="#83">83</a> <span class="string">"http://xml.org/sax/features/namespace-prefixes"</span>;
<a name="84" href="#84">84</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String SAX_NAMESPACES =
<a name="85" href="#85">85</a> <span class="string">"http://xml.org/sax/features/namespaces"</span>;
<a name="86" href="#86">86</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String SAX_DECL_HANDLER =
<a name="87" href="#87">87</a> <span class="string">"http://xml.org/sax/properties/declaration-handler"</span>;
<a name="88" href="#88">88</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String SAX_LEXICAL_HANDLER =
<a name="89" href="#89">89</a> <span class="string">"http://xml.org/sax/properties/lexical-handler"</span>;
<a name="90" href="#90">90</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String SAX_LEXICALHANDLER =
<a name="91" href="#91">91</a> <span class="string">"http://xml.org/sax/handlers/LexicalHandler"</span>;
<a name="92" href="#92">92</a>
<a name="93" href="#93">93</a> <em>/**<em>* <code>DocumentFactory</code> used to create new document objects */</em></em>
<a name="94" href="#94">94</a> <strong>private</strong> <a href="../../../org/dom4j/DocumentFactory.html">DocumentFactory</a> factory;
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <em>/**<em>* <code>XMLReader</code> used to parse the SAX events */</em></em>
<a name="97" href="#97">97</a> <strong>private</strong> XMLReader xmlReader;
<a name="98" href="#98">98</a>
<a name="99" href="#99">99</a> <em>/**<em>* Whether validation should occur */</em></em>
<a name="100" href="#100">100</a> <strong>private</strong> <strong>boolean</strong> validating;
<a name="101" href="#101">101</a>
<a name="102" href="#102">102</a> <em>/**<em>* <a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a> to call when each <code>Element</code> is encountered */</em></em>
<a name="103" href="#103">103</a> <strong>private</strong> <a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a> dispatchHandler;
<a name="104" href="#104">104</a>
<a name="105" href="#105">105</a> <em>/**<em>* ErrorHandler class to use */</em></em>
<a name="106" href="#106">106</a> <strong>private</strong> ErrorHandler errorHandler;
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <em>/**<em>* The entity resolver */</em></em>
<a name="109" href="#109">109</a> <strong>private</strong> EntityResolver entityResolver;
<a name="110" href="#110">110</a>
<a name="111" href="#111">111</a> <em>/**<em>* Should element & attribute names and namespace URIs be interned? */</em></em>
<a name="112" href="#112">112</a> <strong>private</strong> <strong>boolean</strong> stringInternEnabled = <strong>true</strong>;
<a name="113" href="#113">113</a>
<a name="114" href="#114">114</a> <em>/**<em>* Should internal DTD declarations be expanded into a List in the DTD */</em></em>
<a name="115" href="#115">115</a> <strong>private</strong> <strong>boolean</strong> includeInternalDTDDeclarations = false;
<a name="116" href="#116">116</a>
<a name="117" href="#117">117</a> <em>/**<em>* Should external DTD declarations be expanded into a List in the DTD */</em></em>
<a name="118" href="#118">118</a> <strong>private</strong> <strong>boolean</strong> includeExternalDTDDeclarations = false;
<a name="119" href="#119">119</a>
<a name="120" href="#120">120</a> <em>/**<em>* Whether adjacent text nodes should be merged */</em></em>
<a name="121" href="#121">121</a> <strong>private</strong> <strong>boolean</strong> mergeAdjacentText = false;
<a name="122" href="#122">122</a>
<a name="123" href="#123">123</a> <em>/**<em>* Holds value of property stripWhitespaceText. */</em></em>
<a name="124" href="#124">124</a> <strong>private</strong> <strong>boolean</strong> stripWhitespaceText = false;
<a name="125" href="#125">125</a>
<a name="126" href="#126">126</a> <em>/**<em>* Should we ignore comments */</em></em>
<a name="127" href="#127">127</a> <strong>private</strong> <strong>boolean</strong> ignoreComments = false;
<a name="128" href="#128">128</a>
<a name="129" href="#129">129</a> <em>/**<em>* Encoding of InputSource - null means system default encoding */</em></em>
<a name="130" href="#130">130</a> <strong>private</strong> String encoding = <strong>null</strong>;
<a name="131" href="#131">131</a>
<a name="132" href="#132">132</a> <em class="comment">// private boolean includeExternalGeneralEntities = false;</em>
<a name="133" href="#133">133</a> <em class="comment">// private boolean includeExternalParameterEntities = false;</em>
<a name="134" href="#134">134</a>
<a name="135" href="#135">135</a> <em>/**<em>* The SAX filter used to filter SAX events */</em></em>
<a name="136" href="#136">136</a> <strong>private</strong> XMLFilter xmlFilter;
<a name="137" href="#137">137</a>
<a name="138" href="#138">138</a> <strong>public</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>() {
<a name="139" href="#139">139</a> }
<a name="140" href="#140">140</a>
<a name="141" href="#141">141</a> <strong>public</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>(<strong>boolean</strong> validating) {
<a name="142" href="#142">142</a> <strong>this</strong>.validating = validating;
<a name="143" href="#143">143</a> }
<a name="144" href="#144">144</a>
<a name="145" href="#145">145</a> <strong>public</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>(<a href="../../../org/dom4j/DocumentFactory.html">DocumentFactory</a> factory) {
<a name="146" href="#146">146</a> <strong>this</strong>.factory = factory;
<a name="147" href="#147">147</a> }
<a name="148" href="#148">148</a>
<a name="149" href="#149">149</a> <strong>public</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>(<a href="../../../org/dom4j/DocumentFactory.html">DocumentFactory</a> factory, <strong>boolean</strong> validating) {
<a name="150" href="#150">150</a> <strong>this</strong>.factory = factory;
<a name="151" href="#151">151</a> <strong>this</strong>.validating = validating;
<a name="152" href="#152">152</a> }
<a name="153" href="#153">153</a>
<a name="154" href="#154">154</a> <strong>public</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>(XMLReader xmlReader) {
<a name="155" href="#155">155</a> <strong>this</strong>.xmlReader = xmlReader;
<a name="156" href="#156">156</a> }
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a> <strong>public</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>(XMLReader xmlReader, <strong>boolean</strong> validating) {
<a name="159" href="#159">159</a> <strong>this</strong>.xmlReader = xmlReader;
<a name="160" href="#160">160</a> <strong>this</strong>.validating = validating;
<a name="161" href="#161">161</a> }
<a name="162" href="#162">162</a>
<a name="163" href="#163">163</a> <strong>public</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>(String xmlReaderClassName) throws SAXException {
<a name="164" href="#164">164</a> <strong>if</strong> (xmlReaderClassName != <strong>null</strong>) {
<a name="165" href="#165">165</a> <strong>this</strong>.xmlReader = XMLReaderFactory
<a name="166" href="#166">166</a> .createXMLReader(xmlReaderClassName);
<a name="167" href="#167">167</a> }
<a name="168" href="#168">168</a> }
<a name="169" href="#169">169</a>
<a name="170" href="#170">170</a> <strong>public</strong> <a href="../../../org/dom4j/io/SAXReader.html">SAXReader</a>(String xmlReaderClassName, <strong>boolean</strong> validating)
<a name="171" href="#171">171</a> throws SAXException {
<a name="172" href="#172">172</a> <strong>if</strong> (xmlReaderClassName != <strong>null</strong>) {
<a name="173" href="#173">173</a> <strong>this</strong>.xmlReader = XMLReaderFactory
<a name="174" href="#174">174</a> .createXMLReader(xmlReaderClassName);
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a>
<a name="177" href="#177">177</a> <strong>this</strong>.validating = validating;
<a name="178" href="#178">178</a> }
<a name="179" href="#179">179</a>
<a name="180" href="#180">180</a> <em>/**<em>*</em></em>
<a name="181" href="#181">181</a> <em> * Allows a SAX property to be set on the underlying SAX parser. This can be</em>
<a name="182" href="#182">182</a> <em> * useful to set parser-specific properties such as the location of schema</em>
<a name="183" href="#183">183</a> <em> * or DTD resources. Though use this method with caution as it has the</em>
<a name="184" href="#184">184</a> <em> * possibility of breaking the standard behaviour. An alternative to calling</em>
<a name="185" href="#185">185</a> <em> * this method is to correctly configure an XMLReader object instance and</em>
<a name="186" href="#186">186</a> <em> * call the {@link #setXMLReader(XMLReader)}method</em>
<a name="187" href="#187">187</a> <em> * </em>
<a name="188" href="#188">188</a> <em> * @param name</em>
<a name="189" href="#189">189</a> <em> * is the SAX property name</em>
<a name="190" href="#190">190</a> <em> * @param value</em>
<a name="191" href="#191">191</a> <em> * is the value of the SAX property</em>
<a name="192" href="#192">192</a> <em> * </em>
<a name="193" href="#193">193</a> <em> * @throws SAXException</em>
<a name="194" href="#194">194</a> <em> * if the XMLReader could not be created or the property could</em>
<a name="195" href="#195">195</a> <em> * not be changed.</em>
<a name="196" href="#196">196</a> <em> */</em>
<a name="197" href="#197">197</a> <strong>public</strong> <strong>void</strong> setProperty(String name, Object value) throws SAXException {
<a name="198" href="#198">198</a> getXMLReader().setProperty(name, value);
<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> * Sets a SAX feature on the underlying SAX parser. This can be useful to</em>
<a name="203" href="#203">203</a> <em> * set parser-specific features. Though use this method with caution as it</em>
<a name="204" href="#204">204</a> <em> * has the possibility of breaking the standard behaviour. An alternative to</em>
<a name="205" href="#205">205</a> <em> * calling this method is to correctly configure an XMLReader object</em>
<a name="206" href="#206">206</a> <em> * instance and call the {@link #setXMLReader(XMLReader)}method</em>
<a name="207" href="#207">207</a> <em> * </em>
<a name="208" href="#208">208</a> <em> * @param name</em>
<a name="209" href="#209">209</a> <em> * is the SAX feature name</em>
<a name="210" href="#210">210</a> <em> * @param value</em>
<a name="211" href="#211">211</a> <em> * is the value of the SAX feature</em>
<a name="212" href="#212">212</a> <em> * </em>
<a name="213" href="#213">213</a> <em> * @throws SAXException</em>
<a name="214" href="#214">214</a> <em> * if the XMLReader could not be created or the feature could</em>
<a name="215" href="#215">215</a> <em> * not be changed.</em>
<a name="216" href="#216">216</a> <em> */</em>
<a name="217" href="#217">217</a> <strong>public</strong> <strong>void</strong> setFeature(String name, <strong>boolean</strong> value) throws SAXException {
<a name="218" href="#218">218</a> getXMLReader().setFeature(name, value);
<a name="219" href="#219">219</a> }
<a name="220" href="#220">220</a>
<a name="221" href="#221">221</a> <em>/**<em>*</em></em>
<a name="222" href="#222">222</a> <em> * <p></em>
<a name="223" href="#223">223</a> <em> * Reads a Document from the given <code>File</code></em>
<a name="224" href="#224">224</a> <em> * </p></em>
<a name="225" href="#225">225</a> <em> * </em>
<a name="226" href="#226">226</a> <em> * @param file</em>
<a name="227" href="#227">227</a> <em> * is the <code>File</code> to read from.</em>
<a name="228" href="#228">228</a> <em> * </em>
<a name="229" href="#229">229</a> <em> * @return the newly created Document instance</em>
<a name="230" href="#230">230</a> <em> * </em>
<a name="231" href="#231">231</a> <em> * @throws DocumentException</em>
<a name="232" href="#232">232</a> <em> * if an error occurs during parsing.</em>
<a name="233" href="#233">233</a> <em> */</em>
<a name="234" href="#234">234</a> <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(File file) throws DocumentException {
<a name="235" href="#235">235</a> <strong>try</strong> {
<a name="236" href="#236">236</a> <em class="comment">/*</em>
<a name="237" href="#237">237</a> <em class="comment"> * We cannot convert the file to an URL because if the filename</em>
<a name="238" href="#238">238</a> <em class="comment"> * contains '#' characters, there will be problems with the URL in</em>
<a name="239" href="#239">239</a> <em class="comment"> * the InputSource (because a URL like</em>
<a name="240" href="#240">240</a> <em class="comment"> * <a href="http://myhost.com/index" target="alexandria_uri">http://myhost.com/index</a>#anchor is treated the same as</em>
<a name="241" href="#241">241</a> <em class="comment"> * <a href="http://myhost.com/index)" target="alexandria_uri">http://myhost.com/index)</a> Thanks to Christian Oetterli</em>
<a name="242" href="#242">242</a> <em class="comment"> */</em>
<a name="243" href="#243">243</a> InputSource source = <strong>new</strong> InputSource(<strong>new</strong> FileInputStream(file));
<a name="244" href="#244">244</a> <strong>if</strong> (<strong>this</strong>.encoding != <strong>null</strong>) {
<a name="245" href="#245">245</a> source.setEncoding(<strong>this</strong>.encoding);
<a name="246" href="#246">246</a> }
<a name="247" href="#247">247</a> String path = file.getAbsolutePath();
<a name="248" href="#248">248</a>
<a name="249" href="#249">249</a> <strong>if</strong> (path != <strong>null</strong>) {
<a name="250" href="#250">250</a> <em class="comment">// Code taken from Ant FileUtils</em>
<a name="251" href="#251">251</a> StringBuffer sb = <strong>new</strong> StringBuffer(<span class="string">"file://"</span>);
<a name="252" href="#252">252</a>
<a name="253" href="#253">253</a> <em class="comment">// add an extra slash for filesystems with drive-specifiers</em>
<a name="254" href="#254">254</a> <strong>if</strong> (!path.startsWith(File.separator)) {
<a name="255" href="#255">255</a> sb.append(<span class="string">"/"</span>);
<a name="256" href="#256">256</a> }
<a name="257" href="#257">257</a>
<a name="258" href="#258">258</a> path = path.replace('//', '/');
<a name="259" href="#259">259</a> sb.append(path);
<a name="260" href="#260">260</a>
<a name="261" href="#261">261</a> source.setSystemId(sb.toString());
<a name="262" href="#262">262</a> }
<a name="263" href="#263">263</a>
<a name="264" href="#264">264</a> <strong>return</strong> read(source);
<a name="265" href="#265">265</a> } <strong>catch</strong> (FileNotFoundException e) {
<a name="266" href="#266">266</a> <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(e.getMessage(), e);
<a name="267" href="#267">267</a> }
<a name="268" href="#268">268</a> }
<a name="269" href="#269">269</a>
<a name="270" href="#270">270</a> <em>/**<em>*</em></em>
<a name="271" href="#271">271</a> <em> * <p></em>
<a name="272" href="#272">272</a> <em> * Reads a Document from the given <code>URL</code> using SAX</em>
<a name="273" href="#273">273</a> <em> * </p></em>
<a name="274" href="#274">274</a> <em> * </em>
<a name="275" href="#275">275</a> <em> * @param url</em>
<a name="276" href="#276">276</a> <em> * <code>URL</code> to read from.</em>
<a name="277" href="#277">277</a> <em> * </em>
<a name="278" href="#278">278</a> <em> * @return the newly created Document instance</em>
<a name="279" href="#279">279</a> <em> * </em>
<a name="280" href="#280">280</a> <em> * @throws DocumentException</em>
<a name="281" href="#281">281</a> <em> * if an error occurs during parsing.</em>
<a name="282" href="#282">282</a> <em> */</em>
<a name="283" href="#283">283</a> <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(URL url) throws DocumentException {
<a name="284" href="#284">284</a> String systemID = url.toExternalForm();
<a name="285" href="#285">285</a>
<a name="286" href="#286">286</a> InputSource source = <strong>new</strong> InputSource(systemID);
<a name="287" href="#287">287</a> <strong>if</strong> (<strong>this</strong>.encoding != <strong>null</strong>) {
<a name="288" href="#288">288</a> source.setEncoding(<strong>this</strong>.encoding);
<a name="289" href="#289">289</a> }
<a name="290" href="#290">290</a>
<a name="291" href="#291">291</a> <strong>return</strong> read(source);
<a name="292" href="#292">292</a> }
<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> * <p></em>
<a name="296" href="#296">296</a> <em> * Reads a Document from the given URL or filename using SAX.</em>
<a name="297" href="#297">297</a> <em> * </p></em>
<a name="298" href="#298">298</a> <em> * </em>
<a name="299" href="#299">299</a> <em> * <p></em>
<a name="300" href="#300">300</a> <em> * If the systemId contains a <code>':'</code> character then it is</em>
<a name="301" href="#301">301</a> <em> * assumed to be a URL otherwise its assumed to be a file name. If you want</em>
<a name="302" href="#302">302</a> <em> * finer grained control over this mechansim then please explicitly pass in</em>
<a name="303" href="#303">303</a> <em> * either a {@link URL}or a {@link File}instance instead of a {@link</em>
<a name="304" href="#304">304</a> <em> * String} to denote the source of the document.</em>
<a name="305" href="#305">305</a> <em> * </p></em>
<a name="306" href="#306">306</a> <em> * </em>
<a name="307" href="#307">307</a> <em> * @param systemId</em>
<a name="308" href="#308">308</a> <em> * is a URL for a document or a file name.</em>
<a name="309" href="#309">309</a> <em> * </em>
<a name="310" href="#310">310</a> <em> * @return the newly created Document instance</em>
<a name="311" href="#311">311</a> <em> * </em>
<a name="312" href="#312">312</a> <em> * @throws DocumentException</em>
<a name="313" href="#313">313</a> <em> * if an error occurs during parsing.</em>
<a name="314" href="#314">314</a> <em> */</em>
<a name="315" href="#315">315</a> <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(String systemId) throws DocumentException {
<a name="316" href="#316">316</a> InputSource source = <strong>new</strong> InputSource(systemId);
<a name="317" href="#317">317</a> <strong>if</strong> (<strong>this</strong>.encoding != <strong>null</strong>) {
<a name="318" href="#318">318</a> source.setEncoding(<strong>this</strong>.encoding);
<a name="319" href="#319">319</a> }
<a name="320" href="#320">320</a>
<a name="321" href="#321">321</a> <strong>return</strong> read(source);
<a name="322" href="#322">322</a> }
<a name="323" href="#323">323</a>
<a name="324" href="#324">324</a> <em>/**<em>*</em></em>
<a name="325" href="#325">325</a> <em> * <p></em>
<a name="326" href="#326">326</a> <em> * Reads a Document from the given stream using SAX</em>
<a name="327" href="#327">327</a> <em> * </p></em>
<a name="328" href="#328">328</a> <em> * </em>
<a name="329" href="#329">329</a> <em> * @param in</em>
<a name="330" href="#330">330</a> <em> * <code>InputStream</code> to read from.</em>
<a name="331" href="#331">331</a> <em> * </em>
<a name="332" href="#332">332</a> <em> * @return the newly created Document instance</em>
<a name="333" href="#333">333</a> <em> * </em>
<a name="334" href="#334">334</a> <em> * @throws DocumentException</em>
<a name="335" href="#335">335</a> <em> * if an error occurs during parsing.</em>
<a name="336" href="#336">336</a> <em> */</em>
<a name="337" href="#337">337</a> <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(InputStream in) throws DocumentException {
<a name="338" href="#338">338</a> InputSource source = <strong>new</strong> InputSource(in);
<a name="339" href="#339">339</a> <strong>if</strong> (<strong>this</strong>.encoding != <strong>null</strong>) {
<a name="340" href="#340">340</a> source.setEncoding(<strong>this</strong>.encoding);
<a name="341" href="#341">341</a> }
<a name="342" href="#342">342</a>
<a name="343" href="#343">343</a> <strong>return</strong> read(source);
<a name="344" href="#344">344</a> }
<a name="345" href="#345">345</a>
<a name="346" href="#346">346</a> <em>/**<em>*</em></em>
<a name="347" href="#347">347</a> <em> * <p></em>
<a name="348" href="#348">348</a> <em> * Reads a Document from the given <code>Reader</code> using SAX</em>
<a name="349" href="#349">349</a> <em> * </p></em>
<a name="350" href="#350">350</a> <em> * </em>
<a name="351" href="#351">351</a> <em> * @param reader</em>
<a name="352" href="#352">352</a> <em> * is the reader for the input</em>
<a name="353" href="#353">353</a> <em> * </em>
<a name="354" href="#354">354</a> <em> * @return the newly created Document instance</em>
<a name="355" href="#355">355</a> <em> * </em>
<a name="356" href="#356">356</a> <em> * @throws DocumentException</em>
<a name="357" href="#357">357</a> <em> * if an error occurs during parsing.</em>
<a name="358" href="#358">358</a> <em> */</em>
<a name="359" href="#359">359</a> <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(Reader reader) throws DocumentException {
<a name="360" href="#360">360</a> InputSource source = <strong>new</strong> InputSource(reader);
<a name="361" href="#361">361</a> <strong>if</strong> (<strong>this</strong>.encoding != <strong>null</strong>) {
<a name="362" href="#362">362</a> source.setEncoding(<strong>this</strong>.encoding);
<a name="363" href="#363">363</a> }
<a name="364" href="#364">364</a>
<a name="365" href="#365">365</a> <strong>return</strong> read(source);
<a name="366" href="#366">366</a> }
<a name="367" href="#367">367</a>
<a name="368" href="#368">368</a> <em>/**<em>*</em></em>
<a name="369" href="#369">369</a> <em> * <p></em>
<a name="370" href="#370">370</a> <em> * Reads a Document from the given stream using SAX</em>
<a name="371" href="#371">371</a> <em> * </p></em>
<a name="372" href="#372">372</a> <em> * </em>
<a name="373" href="#373">373</a> <em> * @param in</em>
<a name="374" href="#374">374</a> <em> * <code>InputStream</code> to read from.</em>
<a name="375" href="#375">375</a> <em> * @param systemId</em>
<a name="376" href="#376">376</a> <em> * is the URI for the input</em>
<a name="377" href="#377">377</a> <em> * </em>
<a name="378" href="#378">378</a> <em> * @return the newly created Document instance</em>
<a name="379" href="#379">379</a> <em> * </em>
<a name="380" href="#380">380</a> <em> * @throws DocumentException</em>
<a name="381" href="#381">381</a> <em> * if an error occurs during parsing.</em>
<a name="382" href="#382">382</a> <em> */</em>
<a name="383" href="#383">383</a> <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(InputStream in, String systemId)
<a name="384" href="#384">384</a> throws <a href="../../../org/dom4j/DocumentException.html">DocumentException</a> {
<a name="385" href="#385">385</a> InputSource source = <strong>new</strong> InputSource(in);
<a name="386" href="#386">386</a> source.setSystemId(systemId);
<a name="387" href="#387">387</a> <strong>if</strong> (<strong>this</strong>.encoding != <strong>null</strong>) {
<a name="388" href="#388">388</a> source.setEncoding(<strong>this</strong>.encoding);
<a name="389" href="#389">389</a> }
<a name="390" href="#390">390</a>
<a name="391" href="#391">391</a> <strong>return</strong> read(source);
<a name="392" href="#392">392</a> }
<a name="393" href="#393">393</a>
<a name="394" href="#394">394</a> <em>/**<em>*</em></em>
<a name="395" href="#395">395</a> <em> * <p></em>
<a name="396" href="#396">396</a> <em> * Reads a Document from the given <code>Reader</code> using SAX</em>
<a name="397" href="#397">397</a> <em> * </p></em>
<a name="398" href="#398">398</a> <em> * </em>
<a name="399" href="#399">399</a> <em> * @param reader</em>
<a name="400" href="#400">400</a> <em> * is the reader for the input</em>
<a name="401" href="#401">401</a> <em> * @param systemId</em>
<a name="402" href="#402">402</a> <em> * is the URI for the input</em>
<a name="403" href="#403">403</a> <em> * </em>
<a name="404" href="#404">404</a> <em> * @return the newly created Document instance</em>
<a name="405" href="#405">405</a> <em> * </em>
<a name="406" href="#406">406</a> <em> * @throws DocumentException</em>
<a name="407" href="#407">407</a> <em> * if an error occurs during parsing.</em>
<a name="408" href="#408">408</a> <em> */</em>
<a name="409" href="#409">409</a> <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(Reader reader, String systemId)
<a name="410" href="#410">410</a> throws <a href="../../../org/dom4j/DocumentException.html">DocumentException</a> {
<a name="411" href="#411">411</a> InputSource source = <strong>new</strong> InputSource(reader);
<a name="412" href="#412">412</a> source.setSystemId(systemId);
<a name="413" href="#413">413</a> <strong>if</strong> (<strong>this</strong>.encoding != <strong>null</strong>) {
<a name="414" href="#414">414</a> source.setEncoding(<strong>this</strong>.encoding);
<a name="415" href="#415">415</a> }
<a name="416" href="#416">416</a>
<a name="417" href="#417">417</a> <strong>return</strong> read(source);
<a name="418" href="#418">418</a> }
<a name="419" href="#419">419</a>
<a name="420" href="#420">420</a> <em>/**<em>*</em></em>
<a name="421" href="#421">421</a> <em> * <p></em>
<a name="422" href="#422">422</a> <em> * Reads a Document from the given <code>InputSource</code> using SAX</em>
<a name="423" href="#423">423</a> <em> * </p></em>
<a name="424" href="#424">424</a> <em> * </em>
<a name="425" href="#425">425</a> <em> * @param in</em>
<a name="426" href="#426">426</a> <em> * <code>InputSource</code> to read from.</em>
<a name="427" href="#427">427</a> <em> * </em>
<a name="428" href="#428">428</a> <em> * @return the newly created Document instance</em>
<a name="429" href="#429">429</a> <em> * </em>
<a name="430" href="#430">430</a> <em> * @throws DocumentException</em>
<a name="431" href="#431">431</a> <em> * if an error occurs during parsing.</em>
<a name="432" href="#432">432</a> <em> */</em>
<a name="433" href="#433">433</a> <strong>public</strong> <a href="../../../org/dom4j/Document.html">Document</a> read(InputSource in) throws DocumentException {
<a name="434" href="#434">434</a> <strong>try</strong> {
<a name="435" href="#435">435</a> XMLReader reader = getXMLReader();
<a name="436" href="#436">436</a>
<a name="437" href="#437">437</a> reader = installXMLFilter(reader);
<a name="438" href="#438">438</a>
<a name="439" href="#439">439</a> EntityResolver thatEntityResolver = <strong>this</strong>.entityResolver;
<a name="440" href="#440">440</a>
<a name="441" href="#441">441</a> <strong>if</strong> (thatEntityResolver == <strong>null</strong>) {
<a name="442" href="#442">442</a> thatEntityResolver = createDefaultEntityResolver(in
<a name="443" href="#443">443</a> .getSystemId());
<a name="444" href="#444">444</a> <strong>this</strong>.entityResolver = thatEntityResolver;
<a name="445" href="#445">445</a> }
<a name="446" href="#446">446</a>
<a name="447" href="#447">447</a> reader.setEntityResolver(thatEntityResolver);
<a name="448" href="#448">448</a>
<a name="449" href="#449">449</a> <a href="../../../org/dom4j/io/SAXContentHandler.html">SAXContentHandler</a> contentHandler = createContentHandler(reader);
<a name="450" href="#450">450</a> contentHandler.setEntityResolver(thatEntityResolver);
<a name="451" href="#451">451</a> contentHandler.setInputSource(in);
<a name="452" href="#452">452</a>
<a name="453" href="#453">453</a> <strong>boolean</strong> internal = isIncludeInternalDTDDeclarations();
<a name="454" href="#454">454</a> <strong>boolean</strong> external = isIncludeExternalDTDDeclarations();
<a name="455" href="#455">455</a>
<a name="456" href="#456">456</a> contentHandler.setIncludeInternalDTDDeclarations(internal);
<a name="457" href="#457">457</a> contentHandler.setIncludeExternalDTDDeclarations(external);
<a name="458" href="#458">458</a> contentHandler.setMergeAdjacentText(isMergeAdjacentText());
<a name="459" href="#459">459</a> contentHandler.setStripWhitespaceText(isStripWhitespaceText());
<a name="460" href="#460">460</a> contentHandler.setIgnoreComments(isIgnoreComments());
<a name="461" href="#461">461</a> reader.setContentHandler(contentHandler);
<a name="462" href="#462">462</a>
<a name="463" href="#463">463</a> configureReader(reader, contentHandler);
<a name="464" href="#464">464</a>
<a name="465" href="#465">465</a> reader.parse(in);
<a name="466" href="#466">466</a>
<a name="467" href="#467">467</a> <strong>return</strong> contentHandler.getDocument();
<a name="468" href="#468">468</a> } <strong>catch</strong> (Exception e) {
<a name="469" href="#469">469</a> <strong>if</strong> (e instanceof SAXParseException) {
<a name="470" href="#470">470</a> <em class="comment">// e.printStackTrace();</em>
<a name="471" href="#471">471</a> SAXParseException parseException = (SAXParseException) e;
<a name="472" href="#472">472</a> String systemId = parseException.getSystemId();
<a name="473" href="#473">473</a>
<a name="474" href="#474">474</a> <strong>if</strong> (systemId == <strong>null</strong>) {
<a name="475" href="#475">475</a> systemId = <span class="string">""</span>;
<a name="476" href="#476">476</a> }
<a name="477" href="#477">477</a>
<a name="478" href="#478">478</a> String message = <span class="string">"Error on line "</span>
<a name="479" href="#479">479</a> + parseException.getLineNumber() + <span class="string">" of document "</span>
<a name="480" href="#480">480</a> + systemId + <span class="string">" : "</span> + parseException.getMessage();
<a name="481" href="#481">481</a>
<a name="482" href="#482">482</a> <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(message, e);
<a name="483" href="#483">483</a> } <strong>else</strong> {
<a name="484" href="#484">484</a> <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(e.getMessage(), e);
<a name="485" href="#485">485</a> }
<a name="486" href="#486">486</a> }
<a name="487" href="#487">487</a> }
<a name="488" href="#488">488</a>
<a name="489" href="#489">489</a> <em class="comment">// Properties</em>
<a name="490" href="#490">490</a> <em class="comment">// -------------------------------------------------------------------------</em>
<a name="491" href="#491">491</a>
<a name="492" href="#492">492</a> <em>/**<em>*</em></em>
<a name="493" href="#493">493</a> <em> * DOCUMENT ME!</em>
<a name="494" href="#494">494</a> <em> * </em>
<a name="495" href="#495">495</a> <em> * @return the validation mode, true if validating will be done otherwise</em>
<a name="496" href="#496">496</a> <em> * false.</em>
<a name="497" href="#497">497</a> <em> */</em>
<a name="498" href="#498">498</a> <strong>public</strong> <strong>boolean</strong> isValidating() {
<a name="499" href="#499">499</a> <strong>return</strong> validating;
<a name="500" href="#500">500</a> }
<a name="501" href="#501">501</a>
<a name="502" href="#502">502</a> <em>/**<em>*</em></em>
<a name="503" href="#503">503</a> <em> * Sets the validation mode.</em>
<a name="504" href="#504">504</a> <em> * </em>
<a name="505" href="#505">505</a> <em> * @param validation</em>
<a name="506" href="#506">506</a> <em> * indicates whether or not validation should occur.</em>
<a name="507" href="#507">507</a> <em> */</em>
<a name="508" href="#508">508</a> <strong>public</strong> <strong>void</strong> setValidation(<strong>boolean</strong> validation) {
<a name="509" href="#509">509</a> <strong>this</strong>.validating = validation;
<a name="510" href="#510">510</a> }
<a name="511" href="#511">511</a>
<a name="512" href="#512">512</a> <em>/**<em>*</em></em>
<a name="513" href="#513">513</a> <em> * DOCUMENT ME!</em>
<a name="514" href="#514">514</a> <em> * </em>
<a name="515" href="#515">515</a> <em> * @return whether internal DTD declarations should be expanded into the</em>
<a name="516" href="#516">516</a> <em> * DocumentType object or not.</em>
<a name="517" href="#517">517</a> <em> */</em>
<a name="518" href="#518">518</a> <strong>public</strong> <strong>boolean</strong> isIncludeInternalDTDDeclarations() {
<a name="519" href="#519">519</a> <strong>return</strong> includeInternalDTDDeclarations;
<a name="520" href="#520">520</a> }
<a name="521" href="#521">521</a>
<a name="522" href="#522">522</a> <em>/**<em>*</em></em>
<a name="523" href="#523">523</a> <em> * Sets whether internal DTD declarations should be expanded into the</em>
<a name="524" href="#524">524</a> <em> * DocumentType object or not.</em>
<a name="525" href="#525">525</a> <em> * </em>
<a name="526" href="#526">526</a> <em> * @param include</em>
<a name="527" href="#527">527</a> <em> * whether or not DTD declarations should be expanded and</em>
<a name="528" href="#528">528</a> <em> * included into the DocumentType object.</em>
<a name="529" href="#529">529</a> <em> */</em>
<a name="530" href="#530">530</a> <strong>public</strong> <strong>void</strong> setIncludeInternalDTDDeclarations(<strong>boolean</strong> include) {
<a name="531" href="#531">531</a> <strong>this</strong>.includeInternalDTDDeclarations = include;
<a name="532" href="#532">532</a> }
<a name="533" href="#533">533</a>
<a name="534" href="#534">534</a> <em>/**<em>*</em></em>
<a name="535" href="#535">535</a> <em> * DOCUMENT ME!</em>
<a name="536" href="#536">536</a> <em> * </em>
<a name="537" href="#537">537</a> <em> * @return whether external DTD declarations should be expanded into the</em>
<a name="538" href="#538">538</a> <em> * DocumentType object or not.</em>
<a name="539" href="#539">539</a> <em> */</em>
<a name="540" href="#540">540</a> <strong>public</strong> <strong>boolean</strong> isIncludeExternalDTDDeclarations() {
<a name="541" href="#541">541</a> <strong>return</strong> includeExternalDTDDeclarations;
<a name="542" href="#542">542</a> }
<a name="543" href="#543">543</a>
<a name="544" href="#544">544</a> <em>/**<em>*</em></em>
<a name="545" href="#545">545</a> <em> * Sets whether DTD external declarations should be expanded into the</em>
<a name="546" href="#546">546</a> <em> * DocumentType object or not.</em>
<a name="547" href="#547">547</a> <em> * </em>
<a name="548" href="#548">548</a> <em> * @param include</em>
<a name="549" href="#549">549</a> <em> * whether or not DTD declarations should be expanded and</em>
<a name="550" href="#550">550</a> <em> * included into the DocumentType object.</em>
<a name="551" href="#551">551</a> <em> */</em>
<a name="552" href="#552">552</a> <strong>public</strong> <strong>void</strong> setIncludeExternalDTDDeclarations(<strong>boolean</strong> include) {
<a name="553" href="#553">553</a> <strong>this</strong>.includeExternalDTDDeclarations = include;
<a name="554" href="#554">554</a> }
<a name="555" href="#555">555</a>
<a name="556" href="#556">556</a> <em>/**<em>*</em></em>
<a name="557" href="#557">557</a> <em> * Sets whether String interning is enabled or disabled for element &</em>
<a name="558" href="#558">558</a> <em> * attribute names and namespace URIs. This proprety is enabled by default.</em>
<a name="559" href="#559">559</a> <em> * </em>
<a name="560" href="#560">560</a> <em> * @return DOCUMENT ME!</em>
<a name="561" href="#561">561</a> <em> */</em>
<a name="562" href="#562">562</a> <strong>public</strong> <strong>boolean</strong> isStringInternEnabled() {
<a name="563" href="#563">563</a> <strong>return</strong> stringInternEnabled;
<a name="564" href="#564">564</a> }
<a name="565" href="#565">565</a>
<a name="566" href="#566">566</a> <em>/**<em>*</em></em>
<a name="567" href="#567">567</a> <em> * Sets whether String interning is enabled or disabled for element &</em>
<a name="568" href="#568">568</a> <em> * attribute names and namespace URIs</em>
<a name="569" href="#569">569</a> <em> * </em>
<a name="570" href="#570">570</a> <em> * @param stringInternEnabled</em>
<a name="571" href="#571">571</a> <em> * DOCUMENT ME!</em>
<a name="572" href="#572">572</a> <em> */</em>
<a name="573" href="#573">573</a> <strong>public</strong> <strong>void</strong> setStringInternEnabled(<strong>boolean</strong> stringInternEnabled) {
<a name="574" href="#574">574</a> <strong>this</strong>.stringInternEnabled = stringInternEnabled;
<a name="575" href="#575">575</a> }
<a name="576" href="#576">576</a>
<a name="577" href="#577">577</a> <em>/**<em>*</em></em>
<a name="578" href="#578">578</a> <em> * Returns whether adjacent text nodes should be merged together.</em>
<a name="579" href="#579">579</a> <em> * </em>
<a name="580" href="#580">580</a> <em> * @return Value of property mergeAdjacentText.</em>
<a name="581" href="#581">581</a> <em> */</em>
<a name="582" href="#582">582</a> <strong>public</strong> <strong>boolean</strong> isMergeAdjacentText() {
<a name="583" href="#583">583</a> <strong>return</strong> mergeAdjacentText;
<a name="584" href="#584">584</a> }
<a name="585" href="#585">585</a>
<a name="586" href="#586">586</a> <em>/**<em>*</em></em>
<a name="587" href="#587">587</a> <em> * Sets whether or not adjacent text nodes should be merged together when</em>
<a name="588" href="#588">588</a> <em> * parsing.</em>
<a name="589" href="#589">589</a> <em> * </em>
<a name="590" href="#590">590</a> <em> * @param mergeAdjacentText</em>
<a name="591" href="#591">591</a> <em> * New value of property mergeAdjacentText.</em>
<a name="592" href="#592">592</a> <em> */</em>
<a name="593" href="#593">593</a> <strong>public</strong> <strong>void</strong> setMergeAdjacentText(<strong>boolean</strong> mergeAdjacentText) {
<a name="594" href="#594">594</a> <strong>this</strong>.mergeAdjacentText = mergeAdjacentText;
<a name="595" href="#595">595</a> }
<a name="596" href="#596">596</a>
<a name="597" href="#597">597</a> <em>/**<em>*</em></em>
<a name="598" href="#598">598</a> <em> * Sets whether whitespace between element start and end tags should be</em>
<a name="599" href="#599">599</a> <em> * ignored</em>
<a name="600" href="#600">600</a> <em> * </em>
<a name="601" href="#601">601</a> <em> * @return Value of property stripWhitespaceText.</em>
<a name="602" href="#602">602</a> <em> */</em>
<a name="603" href="#603">603</a> <strong>public</strong> <strong>boolean</strong> isStripWhitespaceText() {
<a name="604" href="#604">604</a> <strong>return</strong> stripWhitespaceText;
<a name="605" href="#605">605</a> }
<a name="606" href="#606">606</a>
<a name="607" href="#607">607</a> <em>/**<em>*</em></em>
<a name="608" href="#608">608</a> <em> * Sets whether whitespace between element start and end tags should be</em>
<a name="609" href="#609">609</a> <em> * ignored.</em>
<a name="610" href="#610">610</a> <em> * </em>
<a name="611" href="#611">611</a> <em> * @param stripWhitespaceText</em>
<a name="612" href="#612">612</a> <em> * New value of property stripWhitespaceText.</em>
<a name="613" href="#613">613</a> <em> */</em>
<a name="614" href="#614">614</a> <strong>public</strong> <strong>void</strong> setStripWhitespaceText(<strong>boolean</strong> stripWhitespaceText) {
<a name="615" href="#615">615</a> <strong>this</strong>.stripWhitespaceText = stripWhitespaceText;
<a name="616" href="#616">616</a> }
<a name="617" href="#617">617</a>
<a name="618" href="#618">618</a> <em>/**<em>*</em></em>
<a name="619" href="#619">619</a> <em> * Returns whether we should ignore comments or not.</em>
<a name="620" href="#620">620</a> <em> * </em>
<a name="621" href="#621">621</a> <em> * @return boolean</em>
<a name="622" href="#622">622</a> <em> */</em>
<a name="623" href="#623">623</a> <strong>public</strong> <strong>boolean</strong> isIgnoreComments() {
<a name="624" href="#624">624</a> <strong>return</strong> ignoreComments;
<a name="625" href="#625">625</a> }
<a name="626" href="#626">626</a>
<a name="627" href="#627">627</a> <em>/**<em>*</em></em>
<a name="628" href="#628">628</a> <em> * Sets whether we should ignore comments or not.</em>
<a name="629" href="#629">629</a> <em> * </em>
<a name="630" href="#630">630</a> <em> * @param ignoreComments</em>
<a name="631" href="#631">631</a> <em> * whether we should ignore comments or not.</em>
<a name="632" href="#632">632</a> <em> */</em>
<a name="633" href="#633">633</a> <strong>public</strong> <strong>void</strong> setIgnoreComments(<strong>boolean</strong> ignoreComments) {
<a name="634" href="#634">634</a> <strong>this</strong>.ignoreComments = ignoreComments;
<a name="635" href="#635">635</a> }
<a name="636" href="#636">636</a>
<a name="637" href="#637">637</a> <em>/**<em>*</em></em>
<a name="638" href="#638">638</a> <em> * DOCUMENT ME!</em>
<a name="639" href="#639">639</a> <em> * </em>
<a name="640" href="#640">640</a> <em> * @return the <code>DocumentFactory</code> used to create document</em>
<a name="641" href="#641">641</a> <em> * objects</em>
<a name="642" href="#642">642</a> <em> */</em>
<a name="643" href="#643">643</a> <strong>public</strong> <a href="../../../org/dom4j/DocumentFactory.html">DocumentFactory</a> getDocumentFactory() {
<a name="644" href="#644">644</a> <strong>if</strong> (factory == <strong>null</strong>) {
<a name="645" href="#645">645</a> factory = DocumentFactory.getInstance();
<a name="646" href="#646">646</a> }
<a name="647" href="#647">647</a>
<a name="648" href="#648">648</a> <strong>return</strong> factory;
<a name="649" href="#649">649</a> }
<a name="650" href="#650">650</a>
<a name="651" href="#651">651</a> <em>/**<em>*</em></em>
<a name="652" href="#652">652</a> <em> * <p></em>
<a name="653" href="#653">653</a> <em> * This sets the <code>DocumentFactory</code> used to create new</em>
<a name="654" href="#654">654</a> <em> * documents. This method allows the building of custom DOM4J tree objects</em>
<a name="655" href="#655">655</a> <em> * to be implemented easily using a custom derivation of</em>
<a name="656" href="#656">656</a> <em> * {@link DocumentFactory}</em>
<a name="657" href="#657">657</a> <em> * </p></em>
<a name="658" href="#658">658</a> <em> * </em>
<a name="659" href="#659">659</a> <em> * @param documentFactory</em>
<a name="660" href="#660">660</a> <em> * <code>DocumentFactory</code> used to create DOM4J objects</em>
<a name="661" href="#661">661</a> <em> */</em>
<a name="662" href="#662">662</a> <strong>public</strong> <strong>void</strong> setDocumentFactory(<a href="../../../org/dom4j/DocumentFactory.html">DocumentFactory</a> documentFactory) {
<a name="663" href="#663">663</a> <strong>this</strong>.factory = documentFactory;
<a name="664" href="#664">664</a> }
<a name="665" href="#665">665</a>
<a name="666" href="#666">666</a> <em>/**<em>*</em></em>
<a name="667" href="#667">667</a> <em> * DOCUMENT ME!</em>
<a name="668" href="#668">668</a> <em> * </em>
<a name="669" href="#669">669</a> <em> * @return the <code>ErrorHandler</code> used by SAX</em>
<a name="670" href="#670">670</a> <em> */</em>
<a name="671" href="#671">671</a> <strong>public</strong> ErrorHandler getErrorHandler() {
<a name="672" href="#672">672</a> <strong>return</strong> errorHandler;
<a name="673" href="#673">673</a> }
<a name="674" href="#674">674</a>
<a name="675" href="#675">675</a> <em>/**<em>*</em></em>
<a name="676" href="#676">676</a> <em> * Sets the <code>ErrorHandler</code> used by the SAX</em>
<a name="677" href="#677">677</a> <em> * <code>XMLReader</code>.</em>
<a name="678" href="#678">678</a> <em> * </em>
<a name="679" href="#679">679</a> <em> * @param errorHandler</em>
<a name="680" href="#680">680</a> <em> * is the <code>ErrorHandler</code> used by SAX</em>
<a name="681" href="#681">681</a> <em> */</em>
<a name="682" href="#682">682</a> <strong>public</strong> <strong>void</strong> setErrorHandler(ErrorHandler errorHandler) {
<a name="683" href="#683">683</a> <strong>this</strong>.errorHandler = errorHandler;
<a name="684" href="#684">684</a> }
<a name="685" href="#685">685</a>
<a name="686" href="#686">686</a> <em>/**<em>*</em></em>
<a name="687" href="#687">687</a> <em> * Returns the current entity resolver used to resolve entities</em>
<a name="688" href="#688">688</a> <em> * </em>
<a name="689" href="#689">689</a> <em> * @return DOCUMENT ME!</em>
<a name="690" href="#690">690</a> <em> */</em>
<a name="691" href="#691">691</a> <strong>public</strong> EntityResolver getEntityResolver() {
<a name="692" href="#692">692</a> <strong>return</strong> entityResolver;
<a name="693" href="#693">693</a> }
<a name="694" href="#694">694</a>
<a name="695" href="#695">695</a> <em>/**<em>*</em></em>
<a name="696" href="#696">696</a> <em> * Sets the entity resolver used to resolve entities.</em>
<a name="697" href="#697">697</a> <em> * </em>
<a name="698" href="#698">698</a> <em> * @param entityResolver</em>
<a name="699" href="#699">699</a> <em> * DOCUMENT ME!</em>
<a name="700" href="#700">700</a> <em> */</em>
<a name="701" href="#701">701</a> <strong>public</strong> <strong>void</strong> setEntityResolver(EntityResolver entityResolver) {
<a name="702" href="#702">702</a> <strong>this</strong>.entityResolver = entityResolver;
<a name="703" href="#703">703</a> }
<a name="704" href="#704">704</a>
<a name="705" href="#705">705</a> <em>/**<em>*</em></em>
<a name="706" href="#706">706</a> <em> * DOCUMENT ME!</em>
<a name="707" href="#707">707</a> <em> * </em>
<a name="708" href="#708">708</a> <em> * @return the <code>XMLReader</code> used to parse SAX events</em>
<a name="709" href="#709">709</a> <em> * </em>
<a name="710" href="#710">710</a> <em> * @throws SAXException</em>
<a name="711" href="#711">711</a> <em> * DOCUMENT ME!</em>
<a name="712" href="#712">712</a> <em> */</em>
<a name="713" href="#713">713</a> <strong>public</strong> XMLReader getXMLReader() throws SAXException {
<a name="714" href="#714">714</a> <strong>if</strong> (xmlReader == <strong>null</strong>) {
<a name="715" href="#715">715</a> xmlReader = createXMLReader();
<a name="716" href="#716">716</a> }
<a name="717" href="#717">717</a>
<a name="718" href="#718">718</a> <strong>return</strong> xmlReader;
<a name="719" href="#719">719</a> }
<a name="720" href="#720">720</a>
<a name="721" href="#721">721</a> <em>/**<em>*</em></em>
<a name="722" href="#722">722</a> <em> * Sets the <code>XMLReader</code> used to parse SAX events</em>
<a name="723" href="#723">723</a> <em> * </em>
<a name="724" href="#724">724</a> <em> * @param reader</em>
<a name="725" href="#725">725</a> <em> * is the <code>XMLReader</code> to parse SAX events</em>
<a name="726" href="#726">726</a> <em> */</em>
<a name="727" href="#727">727</a> <strong>public</strong> <strong>void</strong> setXMLReader(XMLReader reader) {
<a name="728" href="#728">728</a> <strong>this</strong>.xmlReader = reader;
<a name="729" href="#729">729</a> }
<a name="730" href="#730">730</a>
<a name="731" href="#731">731</a> <em>/**<em>*</em></em>
<a name="732" href="#732">732</a> <em> * Returns encoding used for InputSource (null means system default</em>
<a name="733" href="#733">733</a> <em> * encoding)</em>
<a name="734" href="#734">734</a> <em> * </em>
<a name="735" href="#735">735</a> <em> * @return encoding used for InputSource</em>
<a name="736" href="#736">736</a> <em> * </em>
<a name="737" href="#737">737</a> <em> */</em>
<a name="738" href="#738">738</a> <strong>public</strong> String getEncoding() {
<a name="739" href="#739">739</a> <strong>return</strong> encoding;
<a name="740" href="#740">740</a> }
<a name="741" href="#741">741</a>
<a name="742" href="#742">742</a> <em>/**<em>*</em></em>
<a name="743" href="#743">743</a> <em> * Sets encoding used for InputSource (null means system default encoding)</em>
<a name="744" href="#744">744</a> <em> * </em>
<a name="745" href="#745">745</a> <em> * @param encoding</em>
<a name="746" href="#746">746</a> <em> * is encoding used for InputSource</em>
<a name="747" href="#747">747</a> <em> */</em>
<a name="748" href="#748">748</a> <strong>public</strong> <strong>void</strong> setEncoding(String encoding) {
<a name="749" href="#749">749</a> <strong>this</strong>.encoding = encoding;
<a name="750" href="#750">750</a> }
<a name="751" href="#751">751</a>
<a name="752" href="#752">752</a> <em>/**<em>*</em></em>
<a name="753" href="#753">753</a> <em> * Sets the class name of the <code>XMLReader</code> to be used to parse</em>
<a name="754" href="#754">754</a> <em> * SAX events.</em>
<a name="755" href="#755">755</a> <em> * </em>
<a name="756" href="#756">756</a> <em> * @param xmlReaderClassName</em>
<a name="757" href="#757">757</a> <em> * is the class name of the <code>XMLReader</code> to parse SAX</em>
<a name="758" href="#758">758</a> <em> * events</em>
<a name="759" href="#759">759</a> <em> * </em>
<a name="760" href="#760">760</a> <em> * @throws SAXException</em>
<a name="761" href="#761">761</a> <em> * DOCUMENT ME!</em>
<a name="762" href="#762">762</a> <em> */</em>
<a name="763" href="#763">763</a> <strong>public</strong> <strong>void</strong> setXMLReaderClassName(String xmlReaderClassName)
<a name="764" href="#764">764</a> throws SAXException {
<a name="765" href="#765">765</a> setXMLReader(XMLReaderFactory.createXMLReader(xmlReaderClassName));
<a name="766" href="#766">766</a> }
<a name="767" href="#767">767</a>
<a name="768" href="#768">768</a> <em>/**<em>*</em></em>
<a name="769" href="#769">769</a> <em> * Adds the <code>ElementHandler</code> to be called when the specified</em>
<a name="770" href="#770">770</a> <em> * path is encounted.</em>
<a name="771" href="#771">771</a> <em> * </em>
<a name="772" href="#772">772</a> <em> * @param path</em>
<a name="773" href="#773">773</a> <em> * is the path to be handled</em>
<a name="774" href="#774">774</a> <em> * @param handler</em>
<a name="775" href="#775">775</a> <em> * is the <code>ElementHandler</code> to be called by the event</em>
<a name="776" href="#776">776</a> <em> * based processor.</em>
<a name="777" href="#777">777</a> <em> */</em>
<a name="778" href="#778">778</a> <strong>public</strong> <strong>void</strong> addHandler(String path, <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> handler) {
<a name="779" href="#779">779</a> getDispatchHandler().addHandler(path, handler);
<a name="780" href="#780">780</a> }
<a name="781" href="#781">781</a>
<a name="782" href="#782">782</a> <em>/**<em>*</em></em>
<a name="783" href="#783">783</a> <em> * Removes the <code>ElementHandler</code> from the event based processor,</em>
<a name="784" href="#784">784</a> <em> * for the specified path.</em>
<a name="785" href="#785">785</a> <em> * </em>
<a name="786" href="#786">786</a> <em> * @param path</em>
<a name="787" href="#787">787</a> <em> * is the path to remove the <code>ElementHandler</code> for.</em>
<a name="788" href="#788">788</a> <em> */</em>
<a name="789" href="#789">789</a> <strong>public</strong> <strong>void</strong> removeHandler(String path) {
<a name="790" href="#790">790</a> getDispatchHandler().removeHandler(path);
<a name="791" href="#791">791</a> }
<a name="792" href="#792">792</a>
<a name="793" href="#793">793</a> <em>/**<em>*</em></em>
<a name="794" href="#794">794</a> <em> * When multiple <code>ElementHandler</code> instances have been</em>
<a name="795" href="#795">795</a> <em> * registered, this will set a default <code>ElementHandler</code> to be</em>
<a name="796" href="#796">796</a> <em> * called for any path which does <b>NOT </b> have a handler registered.</em>
<a name="797" href="#797">797</a> <em> * </em>
<a name="798" href="#798">798</a> <em> * @param handler</em>
<a name="799" href="#799">799</a> <em> * is the <code>ElementHandler</code> to be called by the event</em>
<a name="800" href="#800">800</a> <em> * based processor.</em>
<a name="801" href="#801">801</a> <em> */</em>
<a name="802" href="#802">802</a> <strong>public</strong> <strong>void</strong> setDefaultHandler(<a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> handler) {
<a name="803" href="#803">803</a> getDispatchHandler().setDefaultHandler(handler);
<a name="804" href="#804">804</a> }
<a name="805" href="#805">805</a>
<a name="806" href="#806">806</a> <em>/**<em>*</em></em>
<a name="807" href="#807">807</a> <em> * This method clears out all the existing handlers and default handler</em>
<a name="808" href="#808">808</a> <em> * setting things back as if no handler existed. Useful when reusing an</em>
<a name="809" href="#809">809</a> <em> * object instance.</em>
<a name="810" href="#810">810</a> <em> */</em>
<a name="811" href="#811">811</a> <strong>public</strong> <strong>void</strong> resetHandlers() {
<a name="812" href="#812">812</a> getDispatchHandler().resetHandlers();
<a name="813" href="#813">813</a> }
<a name="814" href="#814">814</a>
<a name="815" href="#815">815</a> <em>/**<em>*</em></em>
<a name="816" href="#816">816</a> <em> * Returns the SAX filter being used to filter SAX events.</em>
<a name="817" href="#817">817</a> <em> * </em>
<a name="818" href="#818">818</a> <em> * @return the SAX filter being used or null if no SAX filter is installed</em>
<a name="819" href="#819">819</a> <em> */</em>
<a name="820" href="#820">820</a> <strong>public</strong> XMLFilter getXMLFilter() {
<a name="821" href="#821">821</a> <strong>return</strong> xmlFilter;
<a name="822" href="#822">822</a> }
<a name="823" href="#823">823</a>
<a name="824" href="#824">824</a> <em>/**<em>*</em></em>
<a name="825" href="#825">825</a> <em> * Sets the SAX filter to be used when filtering SAX events</em>
<a name="826" href="#826">826</a> <em> * </em>
<a name="827" href="#827">827</a> <em> * @param filter</em>
<a name="828" href="#828">828</a> <em> * is the SAX filter to use or null to disable filtering</em>
<a name="829" href="#829">829</a> <em> */</em>
<a name="830" href="#830">830</a> <strong>public</strong> <strong>void</strong> setXMLFilter(XMLFilter filter) {
<a name="831" href="#831">831</a> <strong>this</strong>.xmlFilter = filter;
<a name="832" href="#832">832</a> }
<a name="833" href="#833">833</a>
<a name="834" href="#834">834</a> <em class="comment">// Implementation methods</em>
<a name="835" href="#835">835</a> <em class="comment">// -------------------------------------------------------------------------</em>
<a name="836" href="#836">836</a>
<a name="837" href="#837">837</a> <em>/**<em>*</em></em>
<a name="838" href="#838">838</a> <em> * Installs any XMLFilter objects required to allow the SAX event stream to</em>
<a name="839" href="#839">839</a> <em> * be filtered and preprocessed before it gets to dom4j.</em>
<a name="840" href="#840">840</a> <em> * </em>
<a name="841" href="#841">841</a> <em> * @param reader</em>
<a name="842" href="#842">842</a> <em> * DOCUMENT ME!</em>
<a name="843" href="#843">843</a> <em> * </em>
<a name="844" href="#844">844</a> <em> * @return the new XMLFilter if applicable or the original XMLReader if no</em>
<a name="845" href="#845">845</a> <em> * filter is being used.</em>
<a name="846" href="#846">846</a> <em> */</em>
<a name="847" href="#847">847</a> <strong>protected</strong> XMLReader installXMLFilter(XMLReader reader) {
<a name="848" href="#848">848</a> XMLFilter filter = getXMLFilter();
<a name="849" href="#849">849</a>
<a name="850" href="#850">850</a> <strong>if</strong> (filter != <strong>null</strong>) {
<a name="851" href="#851">851</a> <em class="comment">// find the root XMLFilter</em>
<a name="852" href="#852">852</a> XMLFilter root = filter;
<a name="853" href="#853">853</a>
<a name="854" href="#854">854</a> <strong>while</strong> (<strong>true</strong>) {
<a name="855" href="#855">855</a> XMLReader parent = root.getParent();
<a name="856" href="#856">856</a>
<a name="857" href="#857">857</a> <strong>if</strong> (parent instanceof XMLFilter) {
<a name="858" href="#858">858</a> root = (XMLFilter) parent;
<a name="859" href="#859">859</a> } <strong>else</strong> {
<a name="860" href="#860">860</a> <strong>break</strong>;
<a name="861" href="#861">861</a> }
<a name="862" href="#862">862</a> }
<a name="863" href="#863">863</a>
<a name="864" href="#864">864</a> root.setParent(reader);
<a name="865" href="#865">865</a>
<a name="866" href="#866">866</a> <strong>return</strong> filter;
<a name="867" href="#867">867</a> }
<a name="868" href="#868">868</a>
<a name="869" href="#869">869</a> <strong>return</strong> reader;
<a name="870" href="#870">870</a> }
<a name="871" href="#871">871</a>
<a name="872" href="#872">872</a> <strong>protected</strong> <a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a> getDispatchHandler() {
<a name="873" href="#873">873</a> <strong>if</strong> (dispatchHandler == <strong>null</strong>) {
<a name="874" href="#874">874</a> dispatchHandler = <strong>new</strong> <a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a>();
<a name="875" href="#875">875</a> }
<a name="876" href="#876">876</a>
<a name="877" href="#877">877</a> <strong>return</strong> dispatchHandler;
<a name="878" href="#878">878</a> }
<a name="879" href="#879">879</a>
<a name="880" href="#880">880</a> <strong>protected</strong> <strong>void</strong> setDispatchHandler(<a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a> dispatchHandler) {
<a name="881" href="#881">881</a> <strong>this</strong>.dispatchHandler = dispatchHandler;
<a name="882" href="#882">882</a> }
<a name="883" href="#883">883</a>
<a name="884" href="#884">884</a> <em>/**<em>*</em></em>
<a name="885" href="#885">885</a> <em> * Factory Method to allow alternate methods of creating and configuring</em>
<a name="886" href="#886">886</a> <em> * XMLReader objects</em>
<a name="887" href="#887">887</a> <em> * </em>
<a name="888" href="#888">888</a> <em> * @return DOCUMENT ME!</em>
<a name="889" href="#889">889</a> <em> * </em>
<a name="890" href="#890">890</a> <em> * @throws SAXException</em>
<a name="891" href="#891">891</a> <em> * DOCUMENT ME!</em>
<a name="892" href="#892">892</a> <em> */</em>
<a name="893" href="#893">893</a> <strong>protected</strong> XMLReader createXMLReader() throws SAXException {
<a name="894" href="#894">894</a> <strong>return</strong> SAXHelper.createXMLReader(isValidating());
<a name="895" href="#895">895</a> }
<a name="896" href="#896">896</a>
<a name="897" href="#897">897</a> <em>/**<em>*</em></em>
<a name="898" href="#898">898</a> <em> * Configures the XMLReader before use</em>
<a name="899" href="#899">899</a> <em> * </em>
<a name="900" href="#900">900</a> <em> * @param reader</em>
<a name="901" href="#901">901</a> <em> * DOCUMENT ME!</em>
<a name="902" href="#902">902</a> <em> * @param handler</em>
<a name="903" href="#903">903</a> <em> * DOCUMENT ME!</em>
<a name="904" href="#904">904</a> <em> * </em>
<a name="905" href="#905">905</a> <em> * @throws DocumentException</em>
<a name="906" href="#906">906</a> <em> * DOCUMENT ME!</em>
<a name="907" href="#907">907</a> <em> */</em>
<a name="908" href="#908">908</a> <strong>protected</strong> <strong>void</strong> configureReader(XMLReader reader, DefaultHandler handler)
<a name="909" href="#909">909</a> throws <a href="../../../org/dom4j/DocumentException.html">DocumentException</a> {
<a name="910" href="#910">910</a> <em class="comment">// configure lexical handling</em>
<a name="911" href="#911">911</a> SAXHelper.setParserProperty(reader, SAX_LEXICALHANDLER, handler);
<a name="912" href="#912">912</a>
<a name="913" href="#913">913</a> <em class="comment">// try alternate property just in case</em>
<a name="914" href="#914">914</a> SAXHelper.setParserProperty(reader, SAX_LEXICAL_HANDLER, handler);
<a name="915" href="#915">915</a>
<a name="916" href="#916">916</a> <em class="comment">// register the DeclHandler</em>
<a name="917" href="#917">917</a> <strong>if</strong> (includeInternalDTDDeclarations || includeExternalDTDDeclarations) {
<a name="918" href="#918">918</a> SAXHelper.setParserProperty(reader, SAX_DECL_HANDLER, handler);
<a name="919" href="#919">919</a> }
<a name="920" href="#920">920</a>
<a name="921" href="#921">921</a> <em class="comment">// configure namespace support</em>
<a name="922" href="#922">922</a> SAXHelper.setParserFeature(reader, SAX_NAMESPACES, <strong>true</strong>);
<a name="923" href="#923">923</a>
<a name="924" href="#924">924</a> SAXHelper.setParserFeature(reader, SAX_NAMESPACE_PREFIXES, false);
<a name="925" href="#925">925</a>
<a name="926" href="#926">926</a> <em class="comment">// string interning</em>
<a name="927" href="#927">927</a> SAXHelper.setParserFeature(reader, SAX_STRING_INTERNING,
<a name="928" href="#928">928</a> isStringInternEnabled());
<a name="929" href="#929">929</a>
<a name="930" href="#930">930</a> <em class="comment">// external entites</em>
<a name="931" href="#931">931</a> <em class="comment">/*</em>
<a name="932" href="#932">932</a> <em class="comment"> * SAXHelper.setParserFeature( reader,</em>
<a name="933" href="#933">933</a> <em class="comment"> * "<a href="http://xml.org/sax/properties/external-general-entities" target="alexandria_uri">http://xml.org/sax/properties/external-general-entities</a>",</em>
<a name="934" href="#934">934</a> <em class="comment"> * includeExternalGeneralEntities ); SAXHelper.setParserFeature( reader,</em>
<a name="935" href="#935">935</a> <em class="comment"> * "<a href="http://xml.org/sax/properties/external-parameter-entities" target="alexandria_uri">http://xml.org/sax/properties/external-parameter-entities</a>",</em>
<a name="936" href="#936">936</a> <em class="comment"> * includeExternalParameterEntities );</em>
<a name="937" href="#937">937</a> <em class="comment"> */</em>
<a name="938" href="#938">938</a> <em class="comment">// use Locator2 if possible</em>
<a name="939" href="#939">939</a> SAXHelper.setParserFeature(reader,
<a name="940" href="#940">940</a> <span class="string">"http://xml.org/sax/features/use-locator2"</span>, <strong>true</strong>);
<a name="941" href="#941">941</a>
<a name="942" href="#942">942</a> <strong>try</strong> {
<a name="943" href="#943">943</a> <em class="comment">// configure validation support</em>
<a name="944" href="#944">944</a> reader.setFeature(<span class="string">"http://xml.org/sax/features/validation"</span>,
<a name="945" href="#945">945</a> isValidating());
<a name="946" href="#946">946</a>
<a name="947" href="#947">947</a> <strong>if</strong> (errorHandler != <strong>null</strong>) {
<a name="948" href="#948">948</a> reader.setErrorHandler(errorHandler);
<a name="949" href="#949">949</a> } <strong>else</strong> {
<a name="950" href="#950">950</a> reader.setErrorHandler(handler);
<a name="951" href="#951">951</a> }
<a name="952" href="#952">952</a> } <strong>catch</strong> (Exception e) {
<a name="953" href="#953">953</a> <strong>if</strong> (isValidating()) {
<a name="954" href="#954">954</a> <strong>throw</strong> <strong>new</strong> <a href="../../../org/dom4j/DocumentException.html">DocumentException</a>(<span class="string">"Validation not supported for"</span>
<a name="955" href="#955">955</a> + <span class="string">" XMLReader: "</span> + reader, e);
<a name="956" href="#956">956</a> }
<a name="957" href="#957">957</a> }
<a name="958" href="#958">958</a> }
<a name="959" href="#959">959</a>
<a name="960" href="#960">960</a> <em>/**<em>*</em></em>
<a name="961" href="#961">961</a> <em> * Factory Method to allow user derived SAXContentHandler objects to be used</em>
<a name="962" href="#962">962</a> <em> * </em>
<a name="963" href="#963">963</a> <em> * @param reader</em>
<a name="964" href="#964">964</a> <em> * DOCUMENT ME!</em>
<a name="965" href="#965">965</a> <em> * </em>
<a name="966" href="#966">966</a> <em> * @return DOCUMENT ME!</em>
<a name="967" href="#967">967</a> <em> */</em>
<a name="968" href="#968">968</a> <strong>protected</strong> <a href="../../../org/dom4j/io/SAXContentHandler.html">SAXContentHandler</a> createContentHandler(XMLReader reader) {
<a name="969" href="#969">969</a> <strong>return</strong> <strong>new</strong> <a href="../../../org/dom4j/io/SAXContentHandler.html">SAXContentHandler</a>(getDocumentFactory(), dispatchHandler);
<a name="970" href="#970">970</a> }
<a name="971" href="#971">971</a>
<a name="972" href="#972">972</a> <strong>protected</strong> EntityResolver createDefaultEntityResolver(String systemId) {
<a name="973" href="#973">973</a> String prefix = <strong>null</strong>;
<a name="974" href="#974">974</a>
<a name="975" href="#975">975</a> <strong>if</strong> ((systemId != <strong>null</strong>) && (systemId.length() > 0)) {
<a name="976" href="#976">976</a> <strong>int</strong> idx = systemId.lastIndexOf('/');
<a name="977" href="#977">977</a>
<a name="978" href="#978">978</a> <strong>if</strong> (idx > 0) {
<a name="979" href="#979">979</a> prefix = systemId.substring(0, idx + 1);
<a name="980" href="#980">980</a> }
<a name="981" href="#981">981</a> }
<a name="982" href="#982">982</a>
<a name="983" href="#983">983</a> <strong>return</strong> <strong>new</strong> SAXEntityResolver(prefix);
<a name="984" href="#984">984</a> }
<a name="985" href="#985">985</a>
<a name="986" href="#986">986</a> <strong>protected</strong> <strong>static</strong> <strong>class</strong> SAXEntityResolver implements EntityResolver,
<a name="987" href="#987">987</a> Serializable {
<a name="988" href="#988">988</a> <strong>protected</strong> String uriPrefix;
<a name="989" href="#989">989</a>
<a name="990" href="#990">990</a> <strong>public</strong> SAXEntityResolver(String uriPrefix) {
<a name="991" href="#991">991</a> <strong>this</strong>.uriPrefix = uriPrefix;
<a name="992" href="#992">992</a> }
<a name="993" href="#993">993</a>
<a name="994" href="#994">994</a> <strong>public</strong> InputSource resolveEntity(String <strong>public</strong>Id, String systemId) {
<a name="995" href="#995">995</a> <em class="comment">// try create a relative URI reader...</em>
<a name="996" href="#996">996</a> <strong>if</strong> ((systemId != <strong>null</strong>) && (systemId.length() > 0)) {
<a name="997" href="#997">997</a> <strong>if</strong> ((uriPrefix != <strong>null</strong>) && (systemId.indexOf(':') <= 0)) {
<a name="998" href="#998">998</a> systemId = uriPrefix + systemId;
<a name="999" href="#999">999</a> }
<a name="1000" href="#1000">1000</a> }
<a name="1001" href="#1001">1001</a>
<a name="1002" href="#1002">1002</a> <strong>return</strong> <strong>new</strong> InputSource(systemId);
<a name="1003" href="#1003">1003</a> }
<a name="1004" href="#1004">1004</a> }
<a name="1005" href="#1005">1005</a> }
<a name="1006" href="#1006">1006</a>
<a name="1007" href="#1007">1007</a> <em class="comment">/*</em>
<a name="1008" href="#1008">1008</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="1009" href="#1009">1009</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="1010" href="#1010">1010</a> <em class="comment"> * following conditions are met:</em>
<a name="1011" href="#1011">1011</a> <em class="comment"> * </em>
<a name="1012" href="#1012">1012</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="1013" href="#1013">1013</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="1014" href="#1014">1014</a> <em class="comment"> * </em>
<a name="1015" href="#1015">1015</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="1016" href="#1016">1016</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="1017" href="#1017">1017</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="1018" href="#1018">1018</a> <em class="comment"> * </em>
<a name="1019" href="#1019">1019</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="1020" href="#1020">1020</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="1021" href="#1021">1021</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="1022" href="#1022">1022</a> <em class="comment"> * </em>
<a name="1023" href="#1023">1023</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="1024" href="#1024">1024</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="1025" href="#1025">1025</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="1026" href="#1026">1026</a> <em class="comment"> * </em>
<a name="1027" href="#1027">1027</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="1028" href="#1028">1028</a> <em class="comment"> * </em>
<a name="1029" href="#1029">1029</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="1030" href="#1030">1030</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="1031" href="#1031">1031</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="1032" href="#1032">1032</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="1033" href="#1033">1033</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="1034" href="#1034">1034</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="1035" href="#1035">1035</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="1036" href="#1036">1036</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="1037" href="#1037">1037</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="1038" href="#1038">1038</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="1039" href="#1039">1039</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="1040" href="#1040">1040</a> <em class="comment"> * </em>
<a name="1041" href="#1041">1041</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="1042" href="#1042">1042</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>
