?? deciderule.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>DecideRule xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/archive/crawler/deciderules/DecideRule.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> DecideRule</em></em><a name="2" href="#2">2</a> <em class="comment">*</em><a name="3" href="#3">3</a> <em class="comment">* $Id: DecideRule.java 5010 2007-03-16 15:50:55Z Gojomo $</em><a name="4" href="#4">4</a> <em class="comment">*</em><a name="5" href="#5">5</a> <em class="comment">* Created on Mar 3, 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> org.archive.crawler.framework.CrawlController;<a name="28" href="#28">28</a> <strong>import</strong> org.archive.crawler.settings.ModuleType;<a name="29" href="#29">29</a> <a name="30" href="#30">30</a> <a name="31" href="#31">31</a> <em>/**<em>*</em></em><a name="32" href="#32">32</a> <em> * Interface for rules which, given an object to evaluate,</em><a name="33" href="#33">33</a> <em> * respond with a decision: {@link DecideRule#ACCEPT}, </em><a name="34" href="#34">34</a> <em> * {@link DecideRule#REJECT}, or </em><a name="35" href="#35">35</a> <em> * {@link DecideRule#PASS}.</em><a name="36" href="#36">36</a> <em> * </em><a name="37" href="#37">37</a> <em> * Rules return {@link #PASS} by default.</em><a name="38" href="#38">38</a> <em> *</em><a name="39" href="#39">39</a> <em> * @author gojomo</em><a name="40" href="#40">40</a> <em> * @see org.archive.crawler.deciderules.DecideRuleSequence</em><a name="41" href="#41">41</a> <em> */</em><a name="42" href="#42">42</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/archive/crawler/deciderules/DecideRule.html">DecideRule</a> <strong>extends</strong> <a href="../../../../org/archive/crawler/settings/ModuleType.html">ModuleType</a> {<a name="43" href="#43">43</a> <a name="44" href="#44">44</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> serialVersionUID = 3437522810581532520L;<a name="45" href="#45">45</a> <em class="comment">// enumeration of 'actions'</em><a name="46" href="#46">46</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String ACCEPT = <span class="string">"ACCEPT"</span>.intern();<a name="47" href="#47">47</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String REJECT = <span class="string">"REJECT"</span>.intern();<a name="48" href="#48">48</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String PASS = <span class="string">"PASS"</span>.intern();<a name="49" href="#49">49</a> <a name="50" href="#50">50</a> <em>/**<em>*</em></em><a name="51" href="#51">51</a> <em> * Constructor.</em><a name="52" href="#52">52</a> <em> * @param name Name of this rule.</em><a name="53" href="#53">53</a> <em> */</em><a name="54" href="#54">54</a> <strong>public</strong> <a href="../../../../org/archive/crawler/deciderules/DecideRule.html">DecideRule</a>(String name) {<a name="55" href="#55">55</a> <strong>super</strong>(name);<a name="56" href="#56">56</a> }<a name="57" href="#57">57</a> <a name="58" href="#58">58</a> <em>/**<em>*</em></em><a name="59" href="#59">59</a> <em> * Make decision on passed <code>object</code>.</em><a name="60" href="#60">60</a> <em> * @param object Object to rule on.</em><a name="61" href="#61">61</a> <em> * @return {@link #ACCEPT}, {@link #REJECT}, or {@link #PASS}.</em><a name="62" href="#62">62</a> <em> */</em><a name="63" href="#63">63</a> <strong>public</strong> Object decisionFor(Object object) {<a name="64" href="#64">64</a> <strong>return</strong> PASS;<a name="65" href="#65">65</a> }<a name="66" href="#66">66</a> <a name="67" href="#67">67</a> <em>/**<em>*</em></em><a name="68" href="#68">68</a> <em> * If this rule is "one-way" -- can only return a single</em><a name="69" href="#69">69</a> <em> * possible decision other than PASS -- return that </em><a name="70" href="#70">70</a> <em> * decision. Otherwise return null. Most rules will be</em><a name="71" href="#71">71</a> <em> * one-way. </em><a name="72" href="#72">72</a> <em> * @param object </em><a name="73" href="#73">73</a> <em> * </em><a name="74" href="#74">74</a> <em> * @return the one decision other than PASS this rule might</em><a name="75" href="#75">75</a> <em> * return, if there is only one</em><a name="76" href="#76">76</a> <em> */</em><a name="77" href="#77">77</a> <strong>public</strong> Object singlePossibleNonPassDecision(Object object) {<a name="78" href="#78">78</a> <em class="comment">// by default, don't assume one-way</em><a name="79" href="#79">79</a> <strong>return</strong> <strong>null</strong>;<a name="80" href="#80">80</a> }<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> * Respond to a settings update, refreshing any internal settings-derived</em><a name="84" href="#84">84</a> <em> * state.</em><a name="85" href="#85">85</a> <em> * </em><a name="86" href="#86">86</a> <em> * This method gives implementors a chance to refresh internal state</em><a name="87" href="#87">87</a> <em> * after a settings change. Normally new settings are picked up w/o</em><a name="88" href="#88">88</a> <em> * the need of work on the part of settings' clients but some facilities</em><a name="89" href="#89">89</a> <em> * -- for example, Surt classes need to sort submissions into</em><a name="90" href="#90">90</a> <em> * common-prefix-coalesced collection of Surt prefixes, or,</em><a name="91" href="#91">91</a> <em> * settings changes that alter external file or seeds/directives</em><a name="92" href="#92">92</a> <em> * references -- need to be flagged so they can take</em><a name="93" href="#93">93</a> <em> * compensatory action. </em><a name="94" href="#94">94</a> <em> */</em><a name="95" href="#95">95</a> <strong>public</strong> <strong>void</strong> kickUpdate() {<a name="96" href="#96">96</a> <em class="comment">// by default do nothing</em><a name="97" href="#97">97</a> }<a name="98" href="#98">98</a> <a name="99" href="#99">99</a> <em>/**<em>* </em></em><a name="100" href="#100">100</a> <em> * Get the controller object.</em><a name="101" href="#101">101</a> <em> *</em><a name="102" href="#102">102</a> <em> * @return the controller object.</em><a name="103" href="#103">103</a> <em> */</em><a name="104" href="#104">104</a> <strong>public</strong> <a href="../../../../org/archive/crawler/framework/CrawlController.html">CrawlController</a> getController() {<a name="105" href="#105">105</a> <strong>return</strong> getSettingsHandler().getOrder().getController();<a name="106" href="#106">106</a> }<a name="107" href="#107">107</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 + -