?? surtprefixeddeciderule.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>SurtPrefixedDecideRule xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/archive/crawler/deciderules/SurtPrefixedDecideRule.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> SurtPrefixedDecideRule</em></em><a name="2" href="#2">2</a> <em class="comment">*</em><a name="3" href="#3">3</a> <em class="comment">* $Id: SurtPrefixedDecideRule.java 4649 2006-09-25 17:16:55Z paul_jack $</em><a name="4" href="#4">4</a> <em class="comment">*</em><a name="5" href="#5">5</a> <em class="comment">* Created on Apr 5, 2005</em><a name="6" href="#6">6</a> <em class="comment">*</em><a name="7" href="#7">7</a> <em class="comment">* Copyright (C) 2005 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/crawler/deciderules/package-summary.html">org.archive.crawler.deciderules</a>;<a name="26" href="#26">26</a> <a name="27" href="#27">27</a> <strong>import</strong> java.io.File;<a name="28" href="#28">28</a> <strong>import</strong> java.io.FileReader;<a name="29" href="#29">29</a> <strong>import</strong> java.io.FileWriter;<a name="30" href="#30">30</a> <strong>import</strong> java.io.IOException;<a name="31" href="#31">31</a> <a name="32" href="#32">32</a> <strong>import</strong> org.archive.crawler.datamodel.CandidateURI;<a name="33" href="#33">33</a> <strong>import</strong> org.archive.crawler.framework.CrawlScope;<a name="34" href="#34">34</a> <strong>import</strong> org.archive.crawler.scope.SeedListener;<a name="35" href="#35">35</a> <strong>import</strong> org.archive.crawler.settings.SimpleType;<a name="36" href="#36">36</a> <strong>import</strong> org.archive.crawler.settings.Type;<a name="37" href="#37">37</a> <strong>import</strong> org.archive.util.SurtPrefixSet;<a name="38" href="#38">38</a> <a name="39" href="#39">39</a> <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> * Rule applies configured decision to any URIs that, when </em><a name="43" href="#43">43</a> <em> * expressed in SURT form, begin with one of the prefixes</em><a name="44" href="#44">44</a> <em> * in the configured set. </em><a name="45" href="#45">45</a> <em> * </em><a name="46" href="#46">46</a> <em> * The set can be filled with SURT prefixes implied or</em><a name="47" href="#47">47</a> <em> * listed in the seeds file, or another external file. </em><a name="48" href="#48">48</a> <em> *</em><a name="49" href="#49">49</a> <em> * The "also-check-via" option to implement "one hop off" </em><a name="50" href="#50">50</a> <em> * scoping derives from a contribution by Shifra Raffel</em><a name="51" href="#51">51</a> <em> * of the California Digital Library. </em><a name="52" href="#52">52</a> <em> * </em><a name="53" href="#53">53</a> <em> * @author gojomo</em><a name="54" href="#54">54</a> <em> */</em><a name="55" href="#55">55</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/archive/crawler/deciderules/SurtPrefixedDecideRule.html">SurtPrefixedDecideRule</a> <strong>extends</strong> <a href="../../../../org/archive/crawler/deciderules/PredicatedDecideRule.html">PredicatedDecideRule</a> <a name="56" href="#56">56</a> implements <a href="../../../../org/archive/crawler/scope/SeedListener.html">SeedListener</a> {<a name="57" href="#57">57</a> <a name="58" href="#58">58</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> serialVersionUID = 2075790126085405015L;<a name="59" href="#59">59</a> <a name="60" href="#60">60</a> <em class="comment">//private static final Logger logger =</em><a name="61" href="#61">61</a> <em class="comment">// Logger.getLogger(SurtPrefixedDecideRule.class.getName());</em><a name="62" href="#62">62</a> <a name="63" href="#63">63</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String ATTR_SURTS_SOURCE_FILE = <span class="string">"surts-source-file"</span>;<a name="64" href="#64">64</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String ATTR_SEEDS_AS_SURT_PREFIXES =<a name="65" href="#65">65</a> <span class="string">"seeds-as-surt-prefixes"</span>;<a name="66" href="#66">66</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String ATTR_SURTS_DUMP_FILE = <span class="string">"surts-dump-file"</span>;<a name="67" href="#67">67</a> <a name="68" href="#68">68</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> Boolean DEFAULT_SEEDS_AS_SURT_PREFIXES =<a name="69" href="#69">69</a> <strong>new</strong> Boolean(<strong>true</strong>);<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> * Whether every config change should trigger a </em><a name="73" href="#73">73</a> <em> * rebuilding of the prefix set.</em><a name="74" href="#74">74</a> <em> */</em><a name="75" href="#75">75</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String <a name="76" href="#76">76</a> ATTR_REBUILD_ON_RECONFIG = <span class="string">"rebuild-on-reconfig"</span>;<a name="77" href="#77">77</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> Boolean<a name="78" href="#78">78</a> DEFAULT_REBUILD_ON_RECONFIG = Boolean.TRUE;<a name="79" href="#79">79</a> <a name="80" href="#80">80</a> <em>/**<em>*</em></em><a name="81" href="#81">81</a> <em> * Whether the 'via' of CrawlURIs should also be checked</em><a name="82" href="#82">82</a> <em> * to see if it is prefixed by the set of SURT prefixes</em><a name="83" href="#83">83</a> <em> */</em><a name="84" href="#84">84</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String <a name="85" href="#85">85</a> ATTR_ALSO_CHECK_VIA = <span class="string">"also-check-via"</span>;<a name="86" href="#86">86</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> Boolean<a name="87" href="#87">87</a> DEFAULT_ALSO_CHECK_VIA = Boolean.FALSE;<a name="88" href="#88">88</a> <a name="89" href="#89">89</a> <strong>protected</strong> <a href="../../../../org/archive/util/SurtPrefixSet.html">SurtPrefixSet</a> surtPrefixes = <strong>null</strong>;<a name="90" href="#90">90</a> <a name="91" href="#91">91</a> <em>/**<em>*</em></em><a name="92" href="#92">92</a> <em> * Usual constructor. </em><a name="93" href="#93">93</a> <em> * @param name</em><a name="94" href="#94">94</a> <em> */</em><a name="95" href="#95">95</a> <strong>public</strong> <a href="../../../../org/archive/crawler/deciderules/SurtPrefixedDecideRule.html">SurtPrefixedDecideRule</a>(String name) {<a name="96" href="#96">96</a> <strong>super</strong>(name);<a name="97" href="#97">97</a> setDescription(<span class="string">"SurtPrefixedDecideRule. Makes the configured decision "</span><a name="98" href="#98">98</a> + <span class="string">"for any URI which, when expressed in SURT form, begins "</span><a name="99" href="#99">99</a> + <span class="string">"with any of the established prefixes (from either seeds "</span><a name="100" href="#100">100</a> + <span class="string">"specification or an external file)."</span>);<a name="101" href="#101">101</a> addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_SURTS_SOURCE_FILE,<a name="102" href="#102">102</a> <span class="string">"Source file from which to infer SURT prefixes. Any URLs "</span> +<a name="103" href="#103">103</a> <span class="string">"in file will be converted to the implied SURT prefix, and "</span> +<a name="104" href="#104">104</a> <span class="string">"literal SURT prefixes may be listed on lines beginning "</span> +<a name="105" href="#105">105</a> <span class="string">"with a '+' character."</span>,<a name="106" href="#106">106</a> <span class="string">""</span>));<a name="107" href="#107">107</a> addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_SEEDS_AS_SURT_PREFIXES,<a name="108" href="#108">108</a> <span class="string">"Should seeds also be interpreted as SURT prefixes."</span>,<a name="109" href="#109">109</a> DEFAULT_SEEDS_AS_SURT_PREFIXES));<a name="110" href="#110">110</a> <a href="../../../../org/archive/crawler/settings/Type.html">Type</a> t = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_SURTS_DUMP_FILE,<a name="111" href="#111">111</a> <span class="string">"Dump file to save SURT prefixes actually used: "</span> +<a name="112" href="#112">112</a> <span class="string">"Useful debugging SURTs."</span>, <span class="string">""</span>));<a name="113" href="#113">113</a> t.setExpertSetting(<strong>true</strong>);<a name="114" href="#114">114</a> t = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_ALSO_CHECK_VIA,<a name="115" href="#115">115</a> <span class="string">"Whether to also make the configured decision if a "</span> +<a name="116" href="#116">116</a> <span class="string">"URI's 'via' URI (the URI from which it was discovered) "</span> +<a name="117" href="#117">117</a> <span class="string">"in SURT form begins with any of the established prefixes. "</span> +<a name="118" href="#118">118</a> <span class="string">"For example, can be used to ACCEPT URIs that are 'one hop "</span> +<a name="119" href="#119">119</a> <span class="string">"off' URIs fitting the SURT prefixes. Default is false."</span>,<a name="120" href="#120">120</a> DEFAULT_ALSO_CHECK_VIA));<a name="121" href="#121">121</a> t.setOverrideable(false);<a name="122" href="#122">122</a> t.setExpertSetting(<strong>true</strong>);<a name="123" href="#123">123</a> t = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_REBUILD_ON_RECONFIG,<a name="124" href="#124">124</a> <span class="string">"Whether to rebuild the internal structures from source "</span> +<a name="125" href="#125">125</a> <span class="string">"files (including seeds if appropriate) every time any "</span> +<a name="126" href="#126">126</a> <span class="string">"configuration change occurs. If true, "</span> +<a name="127" href="#127">127</a> <span class="string">"rule is rebuilt from sources even when (for example) "</span> +<a name="128" href="#128">128</a> <span class="string">"unrelated new domain overrides are set. Rereading large"</span> +<a name="129" href="#129">129</a> <span class="string">"source files can take a long time."</span>, <a name="130" href="#130">130</a> DEFAULT_REBUILD_ON_RECONFIG));<a name="131" href="#131">131</a> t.setOverrideable(false);<a name="132" href="#132">132</a> t.setExpertSetting(<strong>true</strong>);<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> * Evaluate whether given object's URI is covered by the SURT prefix set</em><a name="137" href="#137">137</a> <em> * </em><a name="138" href="#138">138</a> <em> * @param object Item to evaluate.</em><a name="139" href="#139">139</a> <em> * @return true if item, as SURT form URI, is prefixed by an item in the set</em><a name="140" href="#140">140</a> <em> */</em><a name="141" href="#141">141</a> <strong>protected</strong> <strong>boolean</strong> evaluate(Object object) {<a name="142" href="#142">142</a> <strong>if</strong> ( (object instanceof CandidateURI) &&
?? 快捷鍵說明
復(fù)制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -