?? constraint.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>Constraint xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/archive/crawler/settings/Constraint.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> ValueConstraint</em></em><a name="2" href="#2">2</a> <em class="comment"> *</em><a name="3" href="#3">3</a> <em class="comment"> * $Id: Constraint.java 4661 2006-09-25 23:11:16Z 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 Mar 29, 2004</em><a name="6" href="#6">6</a> <em class="comment"> *</em><a name="7" href="#7">7</a> <em class="comment"> * Copyright (C) 2004 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/settings/package-summary.html">org.archive.crawler.settings</a>;<a name="26" href="#26">26</a> <a name="27" href="#27">27</a> <strong>import</strong> java.io.Serializable;<a name="28" href="#28">28</a> <strong>import</strong> java.text.MessageFormat;<a name="29" href="#29">29</a> <strong>import</strong> java.util.ArrayList;<a name="30" href="#30">30</a> <strong>import</strong> java.util.logging.Level;<a name="31" href="#31">31</a> <a name="32" href="#32">32</a> <a name="33" href="#33">33</a> <em>/**<em>*</em></em><a name="34" href="#34">34</a> <em> * Superclass for constraints that can be set on attribute definitions.</em><a name="35" href="#35">35</a> <em> * <p></em><a name="36" href="#36">36</a> <em> * Constraints will be checked against attribute values. If a constraint check</em><a name="37" href="#37">37</a> <em> * fails, an object of type FailedCheck is returned containing information that</em><a name="38" href="#38">38</a> <em> * can be used to build meaningful information to the user.</em><a name="39" href="#39">39</a> <em> * <p></em><a name="40" href="#40">40</a> <em> * A constraint has one of three levels:</em><a name="41" href="#41">41</a> <em> * <ul></em><a name="42" href="#42">42</a> <em> * <li>{@link java.util.logging.Level#SEVERE}The attribute could not be set</em><a name="43" href="#43">43</a> <em> * whatsoever.</em><a name="44" href="#44">44</a> <em> * <li>{@link java.util.logging.Level#WARNING}The attribute is illegal i</em><a name="45" href="#45">45</a> <em> * CrawlJobs, but could be set in profiles. Mostly used as holder value for</em><a name="46" href="#46">46</a> <em> * settings that should be changed for every entity running a crawl.</em><a name="47" href="#47">47</a> <em> * <li>{@link java.util.logging.Level#INFO}The attribute has a legal value,</em><a name="48" href="#48">48</a> <em> * but is outside the bounds of what are considered a reasonable value. The user</em><a name="49" href="#49">49</a> <em> * could be warned that she should investigate if the value actally is what she</em><a name="50" href="#50">50</a> <em> * wants it be.</em><a name="51" href="#51">51</a> <em> * </ul></em><a name="52" href="#52">52</a> <em> *</em><a name="53" href="#53">53</a> <em> * @author John Erik Halse</em><a name="54" href="#54">54</a> <em> */</em><a name="55" href="#55">55</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../org/archive/crawler/settings/Constraint.html">Constraint</a> <a name="56" href="#56">56</a> implements Comparable<Constraint>, Serializable {<a name="57" href="#57">57</a> <strong>private</strong> <strong>final</strong> Level severity;<a name="58" href="#58">58</a> <strong>private</strong> <strong>final</strong> String msg;<a name="59" href="#59">59</a> <a name="60" href="#60">60</a> <em>/**<em>* Constructs a new Constraint.</em></em><a name="61" href="#61">61</a> <em> *</em><a name="62" href="#62">62</a> <em> * @param level the level for this constraint.</em><a name="63" href="#63">63</a> <em> * @param msg default message to return if the check fails.</em><a name="64" href="#64">64</a> <em> */</em><a name="65" href="#65">65</a> <strong>public</strong> <a href="../../../../org/archive/crawler/settings/Constraint.html">Constraint</a>(Level level, String msg) {<a name="66" href="#66">66</a> <strong>if</strong> (level != Level.SEVERE && level != Level.WARNING<a name="67" href="#67">67</a> && level != Level.INFO) {<a name="68" href="#68">68</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Illegal level: "</span><a name="69" href="#69">69</a> + level.getName());<a name="70" href="#70">70</a> }<a name="71" href="#71">71</a> <strong>this</strong>.severity = level;<a name="72" href="#72">72</a> <strong>this</strong>.msg = msg;<a name="73" href="#73">73</a> }<a name="74" href="#74">74</a> <a name="75" href="#75">75</a> <em>/**<em>*</em></em><a name="76" href="#76">76</a> <em> * Run the check.</em><a name="77" href="#77">77</a> <em> *</em><a name="78" href="#78">78</a> <em> * @param owner the ComplexType owning the attribute to check.</em><a name="80" href="#80">80</a> <em> * @param value the value to check.</em><a name="81" href="#81">81</a> <em> * @return null if ok, or an instance of {@link FailedCheck}if the check</em><a name="82" href="#82">82</a> <em> * failed.</em><a name="83" href="#83">83</a> <em> */</em><a name="84" href="#84">84</a> <strong>public</strong> <strong>final</strong> FailedCheck check(<a href="../../../../org/archive/crawler/settings/CrawlerSettings.html">CrawlerSettings</a> settings, <a href="../../../../org/archive/crawler/settings/ComplexType.html">ComplexType</a> owner,<a name="85" href="#85">85</a> <a href="../../../../org/archive/crawler/settings/Type.html">Type</a> definition, Object value) {<a name="86" href="#86">86</a> <strong>return</strong> innerCheck(settings, owner, definition, value);<a name="87" href="#87">87</a> }<a name="88" href="#88">88</a> <a name="89" href="#89">89</a> <em>/**<em>* The method all subclasses should implement to do the actual checking.</em></em><a name="90" href="#90">90</a> <em> *</em><a name="91" href="#91">91</a> <em> * @param owner the ComplexType owning the attribute to check.</em><a name="92" href="#92">92</a> <em> * @param definition the definition to check the attribute against.</em><a name="93" href="#93">93</a> <em> * @param value the value to check.</em><a name="94" href="#94">94</a> <em> * @return null if ok, or an instance of {@link FailedCheck}if the check</em><a name="95" href="#95">95</a> <em> * failed.</em><a name="96" href="#96">96</a> <em> */</em><a name="97" href="#97">97</a> <strong>public</strong> <strong>abstract</strong> FailedCheck innerCheck(<a href="../../../../org/archive/crawler/settings/CrawlerSettings.html">CrawlerSettings</a> settings,<a name="99" href="#99">99</a> <a name="100" href="#100">100</a> <em>/**<em>* Get the default message to return if a check fails.</em></em><a name="101" href="#101">101</a> <em> *</em><a name="102" href="#102">102</a> <em> * @return the default message to return if a check fails.</em><a name="103" href="#103">103</a> <em> */</em><a name="104" href="#104">104</a> <strong>protected</strong> String getDefaultMessage() {<a name="105" href="#105">105</a> <strong>return</strong> msg;<a name="106" href="#106">106</a> }<a name="107" href="#107">107</a> <a name="108" href="#108">108</a> <em>/**<em>* Objects of this class represents failed constraint checks.</em></em><a name="109" href="#109">109</a> <em> *</em><a name="110" href="#110">110</a> <em> * @author John Erik Halse</em><a name="111" href="#111">111</a> <em> */</em><a name="112" href="#112">112</a> <strong>public</strong> <strong>class</strong> FailedCheck {