<!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>DTDTest xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<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> junit.framework.AssertionFailedError;
<a name="11" href="#11">11</a>
<a name="12" href="#12">12</a> <strong>import</strong> junit.textui.TestRunner;
<a name="13" href="#13">13</a>
<a name="14" href="#14">14</a> <strong>import</strong> java.io.FileInputStream;
<a name="15" href="#15">15</a> <strong>import</strong> java.io.IOException;
<a name="16" href="#16">16</a> <strong>import</strong> java.io.InputStream;
<a name="17" href="#17">17</a> <strong>import</strong> java.util.ArrayList;
<a name="18" href="#18">18</a> <strong>import</strong> java.util.Iterator;
<a name="19" href="#19">19</a> <strong>import</strong> java.util.List;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong>import</strong> org.dom4j.AbstractTestCase;
<a name="22" href="#22">22</a> <strong>import</strong> org.dom4j.Document;
<a name="23" href="#23">23</a> <strong>import</strong> org.dom4j.DocumentType;
<a name="24" href="#24">24</a> <strong>import</strong> org.dom4j.dtd.AttributeDecl;
<a name="25" href="#25">25</a> <strong>import</strong> org.dom4j.dtd.ElementDecl;
<a name="26" href="#26">26</a> <strong>import</strong> org.dom4j.dtd.ExternalEntityDecl;
<a name="27" href="#27">27</a> <strong>import</strong> org.dom4j.dtd.InternalEntityDecl;
<a name="28" href="#28">28</a> <strong>import</strong> org.dom4j.tree.DefaultDocumentType;
<a name="29" href="#29">29</a>
<a name="30" href="#30">30</a> <strong>import</strong> org.xml.sax.EntityResolver;
<a name="31" href="#31">31</a> <strong>import</strong> org.xml.sax.InputSource;
<a name="32" href="#32">32</a> <strong>import</strong> org.xml.sax.SAXException;
<a name="33" href="#33">33</a>
<a name="34" href="#34">34</a> <em>/**<em>*</em></em>
<a name="35" href="#35">35</a> <em> * Tests the DocType functionality.</em>
<a name="36" href="#36">36</a> <em> * </em>
<a name="37" href="#37">37</a> <em> * <p></em>
<a name="38" href="#38">38</a> <em> * Incorporated additional test cases for optional processing of the internal</em>
<a name="39" href="#39">39</a> <em> * and external DTD subsets. The "external" and "mixed" tests both <strong>fail</em>
<a name="40" href="#40">40</a> <em> * </strong> due to a reported bug. See <a href="http://tinyurl.com/4dzyq" target="alexandria_uri">http://tinyurl.com/4dzyq</a></em>
<a name="41" href="#41">41</a> <em> * </p></em>
<a name="42" href="#42">42</a> <em> * </em>
<a name="43" href="#43">43</a> <em> * @author <a href="<a href="mailto:jstrachan@apache.org" target="alexandria_uri">mailto:jstrachan@apache.org</a>">James Strachan </a></em>
<a name="44" href="#44">44</a> <em> * @version $Revision: 1.4 $</em>
<a name="45" href="#45">45</a> <em> */</em>
<a name="46" href="#46">46</a> <strong>public</strong> <strong>class</strong> <a href="../../../org/dom4j/io/DTDTest.html">DTDTest</a> <strong>extends</strong> <a href="../../../org/dom4j/AbstractTestCase.html">AbstractTestCase</a> {
<a name="47" href="#47">47</a> <em>/**<em>*</em></em>
<a name="48" href="#48">48</a> <em> * Input XML file to read <code>xml/dtd/internal.xml</code>- document</em>
<a name="49" href="#49">49</a> <em> * using internal DTD subset, but no external DTD subset.</em>
<a name="50" href="#50">50</a> <em> */</em>
<a name="51" href="#51">51</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String XML_INTERNAL_FILE = <span class="string">"xml/dtd/internal.xml"</span>;
<a name="52" href="#52">52</a>
<a name="53" href="#53">53</a> <em>/**<em>*</em></em>
<a name="54" href="#54">54</a> <em> * Input XML file to read <code>xml/dtd/external.xml</code>- document</em>
<a name="55" href="#55">55</a> <em> * using external DTD subset, but no internal DTD subset. The external</em>
<a name="56" href="#56">56</a> <em> * entity should be locatable by either PUBLIC or SYSTEM identifier. The</em>
<a name="57" href="#57">57</a> <em> * testing harness should use an appropriate EntityResolver to locate the</em>
<a name="58" href="#58">58</a> <em> * external entity as a local resource (no internet access).</em>
<a name="59" href="#59">59</a> <em> */</em>
<a name="60" href="#60">60</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String XML_EXTERNAL_FILE = <span class="string">"xml/dtd/external.xml"</span>;
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <em>/**<em>*</em></em>
<a name="63" href="#63">63</a> <em> * Input XML file to read <code>xml/dtd/mixed.xml</code>- document using</em>
<a name="64" href="#64">64</a> <em> * both an internal and an external DTD subset. The external entity should</em>
<a name="65" href="#65">65</a> <em> * be locatable by either PUBLIC or SYSTEM identifier. The testing harness</em>
<a name="66" href="#66">66</a> <em> * should use an appropriate EntityResolver to locate the external entity as</em>
<a name="67" href="#67">67</a> <em> * a local resource (no internet access).</em>
<a name="68" href="#68">68</a> <em> */</em>
<a name="69" href="#69">69</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String XML_MIXED = <span class="string">"xml/dtd/mixed.xml"</span>;
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <em>/**<em>*</em></em>
<a name="72" href="#72">72</a> <em> * Input XML file to for {@linkEntityResolver}</em>
<a name="73" href="#73">73</a> <em> * <code>xml/dtd/sample.dtd</code>- the external entity providing the</em>
<a name="74" href="#74">74</a> <em> * external DTD subset for test cases that need one. The SYSTEM identifier</em>
<a name="75" href="#75">75</a> <em> * for this external entity is given by {@link#DTD_SYSTEM_ID}.</em>
<a name="76" href="#76">76</a> <em> */</em>
<a name="77" href="#77">77</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String DTD_FILE = <span class="string">"xml/dtd/sample.dtd"</span>;
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> <em>/**<em>*</em></em>
<a name="80" href="#80">80</a> <em> * The PUBLIC identifier, which is <code>-//dom4j//DTD sample</code>, for</em>
<a name="81" href="#81">81</a> <em> * the external entity providing DTD for tests.</em>
<a name="82" href="#82">82</a> <em> */</em>
<a name="83" href="#83">83</a> <strong>protected</strong> <strong>static</strong> <strong>final</strong> String DTD_PUBLICID = <span class="string">"-//dom4j//DTD sample"</span>;
<a name="84" href="#84">84</a>
<a name="85" href="#85">85</a> <em>/**<em>*</em></em>
<a name="86" href="#86">86</a> <em> * The SYSTEM identifier, which is <code>sample.dtd</code>, for the</em>
<a name="87" href="#87">87</a> <em> * external entity providing DTD for tests.</em>
<a name="88" href="#88">88</a> <em> */</em>
<a name="89" href="#89">89</a> <strong>protected</strong> <strong>static</strong> <strong>final</strong> String DTD_SYSTEM_ID = <span class="string">"sample.dtd"</span>;
<a name="90" href="#90">90</a>
<a name="91" href="#91">91</a> <strong>public</strong> <strong>static</strong> <strong>void</strong> main(String[] args) {
<a name="92" href="#92">92</a> TestRunner.run(DTDTest.<strong>class</strong>);
<a name="93" href="#93">93</a> }
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <em class="comment">// Test case(s)</em>
<a name="96" href="#96">96</a> <em class="comment">// -------------------------------------------------------------------------</em>
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <em>/**<em>*</em></em>
<a name="99" href="#99">99</a> <em> * Test verifies correct identification of the internal DTD subset and</em>
<a name="100" href="#100">100</a> <em> * correct non-presence of the external DTD subset.</em>
<a name="101" href="#101">101</a> <em> * </em>
<a name="102" href="#102">102</a> <em> * @throws Exception</em>
<a name="103" href="#103">103</a> <em> * DOCUMENT ME!</em>
<a name="104" href="#104">104</a> <em> */</em>
<a name="105" href="#105">105</a> <strong>public</strong> <strong>void</strong> testInternalDTDSubset() throws Exception {
<a name="106" href="#106">106</a> <em class="comment">/*</em>
<a name="107" href="#107">107</a> <em class="comment"> * Setup the expected DocumentType.</em>
<a name="108" href="#108">108</a> <em class="comment"> * </em>
<a name="109" href="#109">109</a> <em class="comment"> * @todo dom4j should expose a DefaultDocumentType constructor that</em>
<a name="110" href="#110">110</a> <em class="comment"> * accepts only the elementName property. This is used when only an</em>
<a name="111" href="#111">111</a> <em class="comment"> * internal DTD subset is being provided via the <!DOCTYPE foo [...]></em>
<a name="112" href="#112">112</a> <em class="comment"> * syntax, in which case there is neither a SYSTEM nor PUBLIC</em>
<a name="113" href="#113">113</a> <em class="comment"> * identifier.</em>
<a name="114" href="#114">114</a> <em class="comment"> */</em>
<a name="115" href="#115">115</a> DocumentType expected = <strong>new</strong> DefaultDocumentType();
<a name="116" href="#116">116</a>
<a name="117" href="#117">117</a> expected.setElementName(<span class="string">"greeting"</span>);
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> expected.setInternalDeclarations(getInternalDeclarations());
<a name="120" href="#120">120</a>
<a name="121" href="#121">121</a> <em class="comment">/*</em>
<a name="122" href="#122">122</a> <em class="comment"> * Parse the test XML document and compare the expected and actual</em>
<a name="123" href="#123">123</a> <em class="comment"> * DOCTYPEs.</em>
<a name="124" href="#124">124</a> <em class="comment"> */</em>
<a name="125" href="#125">125</a> <strong>try</strong> {
<a name="126" href="#126">126</a> assertSameDocumentType(expected, readDocument(
<a name="127" href="#127">127</a> XML_INTERNAL_FILE, <strong>true</strong>, false).getDocType());
<a name="128" href="#128">128</a> } <strong>catch</strong> (AssertionFailedError ex) {
<a name="129" href="#129">129</a> <strong>throw</strong> ex;
<a name="130" href="#130">130</a> } <strong>catch</strong> (Throwable t) {
<a name="131" href="#131">131</a> fail(<span class="string">"Not expecting: "</span> + t);
<a name="132" href="#132">132</a> }
<a name="133" href="#133">133</a> }
<a name="134" href="#134">134</a>
<a name="135" href="#135">135</a> <em>/**<em>*</em></em>
<a name="136" href="#136">136</a> <em> * Test verifies correct identification of the external DTD subset and</em>
<a name="137" href="#137">137</a> <em> * correct non-presence of the internal DTD subset.</em>
<a name="138" href="#138">138</a> <em> */</em>
<a name="139" href="#139">139</a> <strong>public</strong> <strong>void</strong> testExternalDTDSubset() {
<a name="140" href="#140">140</a> <em class="comment">/*</em>
<a name="141" href="#141">141</a> <em class="comment"> * Setup the expected DocumentType.</em>
<a name="142" href="#142">142</a> <em class="comment"> */</em>
<a name="143" href="#143">143</a> DocumentType expected = <strong>new</strong> DefaultDocumentType(<span class="string">"another-greeting"</span>,
<a name="144" href="#144">144</a> <strong>null</strong>, DTD_SYSTEM_ID);
<a name="145" href="#145">145</a>
<a name="146" href="#146">146</a> expected.setExternalDeclarations(getExternalDeclarations());
<a name="147" href="#147">147</a>
<a name="148" href="#148">148</a> <em class="comment">/*</em>
<a name="149" href="#149">149</a> <em class="comment"> * Parse the test XML document and compare the expected and actual</em>
<a name="150" href="#150">150</a> <em class="comment"> * DOCTYPEs.</em>
<a name="151" href="#151">151</a> <em class="comment"> */</em>
<a name="152" href="#152">152</a> <strong>try</strong> {
<a name="153" href="#153">153</a> assertSameDocumentType(expected, readDocument(
<a name="154" href="#154">154</a> XML_EXTERNAL_FILE, false, <strong>true</strong>).getDocType());
<a name="155" href="#155">155</a> } <strong>catch</strong> (AssertionFailedError ex) {
<a name="156" href="#156">156</a> <strong>throw</strong> ex;
<a name="157" href="#157">157</a> } <strong>catch</strong> (Throwable t) {
<a name="158" href="#158">158</a> fail(<span class="string">"Not expecting: "</span> + t);
<a name="159" href="#159">159</a> }
<a name="160" href="#160">160</a> }
<a name="161" href="#161">161</a>
<a name="162" href="#162">162</a> <em>/**<em>*</em></em>
<a name="163" href="#163">163</a> <em> * Test verifies correct identification of the internal and external DTD</em>
<a name="164" href="#164">164</a> <em> * subsets.</em>
<a name="165" href="#165">165</a> <em> */</em>
<a name="166" href="#166">166</a> <strong>public</strong> <strong>void</strong> testMixedDTDSubset() {
<a name="167" href="#167">167</a> <em class="comment">/*</em>
<a name="168" href="#168">168</a> <em class="comment"> * Setup the expected DocumentType.</em>
<a name="169" href="#169">169</a> <em class="comment"> */</em>
<a name="170" href="#170">170</a> DocumentType expected = <strong>new</strong> DefaultDocumentType(<span class="string">"another-greeting"</span>,
<a name="171" href="#171">171</a> <strong>null</strong>, DTD_SYSTEM_ID);
<a name="172" href="#172">172</a>
<a name="173" href="#173">173</a> expected.setInternalDeclarations(getInternalDeclarations());
<a name="174" href="#174">174</a>
<a name="175" href="#175">175</a> expected.setExternalDeclarations(getExternalDeclarations());
<a name="176" href="#176">176</a>
<a name="177" href="#177">177</a> <em class="comment">/*</em>
<a name="178" href="#178">178</a> <em class="comment"> * Parse the test XML document and compare the expected and actual</em>
<a name="179" href="#179">179</a> <em class="comment"> * DOCTYPEs.</em>
<a name="180" href="#180">180</a> <em class="comment"> */</em>
<a name="181" href="#181">181</a> <strong>try</strong> {
<a name="182" href="#182">182</a> assertSameDocumentType(expected, readDocument(XML_MIXED,
<a name="183" href="#183">183</a> <strong>true</strong>, <strong>true</strong>).getDocType());
<a name="184" href="#184">184</a> } <strong>catch</strong> (AssertionFailedError ex) {
<a name="185" href="#185">185</a> <strong>throw</strong> ex;
<a name="186" href="#186">186</a> } <strong>catch</strong> (Throwable t) {
<a name="187" href="#187">187</a> fail(<span class="string">"Not expecting: "</span> + t);
<a name="188" href="#188">188</a> }
<a name="189" href="#189">189</a> }
<a name="190" href="#190">190</a>
<a name="191" href="#191">191</a> <em class="comment">// Implementation methods</em>
<a name="192" href="#192">192</a> <em class="comment">// -------------------------------------------------------------------------</em>
<a name="193" href="#193">193</a>
<a name="194" href="#194">194</a> <em>/**<em>*</em></em>
<a name="195" href="#195">195</a> <em> * Test helper method returns a {@link List}of DTD declarations that</em>
<a name="196" href="#196">196</a> <em> * represents the expected internal DTD subset (for the tests that use an</em>
<a name="197" href="#197">197</a> <em> * internal DTD subset).</em>
<a name="198" href="#198">198</a> <em> * </em>
<a name="199" href="#199">199</a> <em> * <p></em>
<a name="200" href="#200">200</a> <em> * Note: The declarations returned by this method MUST agree those actually</em>
<a name="201" href="#201">201</a> <em> * declared in {@link #XML_INTERNAL_FILE}and {@link</em>
<a name="202" href="#202">202</a> <em> * #XML_MIXED}.</em>
<a name="203" href="#203">203</a> <em> * </p></em>
<a name="204" href="#204">204</a> <em> * </em>
<a name="205" href="#205">205</a> <em> * <p></em>
<a name="206" href="#206">206</a> <em> * </p></em>
<a name="207" href="#207">207</a> <em> * </em>
<a name="208" href="#208">208</a> <em> * @return DOCUMENT ME!</em>
<a name="209" href="#209">209</a> <em> */</em>
<a name="210" href="#210">210</a> <strong>protected</strong> List getInternalDeclarations() {
<a name="211" href="#211">211</a> List decls = <strong>new</strong> ArrayList();
<a name="212" href="#212">212</a>
<a name="213" href="#213">213</a> decls.add(<strong>new</strong> ElementDecl(<span class="string">"greeting"</span>, <span class="string">"(#PCDATA)"</span>));
<a name="214" href="#214">214</a>
<a name="215" href="#215">215</a> decls.add(<strong>new</strong> AttributeDecl(<span class="string">"greeting"</span>, <span class="string">"foo"</span>, <span class="string">"ID"</span>, <span class="string">"#IMPLIED"</span>, <strong>null</strong>));
<a name="216" href="#216">216</a>
<a name="217" href="#217">217</a> decls.add(<strong>new</strong> InternalEntityDecl(<span class="string">"%boolean"</span>, <span class="string">"( true | false )"</span>));
<a name="218" href="#218">218</a>
<a name="219" href="#219">219</a> <strong>return</strong> decls;
<a name="220" href="#220">220</a> }
<a name="221" href="#221">221</a>
<a name="222" href="#222">222</a> <em>/**<em>*</em></em>
<a name="223" href="#223">223</a> <em> * Test helper method returns a {@link List}of DTD declarations that</em>
<a name="224" href="#224">224</a> <em> * represents the expected external DTD subset (for the tests that use an</em>
<a name="225" href="#225">225</a> <em> * external DTD subset).</em>
<a name="226" href="#226">226</a> <em> * </em>
<a name="227" href="#227">227</a> <em> * @return DOCUMENT ME!</em>
<a name="228" href="#228">228</a> <em> */</em>
<a name="229" href="#229">229</a> <strong>protected</strong> List getExternalDeclarations() {
<a name="230" href="#230">230</a> List decls = <strong>new</strong> ArrayList();
<a name="231" href="#231">231</a>
<a name="232" href="#232">232</a> decls.add(<strong>new</strong> ElementDecl(<span class="string">"another-greeting"</span>, <span class="string">"(#PCDATA)"</span>));
<a name="233" href="#233">233</a>
<a name="234" href="#234">234</a> <strong>return</strong> decls;
<a name="235" href="#235">235</a> }
<a name="236" href="#236">236</a>
<a name="237" href="#237">237</a> <em>/**<em>*</em></em>
<a name="238" href="#238">238</a> <em> * Test helper method compares the expected and actual {@link DocumentType}</em>
<a name="239" href="#239">239</a> <em> * objects, including their internal and external DTD subsets.</em>
<a name="240" href="#240">240</a> <em> * </em>
<a name="241" href="#241">241</a> <em> * <p></em>
<a name="242" href="#242">242</a> <em> * </p></em>
<a name="243" href="#243">243</a> <em> * </em>
<a name="244" href="#244">244</a> <em> * @param expected</em>
<a name="245" href="#245">245</a> <em> * DOCUMENT ME!</em>
<a name="246" href="#246">246</a> <em> * @param actual</em>
<a name="247" href="#247">247</a> <em> * DOCUMENT ME!</em>
<a name="248" href="#248">248</a> <em> */</em>
<a name="249" href="#249">249</a> <strong>protected</strong> <strong>void</strong> assertSameDocumentType(DocumentType expected,
<a name="250" href="#250">250</a> DocumentType actual) {
<a name="251" href="#251">251</a> <em class="comment">/*</em>
<a name="252" href="#252">252</a> <em class="comment"> * Nothing expected?</em>
<a name="253" href="#253">253</a> <em class="comment"> */</em>
<a name="254" href="#254">254</a> <strong>if</strong> (expected == <strong>null</strong>) {
<a name="255" href="#255">255</a> <strong>if</strong> (actual == <strong>null</strong>) {
<a name="256" href="#256">256</a> <strong>return</strong>; <em class="comment">// Nothing found.</em>
<a name="257" href="#257">257</a> } <strong>else</strong> {
<a name="258" href="#258">258</a> fail(<span class="string">"Not expecting DOCTYPE."</span>);
<a name="259" href="#259">259</a> }
<a name="260" href="#260">260</a> } <strong>else</strong> {
<a name="261" href="#261">261</a> <em class="comment">/*</em>
<a name="262" href="#262">262</a> <em class="comment"> * Something expected.</em>
<a name="263" href="#263">263</a> <em class="comment"> */</em>
<a name="264" href="#264">264</a> <strong>if</strong> (actual == <strong>null</strong>) {
<a name="265" href="#265">265</a> fail(<span class="string">"Expecting DOCTYPE"</span>);
<a name="266" href="#266">266</a> }
<a name="267" href="#267">267</a>
<a name="268" href="#268">268</a> log(<span class="string">"Expected DocumentType:\n"</span> + expected.toString());
<a name="269" href="#269">269</a>
<a name="270" href="#270">270</a> log(<span class="string">"Actual DocumentType:\n"</span> + actual.toString());
<a name="271" href="#271">271</a>
<a name="272" href="#272">272</a> <em class="comment">// Check the internal DTD subset.</em>
<a name="273" href="#273">273</a> assertSameDTDSubset(<span class="string">"Internal"</span>, expected.getInternalDeclarations(),
<a name="274" href="#274">274</a> actual.getInternalDeclarations());
<a name="275" href="#275">275</a>
<a name="276" href="#276">276</a> <em class="comment">// Check the external DTD subset.</em>
<a name="277" href="#277">277</a> assertSameDTDSubset(<span class="string">"External"</span>, expected.getExternalDeclarations(),
<a name="278" href="#278">278</a> actual.getExternalDeclarations());
<a name="279" href="#279">279</a> }
<a name="280" href="#280">280</a> }
<a name="281" href="#281">281</a>
<a name="282" href="#282">282</a> <em>/**<em>*</em></em>
<a name="283" href="#283">283</a> <em> * Test helper method compares an expected set of DTD declarations with an</em>
<a name="284" href="#284">284</a> <em> * actual set of DTD declarations. This method should be invoked seperately</em>
<a name="285" href="#285">285</a> <em> * for the internal DTD subset and the external DTD subset. The declarations</em>
<a name="286" href="#286">286</a> <em> * must occur in their logical ordering. See <a</em>
<a name="287" href="#287">287</a> <em> * href="<a href="http://tinyurl.com/5jhd8" target="alexandria_uri">http://tinyurl.com/5jhd8</a>">Lexical Handler </a> for conformance</em>
<a name="288" href="#288">288</a> <em> * criteria.</em>
<a name="289" href="#289">289</a> <em> * </em>
<a name="290" href="#290">290</a> <em> * @param txt</em>
<a name="291" href="#291">291</a> <em> * DOCUMENT ME!</em>
<a name="292" href="#292">292</a> <em> * @param expected</em>
<a name="293" href="#293">293</a> <em> * DOCUMENT ME!</em>
<a name="294" href="#294">294</a> <em> * @param actual</em>
<a name="295" href="#295">295</a> <em> * DOCUMENT ME!</em>
<a name="296" href="#296">296</a> <em> * </em>
<a name="297" href="#297">297</a> <em> * @throws AssertionError</em>
<a name="298" href="#298">298</a> <em> * DOCUMENT ME!</em>
<a name="299" href="#299">299</a> <em> */</em>
<a name="300" href="#300">300</a> <strong>protected</strong> <strong>void</strong> assertSameDTDSubset(String txt, List expected, List actual) {
<a name="301" href="#301">301</a> <em class="comment">/*</em>
<a name="302" href="#302">302</a> <em class="comment"> * Nothing expected?</em>
<a name="303" href="#303">303</a> <em class="comment"> */</em>
<a name="304" href="#304">304</a> <strong>if</strong> (expected == <strong>null</strong>) {
<a name="305" href="#305">305</a> <strong>if</strong> (actual == <strong>null</strong>) {
<a name="306" href="#306">306</a> <strong>return</strong>; <em class="comment">// Nothing found.</em>
<a name="307" href="#307">307</a> } <strong>else</strong> {
<a name="308" href="#308">308</a> fail(<span class="string">"Not expecting "</span> + txt + <span class="string">" DTD subset."</span>);
<a name="309" href="#309">309</a> }
<a name="310" href="#310">310</a> } <strong>else</strong> {
<a name="311" href="#311">311</a> <em class="comment">/*</em>
<a name="312" href="#312">312</a> <em class="comment"> * Something expected.</em>
<a name="313" href="#313">313</a> <em class="comment"> */</em>
<a name="314" href="#314">314</a> <strong>if</strong> (actual == <strong>null</strong>) {
<a name="315" href="#315">315</a> fail(<span class="string">"Expecting "</span> + txt + <span class="string">" DTD subset."</span>);
<a name="316" href="#316">316</a> }
<a name="317" href="#317">317</a>
<a name="318" href="#318">318</a> <em class="comment">/*</em>
<a name="319" href="#319">319</a> <em class="comment"> * Correct #of declarations found?</em>
<a name="320" href="#320">320</a> <em class="comment"> */</em>
<a name="321" href="#321">321</a> assertEquals(txt + <span class="string">" DTD subset has correct #of declarations"</span>
<a name="322" href="#322">322</a> + <span class="string">": expected=["</span> + expected.toString() + <span class="string">"]"</span> + <span class="string">", actual=["</span>
<a name="323" href="#323">323</a> + actual.toString() + <span class="string">"]"</span>, expected.size(), actual.size());
<a name="324" href="#324">324</a>
<a name="325" href="#325">325</a> <em class="comment">/*</em>
<a name="326" href="#326">326</a> <em class="comment"> * Check order, type, and values of each declaration. Serialization</em>
<a name="327" href="#327">327</a> <em class="comment"> * tests are done separately.</em>
<a name="328" href="#328">328</a> <em class="comment"> */</em>
<a name="329" href="#329">329</a> Iterator itr1 = expected.iterator();
<a name="330" href="#330">330</a>
<a name="331" href="#331">331</a> Iterator itr2 = actual.iterator();
<a name="332" href="#332">332</a>
<a name="333" href="#333">333</a> <strong>while</strong> (itr1.hasNext()) {
<a name="334" href="#334">334</a> Object obj1 = itr1.next();
<a name="335" href="#335">335</a>
<a name="336" href="#336">336</a> Object obj2 = itr2.next();
<a name="337" href="#337">337</a>
<a name="338" href="#338">338</a> assertEquals(txt + <span class="string">" DTD subset: Same type of declaration"</span>,
<a name="339" href="#339">339</a> obj1.getClass().getName(), obj2.getClass().getName());
<a name="340" href="#340">340</a>
<a name="341" href="#341">341</a> <strong>if</strong> (obj1 instanceof AttributeDecl) {
<a name="342" href="#342">342</a> assertSameDecl((AttributeDecl) obj1, (AttributeDecl) obj2);
<a name="343" href="#343">343</a> } <strong>else</strong> <strong>if</strong> (obj1 instanceof ElementDecl) {
<a name="344" href="#344">344</a> assertSameDecl((ElementDecl) obj1, (ElementDecl) obj2);
<a name="345" href="#345">345</a> } <strong>else</strong> <strong>if</strong> (obj1 instanceof InternalEntityDecl) {
<a name="346" href="#346">346</a> assertSameDecl((InternalEntityDecl) obj1,
<a name="347" href="#347">347</a> (InternalEntityDecl) obj2);
<a name="348" href="#348">348</a> } <strong>else</strong> <strong>if</strong> (obj1 instanceof ExternalEntityDecl) {
<a name="349" href="#349">349</a> assertSameDecl((ExternalEntityDecl) obj1,
<a name="350" href="#350">350</a> (ExternalEntityDecl) obj2);
<a name="351" href="#351">351</a> } <strong>else</strong> {
<a name="352" href="#352">352</a> <strong>throw</strong> <strong>new</strong> AssertionError(<span class="string">"Unexpected declaration type: "</span>
<a name="353" href="#353">353</a> + obj1.getClass());
<a name="354" href="#354">354</a> }
<a name="355" href="#355">355</a> }
<a name="356" href="#356">356</a> }
<a name="357" href="#357">357</a> }
<a name="358" href="#358">358</a>
<a name="359" href="#359">359</a> <em>/**<em>*</em></em>
<a name="360" href="#360">360</a> <em> * Test helper method compares an expected and an actual {@link</em>
<a name="361" href="#361">361</a> <em> * AttributeDecl}.</em>
<a name="362" href="#362">362</a> <em> * </em>
<a name="363" href="#363">363</a> <em> * @param expected</em>
<a name="364" href="#364">364</a> <em> * DOCUMENT ME!</em>
<a name="365" href="#365">365</a> <em> * @param actual</em>
<a name="366" href="#366">366</a> <em> * DOCUMENT ME!</em>
<a name="367" href="#367">367</a> <em> */</em>
<a name="368" href="#368">368</a> <strong>public</strong> <strong>void</strong> assertSameDecl(AttributeDecl expected, AttributeDecl actual) {
<a name="369" href="#369">369</a> assertEquals(<span class="string">"attributeName is correct"</span>, expected.getAttributeName(),
<a name="370" href="#370">370</a> actual.getAttributeName());
<a name="371" href="#371">371</a>
<a name="372" href="#372">372</a> assertEquals(<span class="string">"elementName is correct"</span>, expected.getElementName(),
<a name="373" href="#373">373</a> actual.getElementName());
<a name="374" href="#374">374</a>
<a name="375" href="#375">375</a> assertEquals(<span class="string">"type is correct"</span>, expected.getType(), actual.getType());
<a name="376" href="#376">376</a>
<a name="377" href="#377">377</a> assertEquals(<span class="string">"value is not correct"</span>, expected.getValue(), actual
<a name="378" href="#378">378</a> .getValue());
<a name="379" href="#379">379</a>
<a name="380" href="#380">380</a> assertEquals(<span class="string">"valueDefault is correct"</span>, expected.getValueDefault(),
<a name="381" href="#381">381</a> actual.getValueDefault());
<a name="382" href="#382">382</a>
<a name="383" href="#383">383</a> assertEquals(<span class="string">"toString() is correct"</span>, expected.toString(), actual
<a name="384" href="#384">384</a> .toString());
<a name="385" href="#385">385</a> }
<a name="386" href="#386">386</a>
<a name="387" href="#387">387</a> <em>/**<em>*</em></em>
<a name="388" href="#388">388</a> <em> * Test helper method compares an expected and an actual {@link</em>
<a name="389" href="#389">389</a> <em> * ElementDecl}.</em>
<a name="390" href="#390">390</a> <em> * </em>
<a name="391" href="#391">391</a> <em> * @param expected</em>
<a name="392" href="#392">392</a> <em> * DOCUMENT ME!</em>
<a name="393" href="#393">393</a> <em> * @param actual</em>
<a name="394" href="#394">394</a> <em> * DOCUMENT ME!</em>
<a name="395" href="#395">395</a> <em> */</em>
<a name="396" href="#396">396</a> <strong>protected</strong> <strong>void</strong> assertSameDecl(ElementDecl expected, ElementDecl actual) {
<a name="397" href="#397">397</a> assertEquals(<span class="string">"name is correct"</span>, expected.getName(), actual.getName());
<a name="398" href="#398">398</a>
<a name="399" href="#399">399</a> assertEquals(<span class="string">"model is not correct"</span>, expected.getModel(), actual
<a name="400" href="#400">400</a> .getModel());
<a name="401" href="#401">401</a>
<a name="402" href="#402">402</a> assertEquals(<span class="string">"toString() is correct"</span>, expected.toString(), actual
<a name="403" href="#403">403</a> .toString());
<a name="404" href="#404">404</a> }
<a name="405" href="#405">405</a>
<a name="406" href="#406">406</a> <em>/**<em>*</em></em>
<a name="407" href="#407">407</a> <em> * Test helper method compares an expected and an actual {@link</em>
<a name="408" href="#408">408</a> <em> * InternalEntityDecl}.</em>
<a name="409" href="#409">409</a> <em> * </em>
<a name="410" href="#410">410</a> <em> * @param expected</em>
<a name="411" href="#411">411</a> <em> * DOCUMENT ME!</em>
<a name="412" href="#412">412</a> <em> * @param actual</em>
<a name="413" href="#413">413</a> <em> * DOCUMENT ME!</em>
<a name="414" href="#414">414</a> <em> */</em>
<a name="415" href="#415">415</a> <strong>protected</strong> <strong>void</strong> assertSameDecl(InternalEntityDecl expected,
<a name="416" href="#416">416</a> InternalEntityDecl actual) {
<a name="417" href="#417">417</a> assertEquals(<span class="string">"name is correct"</span>, expected.getName(), actual.getName());
<a name="418" href="#418">418</a>
<a name="419" href="#419">419</a> assertEquals(<span class="string">"value is not correct"</span>, expected.getValue(), actual
<a name="420" href="#420">420</a> .getValue());
<a name="421" href="#421">421</a>
<a name="422" href="#422">422</a> assertEquals(<span class="string">"toString() is correct"</span>, expected.toString(), actual
<a name="423" href="#423">423</a> .toString());
<a name="424" href="#424">424</a> }
<a name="425" href="#425">425</a>
<a name="426" href="#426">426</a> <em>/**<em>*</em></em>
<a name="427" href="#427">427</a> <em> * Test helper method compares an expected and an actual {@link</em>
<a name="428" href="#428">428</a> <em> * ExternalEntityDecl}.</em>
<a name="429" href="#429">429</a> <em> * </em>
<a name="430" href="#430">430</a> <em> * @param expected</em>
<a name="431" href="#431">431</a> <em> * DOCUMENT ME!</em>
<a name="432" href="#432">432</a> <em> * @param actual</em>
<a name="433" href="#433">433</a> <em> * DOCUMENT ME!</em>
<a name="434" href="#434">434</a> <em> */</em>
<a name="435" href="#435">435</a> <strong>protected</strong> <strong>void</strong> assertSameDecl(ExternalEntityDecl expected,
<a name="436" href="#436">436</a> ExternalEntityDecl actual) {
<a name="437" href="#437">437</a> assertEquals(<span class="string">"name is correct"</span>, expected.getName(), actual.getName());
<a name="438" href="#438">438</a>
<a name="439" href="#439">439</a> assertEquals(<span class="string">"publicID is correct"</span>, expected.getPublicID(), actual
<a name="440" href="#440">440</a> .getPublicID());
<a name="441" href="#441">441</a>
<a name="442" href="#442">442</a> assertEquals(<span class="string">"systemID is correct"</span>, expected.getSystemID(), actual
<a name="443" href="#443">443</a> .getSystemID());
<a name="444" href="#444">444</a>
<a name="445" href="#445">445</a> assertEquals(<span class="string">"toString() is correct"</span>, expected.toString(), actual
<a name="446" href="#446">446</a> .toString());
<a name="447" href="#447">447</a> }
<a name="448" href="#448">448</a>
<a name="449" href="#449">449</a> <em>/**<em>*</em></em>
<a name="450" href="#450">450</a> <em> * Helper method reads a local resource and parses it as an XML document.</em>
<a name="451" href="#451">451</a> <em> * The internal and external DTD subsets are optionally retained by the</em>
<a name="452" href="#452">452</a> <em> * parser and exposed via the {@link DocumentType}object on the returned</em>
<a name="453" href="#453">453</a> <em> * {@link Document}. The parser is configured with an {@link</em>
<a name="454" href="#454">454</a> <em> * EntityResolver}that knows how to find the local resource identified by</em>
<a name="455" href="#455">455</a> <em> * {@link #DTD_FILE}whose SYSTEM identifier is given by {@link</em>
<a name="456" href="#456">456</a> <em> * #DTD_SYSTEM_ID}.</em>
<a name="457" href="#457">457</a> <em> * </em>
<a name="458" href="#458">458</a> <em> * @param resourceName</em>
<a name="459" href="#459">459</a> <em> * DOCUMENT ME!</em>
<a name="460" href="#460">460</a> <em> * @param includeInternal</em>
<a name="461" href="#461">461</a> <em> * DOCUMENT ME!</em>
<a name="462" href="#462">462</a> <em> * @param includeExternal</em>
<a name="463" href="#463">463</a> <em> * DOCUMENT ME!</em>
<a name="464" href="#464">464</a> <em> * </em>
<a name="465" href="#465">465</a> <em> * @return DOCUMENT ME!</em>
<a name="466" href="#466">466</a> <em> * </em>
<a name="467" href="#467">467</a> <em> * @throws Exception</em>
<a name="468" href="#468">468</a> <em> * DOCUMENT ME!</em>
<a name="469" href="#469">469</a> <em> */</em>
<a name="470" href="#470">470</a> <strong>protected</strong> Document readDocument(String resourceName,
<a name="471" href="#471">471</a> <strong>boolean</strong> includeInternal, <strong>boolean</strong> includeExternal) throws Exception {
<a name="472" href="#472">472</a> SAXReader reader = <strong>new</strong> SAXReader();
<a name="473" href="#473">473</a>
<a name="474" href="#474">474</a> reader.setIncludeInternalDTDDeclarations(includeInternal);
<a name="475" href="#475">475</a>
<a name="476" href="#476">476</a> reader.setIncludeExternalDTDDeclarations(includeExternal);
<a name="477" href="#477">477</a>
<a name="478" href="#478">478</a> reader.setEntityResolver(<strong>new</strong> MyEntityResolver(DTD_FILE,
<a name="479" href="#479">479</a> DTD_PUBLICID, DTD_SYSTEM_ID));
<a name="480" href="#480">480</a>
<a name="481" href="#481">481</a> <strong>return</strong> getDocument(resourceName, reader);
<a name="482" href="#482">482</a> }
<a name="483" href="#483">483</a>
<a name="484" href="#484">484</a> <em>/**<em>*</em></em>
<a name="485" href="#485">485</a> <em> * Provides a resolver for the local test DTD resource.</em>
<a name="486" href="#486">486</a> <em> */</em>
<a name="487" href="#487">487</a> <strong>protected</strong> <strong>static</strong> <strong>class</strong> MyEntityResolver implements EntityResolver {
<a name="488" href="#488">488</a> <strong>private</strong> String resourceName;
<a name="489" href="#489">489</a>
<a name="490" href="#490">490</a> <strong>private</strong> String pubId;
<a name="491" href="#491">491</a>
<a name="492" href="#492">492</a> <strong>private</strong> String sysId;
<a name="493" href="#493">493</a>
<a name="494" href="#494">494</a> <strong>public</strong> MyEntityResolver(String localResourceName, String <strong>public</strong>Id,
<a name="495" href="#495">495</a> String systemId) {
<a name="496" href="#496">496</a> resourceName = localResourceName;
<a name="497" href="#497">497</a>
<a name="498" href="#498">498</a> sysId = systemId;
<a name="499" href="#499">499</a> }
<a name="500" href="#500">500</a>
<a name="501" href="#501">501</a> <strong>public</strong> InputSource resolveEntity(String <strong>public</strong>Id, String systemId)
<a name="502" href="#502">502</a> throws SAXException, IOException {
<a name="503" href="#503">503</a> <strong>if</strong> (pubId != <strong>null</strong>) {
<a name="504" href="#504">504</a> <strong>if</strong> (pubId.equals(publicId)) {
<a name="505" href="#505">505</a> <strong>return</strong> <strong>new</strong> InputSource(getInputStream(resourceName));
<a name="506" href="#506">506</a> }
<a name="507" href="#507">507</a> }
<a name="508" href="#508">508</a>
<a name="509" href="#509">509</a> <strong>if</strong> (sysId.equals(systemId)) {
<a name="510" href="#510">510</a> <strong>return</strong> <strong>new</strong> InputSource(getInputStream(resourceName));
<a name="511" href="#511">511</a> } <strong>else</strong> {
<a name="512" href="#512">512</a> <strong>return</strong> <strong>null</strong>;
<a name="513" href="#513">513</a> }
<a name="514" href="#514">514</a> }
<a name="515" href="#515">515</a>
<a name="516" href="#516">516</a> <em>/**<em>*</em></em>
<a name="517" href="#517">517</a> <em> * Returns an {@link InputStream}that will read from the indicated</em>
<a name="518" href="#518">518</a> <em> * local resource.</em>
<a name="519" href="#519">519</a> <em> * </em>
<a name="520" href="#520">520</a> <em> * @param localResourceName</em>
<a name="521" href="#521">521</a> <em> * DOCUMENT ME!</em>
<a name="522" href="#522">522</a> <em> * </em>
<a name="523" href="#523">523</a> <em> * @return DOCUMENT ME!</em>
<a name="524" href="#524">524</a> <em> * </em>
<a name="525" href="#525">525</a> <em> * @throws IOException</em>
<a name="526" href="#526">526</a> <em> * DOCUMENT ME!</em>
<a name="527" href="#527">527</a> <em> */</em>
<a name="528" href="#528">528</a> <strong>protected</strong> InputStream getInputStream(String localResourceName)
<a name="529" href="#529">529</a> throws IOException {
<a name="530" href="#530">530</a> InputStream is = <strong>new</strong> FileInputStream(localResourceName);
<a name="531" href="#531">531</a>
<a name="532" href="#532">532</a> <strong>return</strong> is;
<a name="533" href="#533">533</a> }
<a name="534" href="#534">534</a> }
<a name="535" href="#535">535</a> }
<a name="536" href="#536">536</a>
<a name="537" href="#537">537</a> <em class="comment">/*</em>
<a name="538" href="#538">538</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="539" href="#539">539</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="540" href="#540">540</a> <em class="comment"> * following conditions are met:</em>
<a name="541" href="#541">541</a> <em class="comment"> * </em>
<a name="542" href="#542">542</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="543" href="#543">543</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="544" href="#544">544</a> <em class="comment"> * </em>
<a name="545" href="#545">545</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="546" href="#546">546</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="547" href="#547">547</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="548" href="#548">548</a> <em class="comment"> * </em>
<a name="549" href="#549">549</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="550" href="#550">550</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="551" href="#551">551</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="552" href="#552">552</a> <em class="comment"> * </em>
<a name="553" href="#553">553</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="554" href="#554">554</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="555" href="#555">555</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="556" href="#556">556</a> <em class="comment"> * </em>
<a name="557" href="#557">557</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="558" href="#558">558</a> <em class="comment"> * </em>
<a name="559" href="#559">559</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="560" href="#560">560</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="561" href="#561">561</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="562" href="#562">562</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="563" href="#563">563</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="564" href="#564">564</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="565" href="#565">565</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="566" href="#566">566</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="567" href="#567">567</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="568" href="#568">568</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="569" href="#569">569</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="570" href="#570">570</a> <em class="comment"> * </em>
<a name="571" href="#571">571</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="572" href="#572">572</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>
