📄 anvlrecord.html
字号:
<!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=UTF-8" /><title>ANVLRecord xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/archive/util/anvl/ANVLRecord.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> ANVLRecord</em></em><a name="2" href="#2">2</a> <em class="comment">*</em><a name="3" href="#3">3</a> <em class="comment">* $Id: ANVLRecord.java,v 1.10 2006/08/26 00:33:37 stack-sf Exp $</em><a name="4" href="#4">4</a> <em class="comment">*</em><a name="5" href="#5">5</a> <em class="comment">* Created on July 26, 2006.</em><a name="6" href="#6">6</a> <em class="comment">*</em><a name="7" href="#7">7</a> <em class="comment">* Copyright (C) 2006 Internet Archive.</em><a name="8" href="#8">8</a> <em class="comment">*</em><a name="9" href="#9">9</a> <em class="comment">* This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="10" href="#10">10</a> <em class="comment">*</em><a name="11" href="#11">11</a> <em class="comment">* Heritrix is free software; you can redistribute it and/or modify</em><a name="12" href="#12">12</a> <em class="comment">* it under the terms of the GNU Lesser Public License as published by</em><a name="13" href="#13">13</a> <em class="comment">* the Free Software Foundation; either version 2.1 of the License, or</em><a name="14" href="#14">14</a> <em class="comment">* any later version.</em><a name="15" href="#15">15</a> <em class="comment">*</em><a name="16" href="#16">16</a> <em class="comment">* Heritrix is distributed in the hope that it will be useful,</em><a name="17" href="#17">17</a> <em class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="18" href="#18">18</a> <em class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="19" href="#19">19</a> <em class="comment">* GNU Lesser Public License for more details.</em><a name="20" href="#20">20</a> <em class="comment">*</em><a name="21" href="#21">21</a> <em class="comment">* You should have received a copy of the GNU Lesser Public License</em><a name="22" href="#22">22</a> <em class="comment">* along with Heritrix; if not, write to the Free Software</em><a name="23" href="#23">23</a> <em class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="24" href="#24">24</a> <em class="comment">*/</em><a name="25" href="#25">25</a> <strong>package</strong> <a href="../../../../org/archive/util/anvl/package-summary.html">org.archive.util.anvl</a>;<a name="26" href="#26">26</a> <a name="27" href="#27">27</a> <strong>import</strong> java.io.ByteArrayOutputStream;<a name="28" href="#28">28</a> <strong>import</strong> java.io.IOException;<a name="29" href="#29">29</a> <strong>import</strong> java.io.InputStream;<a name="30" href="#30">30</a> <strong>import</strong> java.io.UnsupportedEncodingException;<a name="31" href="#31">31</a> <strong>import</strong> java.util.ArrayList;<a name="32" href="#32">32</a> <strong>import</strong> java.util.Collection;<a name="33" href="#33">33</a> <strong>import</strong> java.util.HashMap;<a name="34" href="#34">34</a> <strong>import</strong> java.util.Iterator;<a name="35" href="#35">35</a> <strong>import</strong> java.util.List;<a name="36" href="#36">36</a> <strong>import</strong> java.util.Map;<a name="37" href="#37">37</a> <a name="38" href="#38">38</a> <strong>import</strong> org.archive.io.UTF8Bytes;<a name="39" href="#39">39</a> <a name="40" href="#40">40</a> <em>/**<em>*</em></em><a name="41" href="#41">41</a> <em> * An ordered {@link List} with 'data' {@link Element} values.</em><a name="42" href="#42">42</a> <em> * ANVLRecords end with a blank line.</em><a name="43" href="#43">43</a> <em> * </em><a name="44" href="#44">44</a> <em> * @see <a</em><a name="45" href="#45">45</a> <em> * href="<a href="http://www.cdlib.org/inside/diglib/ark/anvlspec.pdf" target="alexandria_uri">http://www.cdlib.org/inside/diglib/ark/anvlspec.pdf</a>">A Name-Value</em><a name="46" href="#46">46</a> <em> * Language (ANVL)</a></em><a name="47" href="#47">47</a> <em> * @author stack</em><a name="48" href="#48">48</a> <em> */</em><a name="49" href="#49">49</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a> <strong>extends</strong> ArrayList<Element> implements UTF8Bytes {<a name="50" href="#50">50</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> serialVersionUID = -4610638888453052958L;<a name="51" href="#51">51</a> <a name="52" href="#52">52</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String MIMETYPE = <span class="string">"text/anvl"</span>;<a name="53" href="#53">53</a> <a name="54" href="#54">54</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a> EMPTY_ANVL_RECORD = <strong>new</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a>();<a name="55" href="#55">55</a> <a name="56" href="#56">56</a> <em>/**<em>*</em></em><a name="57" href="#57">57</a> <em> * Arbitrary upper bound on maximum size of ANVL Record.</em><a name="58" href="#58">58</a> <em> * Will throw an IOException if exceed this size.</em><a name="59" href="#59">59</a> <em> */</em><a name="60" href="#60">60</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> MAXIMUM_SIZE = 1024 * 10;<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> * An ANVL 'newline'.</em><a name="64" href="#64">64</a> <em> * @see <a href="<a href="http://en.wikipedia.org/wiki/CRLF" target="alexandria_uri">http://en.wikipedia.org/wiki/CRLF</a>"><a href="http://en.wikipedia.org/wiki/CRLF" target="alexandria_uri">http://en.wikipedia.org/wiki/CRLF</a></a></em><a name="65" href="#65">65</a> <em> */</em><a name="66" href="#66">66</a> <strong>static</strong> <strong>final</strong> String CRLF = <span class="string">"\r\n"</span>;<a name="67" href="#67">67</a> <a name="68" href="#68">68</a> <strong>static</strong> <strong>final</strong> String FOLD_PREFIX = CRLF + ' ';<a name="69" href="#69">69</a> <a name="70" href="#70">70</a> <strong>public</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a>() {<a name="71" href="#71">71</a> <strong>super</strong>();<a name="72" href="#72">72</a> }<a name="73" href="#73">73</a> <a name="74" href="#74">74</a> <strong>public</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a>(Collection<? <strong>extends</strong> Element> c) {<a name="75" href="#75">75</a> <strong>super</strong>(c);<a name="76" href="#76">76</a> }<a name="77" href="#77">77</a> <a name="78" href="#78">78</a> <strong>public</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a>(<strong>int</strong> initialCapacity) {<a name="79" href="#79">79</a> <strong>super</strong>(initialCapacity);<a name="80" href="#80">80</a> }<a name="81" href="#81">81</a> <a name="82" href="#82">82</a> <strong>public</strong> <strong>boolean</strong> addLabel(<strong>final</strong> String l) {<a name="83" href="#83">83</a> <strong>return</strong> <strong>super</strong>.add(<strong>new</strong> <a href="../../../../org/archive/util/anvl/Element.html">Element</a>(<strong>new</strong> <a href="../../../../org/archive/util/anvl/Label.html">Label</a>(l)));<a name="84" href="#84">84</a> }<a name="85" href="#85">85</a> <a name="86" href="#86">86</a> <strong>public</strong> <strong>boolean</strong> addLabelValue(<strong>final</strong> String l, <strong>final</strong> String v) {<a name="87" href="#87">87</a> <strong>return</strong> <strong>super</strong>.add(<strong>new</strong> <a href="../../../../org/archive/util/anvl/Element.html">Element</a>(<strong>new</strong> <a href="../../../../org/archive/util/anvl/Label.html">Label</a>(l), <strong>new</strong> <a href="../../../../org/archive/util/anvl/Value.html">Value</a>(v)));<a name="88" href="#88">88</a> }<a name="89" href="#89">89</a> <a name="90" href="#90">90</a> @Override<a name="91" href="#91">91</a> <strong>public</strong> String toString() {<a name="92" href="#92">92</a> <em class="comment">// TODO: What to emit for empty ANVLRecord?</em><a name="93" href="#93">93</a> StringBuilder sb = <strong>new</strong> StringBuilder();<a name="94" href="#94">94</a> <strong>for</strong> (<strong>final</strong> Iterator<Element> i = iterator(); i.hasNext();) {<a name="95" href="#95">95</a> sb.append(i.next());<a name="96" href="#96">96</a> sb.append(CRLF);<a name="97" href="#97">97</a> }<a name="98" href="#98">98</a> <em class="comment">// 'ANVL Records end in a blank line'.</em><a name="99" href="#99">99</a> sb.append(CRLF);<a name="100" href="#100">100</a> <strong>return</strong> sb.toString();<a name="101" href="#101">101</a> }<a name="102" href="#102">102</a> <a name="103" href="#103">103</a> <strong>public</strong> Map<String, String> asMap() {<a name="104" href="#104">104</a> Map<String, String> m = <strong>new</strong> HashMap<String, String>(size());<a name="105" href="#105">105</a> <strong>for</strong> (<strong>final</strong> Iterator<Element> i = iterator(); i.hasNext();) {<a name="106" href="#106">106</a> <a href="../../../../org/archive/util/anvl/Element.html">Element</a> e = i.next();<a name="107" href="#107">107</a> m.put(e.getLabel().toString(),<a name="108" href="#108">108</a> e.isValue()? e.getValue().toString(): (String)<strong>null</strong>);<a name="109" href="#109">109</a> }<a name="110" href="#110">110</a> <strong>return</strong> m;<a name="111" href="#111">111</a> }<a name="112" href="#112">112</a> <a name="113" href="#113">113</a> @Override<a name="114" href="#114">114</a> <strong>public</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a> clone() {<a name="115" href="#115">115</a> <strong>return</strong> <strong>new</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a>(<strong>this</strong>);<a name="116" href="#116">116</a> }<a name="117" href="#117">117</a> <a name="118" href="#118">118</a> <em>/**<em>*</em></em><a name="119" href="#119">119</a> <em> * @return This ANVLRecord as UTF8 bytes.</em><a name="120" href="#120">120</a> <em> */</em><a name="121" href="#121">121</a> <strong>public</strong> byte [] getUTF8Bytes()<a name="122" href="#122">122</a> throws UnsupportedEncodingException {<a name="123" href="#123">123</a> <strong>return</strong> toString().getBytes(UTF8);<a name="124" href="#124">124</a> }<a name="125" href="#125">125</a> <a name="126" href="#126">126</a> <em>/**<em>*</em></em><a name="127" href="#127">127</a> <em> * Parses a single ANVLRecord from passed InputStream.</em><a name="128" href="#128">128</a> <em> * Read as a single-byte stream until we get to a CRLFCRLF which</em><a name="129" href="#129">129</a> <em> * signifies End-of-ANVLRecord. Then parse all read as a UTF-8 Stream.</em><a name="130" href="#130">130</a> <em> * Doing it this way, while requiring a double-scan, it makes it so do not</em><a name="131" href="#131">131</a> <em> * need to be passed a RepositionableStream or a Stream that supports</em><a name="132" href="#132">132</a> <em> * marking. Also no danger of over-reading which can happen when we</em><a name="133" href="#133">133</a> <em> * wrap passed Stream with an InputStreamReader for doing UTF-8</em><a name="134" href="#134">134</a> <em> * character conversion (See the ISR class comment).</em><a name="135" href="#135">135</a> <em> * @param is InputStream</em><a name="136" href="#136">136</a> <em> * @return An ANVLRecord instance.</em><a name="137" href="#137">137</a> <em> * @throws IOException</em><a name="138" href="#138">138</a> <em> */</em><a name="139" href="#139">139</a> <strong>public</strong> <strong>static</strong> <a href="../../../../org/archive/util/anvl/ANVLRecord.html">ANVLRecord</a> load(<strong>final</strong> InputStream is)<a name="140" href="#140">140</a> throws IOException {<a name="141" href="#141">141</a> <em class="comment">// It doesn't look like a CRLF sequence is possible in UTF-8 without</em><a name="142" href="#142">142</a> <em class="comment">// it signifying CRLF: The top bits are set in multibyte characters.</em><a name="143" href="#143">143</a> <em class="comment">// Was thinking of recording CRLF as I was running through this first</em><a name="144" href="#144">144</a> <em class="comment">// parse but the offsets would then be incorrect if any multibyte</em><a name="145" href="#145">145</a> <em class="comment">// characters in the intervening gaps between CRLF.</em><a name="146" href="#146">146</a> <strong>boolean</strong> isCRLF = false;<a name="147" href="#147">147</a> <strong>boolean</strong> recordStart = false;<a name="148" href="#148">148</a> ByteArrayOutputStream baos = <strong>new</strong> ByteArrayOutputStream(1024);<a name="149" href="#149">149</a> <strong>boolean</strong> done = false;<a name="150" href="#150">150</a> <strong>int</strong> read = 0;<a name="151" href="#151">151</a> <strong>for</strong> (<strong>int</strong> c = -1, previousCharacter; !done;) {<a name="152" href="#152">152</a> <strong>if</strong> (read++ >= MAXIMUM_SIZE) {<a name="153" href="#153">153</a> <strong>throw</strong> <strong>new</strong> IOException(<span class="string">"Read "</span> + MAXIMUM_SIZE +<a name="154" href="#154">154</a> <span class="string">" bytes without finding //r//n//r//n "</span> +<a name="155" href="#155">155</a> <span class="string">"End-Of-ANVLRecord"</span>);<a name="156" href="#156">156</a> }<a name="157" href="#157">157</a> previousCharacter = c;<a name="158" href="#158">158</a> c = is.read();<a name="159" href="#159">159</a> <strong>if</strong> (c == -1) {<a name="160" href="#160">160</a> <strong>throw</strong> <strong>new</strong> IOException(<span class="string">"End-Of-Stream before //r//n//r//n "</span> +<a name="161" href="#161">161</a> <span class="string">"End-Of-ANVLRecord:\n"</span> +<a name="162" href="#162">162</a> <strong>new</strong> String(baos.toByteArray(), UTF8));<a name="163" href="#163">163</a> }<a name="164" href="#164">164</a> <strong>if</strong> (isLF((<strong>char</strong>)c) && isCR((<strong>char</strong>)previousCharacter)) {<a name="165" href="#165">165</a> <strong>if</strong> (isCRLF) {⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -