📄 archiverecordheader.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>ArchiveRecordHeader xref</title><link type="text/css" rel="stylesheet" href="../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../apidocs/org/archive/io/ArchiveRecordHeader.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> $Id: ArchiveRecordHeader.java,v 1.3 2006/08/28 23:44:16 stack-sf Exp $</em></em><a name="2" href="#2">2</a> <em class="comment"> *</em><a name="3" href="#3">3</a> <em class="comment"> * Created on August 21st, 2006</em><a name="4" href="#4">4</a> <em class="comment"> *</em><a name="5" href="#5">5</a> <em class="comment"> * Copyright (C) 2006 Internet Archive.</em><a name="6" href="#6">6</a> <em class="comment"> *</em><a name="7" href="#7">7</a> <em class="comment"> * This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="8" href="#8">8</a> <em class="comment"> *</em><a name="9" href="#9">9</a> <em class="comment"> * Heritrix is free software; you can redistribute it and/or modify</em><a name="10" href="#10">10</a> <em class="comment"> * it under the terms of the GNU Lesser Public License as published by</em><a name="11" href="#11">11</a> <em class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</em><a name="12" href="#12">12</a> <em class="comment"> * any later version.</em><a name="13" href="#13">13</a> <em class="comment"> *</em><a name="14" href="#14">14</a> <em class="comment"> * Heritrix is distributed in the hope that it will be useful,</em><a name="15" href="#15">15</a> <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="16" href="#16">16</a> <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="17" href="#17">17</a> <em class="comment"> * GNU Lesser Public License for more details.</em><a name="18" href="#18">18</a> <em class="comment"> *</em><a name="19" href="#19">19</a> <em class="comment"> * You should have received a copy of the GNU Lesser Public License</em><a name="20" href="#20">20</a> <em class="comment"> * along with Heritrix; if not, write to the Free Software</em><a name="21" href="#21">21</a> <em class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="22" href="#22">22</a> <em class="comment"> */</em><a name="23" href="#23">23</a> <strong>package</strong> <a href="../../../org/archive/io/package-summary.html">org.archive.io</a>;<a name="24" href="#24">24</a> <a name="25" href="#25">25</a> <strong>import</strong> java.util.Map;<a name="26" href="#26">26</a> <strong>import</strong> java.util.Set;<a name="27" href="#27">27</a> <a name="28" href="#28">28</a> <em>/**<em>*</em></em><a name="29" href="#29">29</a> <em> * Archive Record Header.</em><a name="30" href="#30">30</a> <em> * @author stack</em><a name="31" href="#31">31</a> <em> * @version $Date: 2006/08/28 23:44:16 $ $Version$</em><a name="32" href="#32">32</a> <em> */</em><a name="33" href="#33">33</a> <strong>public</strong> <strong>interface</strong> <a href="../../../org/archive/io/ArchiveRecordHeader.html">ArchiveRecordHeader</a> {<a name="34" href="#34">34</a> <em>/**<em>*</em></em><a name="35" href="#35">35</a> <em> * Get the time when the record was created.</em><a name="36" href="#36">36</a> <em> * @return Date in 14 digit time format (UTC).</em><a name="37" href="#37">37</a> <em> * @see org.archive.util.ArchiveUtils#parse14DigitDate(String)</em><a name="38" href="#38">38</a> <em> */</em><a name="39" href="#39">39</a> <strong>public</strong> <strong>abstract</strong> String getDate();<a name="40" href="#40">40</a> <a name="41" href="#41">41</a> <em>/**<em>*</em></em><a name="42" href="#42">42</a> <em> * @return Return length of record.</em><a name="43" href="#43">43</a> <em> */</em><a name="44" href="#44">44</a> <strong>public</strong> <strong>abstract</strong> <strong>long</strong> getLength();<a name="45" href="#45">45</a> <a name="46" href="#46">46</a> <em>/**<em>*</em></em><a name="47" href="#47">47</a> <em> * @return Record subject-url.</em><a name="48" href="#48">48</a> <em> */</em><a name="49" href="#49">49</a> <strong>public</strong> <strong>abstract</strong> String getUrl();<a name="50" href="#50">50</a> <a name="51" href="#51">51</a> <em>/**<em>*</em></em><a name="52" href="#52">52</a> <em> * @return Record mimetype.</em><a name="53" href="#53">53</a> <em> */</em><a name="54" href="#54">54</a> <strong>public</strong> <strong>abstract</strong> String getMimetype();<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> * @return Record version.</em><a name="58" href="#58">58</a> <em> */</em><a name="59" href="#59">59</a> <strong>public</strong> <strong>abstract</strong> String getVersion();<a name="60" href="#60">60</a> <a name="61" href="#61">61</a> <em>/**<em>*</em></em><a name="62" href="#62">62</a> <em> * @return Offset into Archive file at which this record begins.</em><a name="63" href="#63">63</a> <em> */</em><a name="64" href="#64">64</a> <strong>public</strong> <strong>abstract</strong> <strong>long</strong> getOffset();<a name="65" href="#65">65</a> <a name="66" href="#66">66</a> <em>/**<em>*</em></em><a name="67" href="#67">67</a> <em> * @param key Key to use looking up field value.</em><a name="68" href="#68">68</a> <em> * @return value for passed key of null if no such entry.</em><a name="69" href="#69">69</a> <em> */</em><a name="70" href="#70">70</a> <strong>public</strong> <strong>abstract</strong> Object getHeaderValue(<strong>final</strong> String key);<a name="71" href="#71">71</a> <a name="72" href="#72">72</a> <em>/**<em>*</em></em><a name="73" href="#73">73</a> <em> * @return Header field name keys.</em><a name="74" href="#74">74</a> <em> */</em><a name="75" href="#75">75</a> <strong>public</strong> <strong>abstract</strong> Set getHeaderFieldKeys();<a name="76" href="#76">76</a> <a name="77" href="#77">77</a> <em>/**<em>*</em></em><a name="78" href="#78">78</a> <em> * @return Map of header fields.</em><a name="79" href="#79">79</a> <em> */</em><a name="80" href="#80">80</a> <strong>public</strong> <strong>abstract</strong> Map getHeaderFields();<a name="81" href="#81">81</a> <a name="82" href="#82">82</a> <em>/**<em>*</em></em><a name="83" href="#83">83</a> <em> * @return Returns identifier for current Archive file. Be aware this</em><a name="84" href="#84">84</a> <em> * may not be a file name or file path. It may just be an URL. Depends</em><a name="85" href="#85">85</a> <em> * on how Archive file was made.</em><a name="86" href="#86">86</a> <em> */</em><a name="87" href="#87">87</a> <strong>public</strong> <strong>abstract</strong> String getReaderIdentifier();<a name="88" href="#88">88</a> <a name="89" href="#89">89</a> <em>/**<em>*</em></em><a name="90" href="#90">90</a> <em> * @return Identifier for the record. If ARC, the URL + date. If WARC, </em><a name="91" href="#91">91</a> <em> * the GUID assigned.</em><a name="92" href="#92">92</a> <em> */</em><a name="93" href="#93">93</a> <strong>public</strong> <strong>abstract</strong> String getRecordIdentifier();<a name="94" href="#94">94</a> <a name="95" href="#95">95</a> <em>/**<em>*</em></em><a name="96" href="#96">96</a> <em> * @return Returns digest as String for this record. Only available after</em><a name="97" href="#97">97</a> <em> * the record has been read in totality.</em><a name="98" href="#98">98</a> <em> */</em><a name="99" href="#99">99</a> <strong>public</strong> <strong>abstract</strong> String getDigest();<a name="100" href="#100">100</a> <a name="101" href="#101">101</a> <em>/**<em>*</em></em><a name="102" href="#102">102</a> <em> * Offset at which the content begins.</em><a name="103" href="#103">103</a> <em> * For ARCs, its used to delimit where http headers end and content begins.</em><a name="104" href="#104">104</a> <em> * For WARCs, its end of Named Fields before payload starts.</em><a name="105" href="#105">105</a> <em> */</em><a name="106" href="#106">106</a> <strong>public</strong> <strong>int</strong> getContentBegin();<a name="107" href="#107">107</a> <a name="108" href="#108">108</a> <strong>public</strong> <strong>abstract</strong> String toString();<a name="109" href="#109">109</a> }</pre><hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -