📄 processor.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=ISO-8859-1" /><title>Processor 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 class="comment"> Copyright (C) 2003 Internet Archive.</em></em><a name="2" href="#2">2</a> <em class="comment"> *</em><a name="3" href="#3">3</a> <em class="comment"> * This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="4" href="#4">4</a> <em class="comment"> *</em><a name="5" href="#5">5</a> <em class="comment"> * Heritrix is free software; you can redistribute it and/or modify</em><a name="6" href="#6">6</a> <em class="comment"> * it under the terms of the GNU Lesser Public License as published by</em><a name="7" href="#7">7</a> <em class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</em><a name="8" href="#8">8</a> <em class="comment"> * any later version.</em><a name="9" href="#9">9</a> <em class="comment"> *</em><a name="10" href="#10">10</a> <em class="comment"> * Heritrix is distributed in the hope that it will be useful,</em><a name="11" href="#11">11</a> <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="12" href="#12">12</a> <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="13" href="#13">13</a> <em class="comment"> * GNU Lesser Public License for more details.</em><a name="14" href="#14">14</a> <em class="comment"> *</em><a name="15" href="#15">15</a> <em class="comment"> * You should have received a copy of the GNU Lesser Public License</em><a name="16" href="#16">16</a> <em class="comment"> * along with Heritrix; if not, write to the Free Software</em><a name="17" href="#17">17</a> <em class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="18" href="#18">18</a> <em class="comment"> *</em><a name="19" href="#19">19</a> <em class="comment"> * Processor.java</em><a name="20" href="#20">20</a> <em class="comment"> * Created on Apr 16, 2003</em><a name="21" href="#21">21</a> <em class="comment"> *</em><a name="22" href="#22">22</a> <em class="comment"> * $Header: /cvsroot/archive-crawler/ArchiveOpenCrawler/src/java/org/archive/crawler/framework/Processor.java,v 1.32 2006/08/25 00:14:28 stack-sf Exp $</em><a name="23" href="#23">23</a> <em class="comment"> */</em><a name="24" href="#24">24</a> <strong>package</strong> <a href="../../../../org/archive/crawler/framework/package-summary.html">org.archive.crawler.framework</a>;<a name="25" href="#25">25</a> <a name="26" href="#26">26</a> <strong>import</strong> java.lang.reflect.Constructor;<a name="27" href="#27">27</a> <strong>import</strong> java.util.Iterator;<a name="28" href="#28">28</a> <strong>import</strong> java.util.logging.Level;<a name="29" href="#29">29</a> <strong>import</strong> java.util.logging.Logger;<a name="30" href="#30">30</a> <a name="31" href="#31">31</a> <strong>import</strong> javax.management.AttributeNotFoundException;<a name="32" href="#32">32</a> <a name="33" href="#33">33</a> <strong>import</strong> org.archive.crawler.datamodel.CrawlURI;<a name="34" href="#34">34</a> <strong>import</strong> org.archive.crawler.settings.MapType;<a name="35" href="#35">35</a> <strong>import</strong> org.archive.crawler.settings.ModuleType;<a name="36" href="#36">36</a> <strong>import</strong> org.archive.crawler.settings.SimpleType;<a name="37" href="#37">37</a> <a name="38" href="#38">38</a> <em>/**<em>*</em></em><a name="39" href="#39">39</a> <em> * Base class for URI processing classes.</em><a name="40" href="#40">40</a> <em> *</em><a name="41" href="#41">41</a> <em> * <p> Each URI is processed by a user defined series of processors. This class</em><a name="42" href="#42">42</a> <em> * provides the basic infrastructure for these but does not actually do</em><a name="43" href="#43">43</a> <em> * anything. New processors can be easily created by subclassing this class.</em><a name="44" href="#44">44</a> <em> *</em><a name="45" href="#45">45</a> <em> * <p> Classes subclassing this one should not trap InterruptedExceptions.</em><a name="46" href="#46">46</a> <em> * They should be allowed to propagate to the ToeThread executing the processor.</em><a name="47" href="#47">47</a> <em> * Also they should immediately exit their main method (<tt>innerProcess()</tt>)</em><a name="48" href="#48">48</a> <em> * if the <tt>interrupted</tt> flag is set.</em><a name="49" href="#49">49</a> <em> *</em><a name="50" href="#50">50</a> <em> * @author Gordon Mohr</em><a name="51" href="#51">51</a> <em> *</em><a name="52" href="#52">52</a> <em> * @see org.archive.crawler.framework.ToeThread</em><a name="53" href="#53">53</a> <em> */</em><a name="54" href="#54">54</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/archive/crawler/framework/Processor.html">Processor</a> <strong>extends</strong> <a href="../../../../org/archive/crawler/settings/ModuleType.html">ModuleType</a> {<a name="55" href="#55">55</a> <em>/**<em>*</em></em><a name="56" href="#56">56</a> <em> * Key to use asking settings for filters value.</em><a name="57" href="#57">57</a> <em> */</em><a name="58" href="#58">58</a> <strong>public</strong> <strong>final</strong> <strong>static</strong> String ATTR_FILTERS = <span class="string">"filters"</span>;<a name="59" href="#59">59</a> <a name="60" href="#60">60</a> <em>/**<em>*</em></em><a name="61" href="#61">61</a> <em> * Key to use asking settings for enabled value.</em><a name="62" href="#62">62</a> <em> */</em><a name="63" href="#63">63</a> <strong>public</strong> <strong>final</strong> <strong>static</strong> String ATTR_ENABLED = <span class="string">"enabled"</span>;<a name="64" href="#64">64</a> <a name="65" href="#65">65</a> <strong>private</strong> <a href="../../../../org/archive/crawler/settings/MapType.html">MapType</a> filters;<a name="66" href="#66">66</a> <strong>private</strong> <a href="../../../../org/archive/crawler/framework/Processor.html">Processor</a> defaultNextProcessor = <strong>null</strong>;<a name="67" href="#67">67</a> <a name="68" href="#68">68</a> <strong>private</strong> <strong>static</strong> Logger logger =<a name="69" href="#69">69</a> Logger.getLogger(<span class="string">"org.archive.crawler.framework.Processor"</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> * @param name</em><a name="73" href="#73">73</a> <em> * @param description</em><a name="74" href="#74">74</a> <em> */</em><a name="75" href="#75">75</a> <strong>public</strong> <a href="../../../../org/archive/crawler/framework/Processor.html">Processor</a>(String name, String description) {<a name="76" href="#76">76</a> <strong>super</strong>(name, description);<a name="77" href="#77">77</a> addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_ENABLED,<a name="78" href="#78">78</a> <span class="string">"Is processor enabled"</span>, <strong>new</strong> Boolean(<strong>true</strong>)));<a name="79" href="#79">79</a> filters = (MapType) addElementToDefinition(<strong>new</strong> MapType(ATTR_FILTERS,<a name="80" href="#80">80</a> <span class="string">"Filters applied to this processor"</span>, Filter.<strong>class</strong>));<a name="81" href="#81">81</a> }<a name="82" href="#82">82</a> <a name="83" href="#83">83</a> <em>/**<em>*</em></em><a name="84" href="#84">84</a> <em> * Perform processing on the given CrawlURI.</em><a name="85" href="#85">85</a> <em> *</em><a name="86" href="#86">86</a> <em> * @param curi</em><a name="87" href="#87">87</a> <em> * @throws InterruptedException</em><a name="88" href="#88">88</a> <em> */</em><a name="89" href="#89">89</a> <strong>public</strong> <strong>final</strong> <strong>void</strong> process(<a href="../../../../org/archive/crawler/datamodel/CrawlURI.html">CrawlURI</a> curi) throws InterruptedException {<a name="90" href="#90">90</a> <em class="comment">// by default, arrange for curi to proceed to next processor</em><a name="91" href="#91">91</a> curi.setNextProcessor(getDefaultNextProcessor(curi));<a name="92" href="#92">92</a> <a name="93" href="#93">93</a> <em class="comment">// Check if this processor is enabled before processing</em><a name="94" href="#94">94</a> <strong>try</strong> {<a name="95" href="#95">95</a> <strong>if</strong> (!((Boolean) getAttribute(ATTR_ENABLED, curi)).booleanValue()) {<a name="96" href="#96">96</a> <strong>return</strong>;<a name="97" href="#97">97</a> }<a name="98" href="#98">98</a> } <strong>catch</strong> (AttributeNotFoundException e) {<a name="99" href="#99">99</a> logger.severe(e.getMessage());<a name="100" href="#100">100</a> }<a name="101" href="#101">101</a> <a name="102" href="#102">102</a> <strong>if</strong>(filtersAccept(curi)) {<a name="103" href="#103">103</a> innerProcess(curi);<a name="104" href="#104">104</a> } <strong>else</strong> {<a name="105" href="#105">105</a> innerRejectProcess(curi);<a name="106" href="#106">106</a> }<a name="107" href="#107">107</a> }<a name="108" href="#108">108</a> <a name="109" href="#109">109</a> <strong>protected</strong> <strong>void</strong> checkForInterrupt() throws InterruptedException {<a name="110" href="#110">110</a> <strong>if</strong> (Thread.interrupted()) {<a name="111" href="#111">111</a> <strong>throw</strong> <strong>new</strong> InterruptedException(<span class="string">"interrupted"</span>);<a name="112" href="#112">112</a> }<a name="113" href="#113">113</a> }<a name="114" href="#114">114</a> <a name="115" href="#115">115</a> <em>/**<em>*</em></em><a name="116" href="#116">116</a> <em> * @param curi CrawlURI instance.</em><a name="117" href="#117">117</a> <em> * @throws InterruptedException</em><a name="118" href="#118">118</a> <em> */</em><a name="119" href="#119">119</a> <strong>protected</strong> <strong>void</strong> innerRejectProcess(<a href="../../../../org/archive/crawler/datamodel/CrawlURI.html">CrawlURI</a> curi)<a name="120" href="#120">120</a> throws InterruptedException {<a name="121" href="#121">121</a> <em class="comment">// by default do nothing</em><a name="122" href="#122">122</a> }<a name="123" href="#123">123</a> <a name="124" href="#124">124</a> <em>/**<em>*</em></em><a name="125" href="#125">125</a> <em> * Classes subclassing this one should override this method to perform</em><a name="126" href="#126">126</a> <em> * their custom actions on the CrawlURI.</em><a name="127" href="#127">127</a> <em> *</em><a name="128" href="#128">128</a> <em> * @param curi The CrawlURI being processed.</em><a name="129" href="#129">129</a> <em> * @throws InterruptedException</em><a name="130" href="#130">130</a> <em> */</em><a name="131" href="#131">131</a> <strong>protected</strong> <strong>void</strong> innerProcess(<a href="../../../../org/archive/crawler/datamodel/CrawlURI.html">CrawlURI</a> curi)<a name="132" href="#132">132</a> throws InterruptedException {<a name="133" href="#133">133</a> <em class="comment">// by default do nothing</em><a name="134" href="#134">134</a> }<a name="135" href="#135">135</a> <a name="136" href="#136">136</a> <em>/**<em>*</em></em><a name="137" href="#137">137</a> <em> * Classes subclassing this one should override this method to perform</em><a name="138" href="#138">138</a> <em> * processor specific actions.</em><a name="139" href="#139">139</a> <em> * <p></em><a name="140" href="#140">140</a> <em> *</em><a name="141" href="#141">141</a> <em> * This method is garanteed to be called after the crawl is set up, but</em><a name="142" href="#142">142</a> <em> * before any URI-processing has occured.</em>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -