View Javadoc

1   /* AcceptRule
2   *
3   * $Id: PredicatedDecideRule.java 4914 2007-02-18 21:53:01Z gojomo $
4   *
5   * Created on Mar 3, 2005
6   *
7   * Copyright (C) 2005 Internet Archive.
8   *
9   * This file is part of the Heritrix web crawler (crawler.archive.org).
10  *
11  * Heritrix is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser Public License as published by
13  * the Free Software Foundation; either version 2.1 of the License, or
14  * any later version.
15  *
16  * Heritrix is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU Lesser Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser Public License
22  * along with Heritrix; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24  */
25  package org.archive.crawler.deciderules;
26  
27  /***
28   * Rule which applies the configured decision only if a 
29   * test evaluates to true. Subclasses override evaluate()
30   * to establish the test. 
31   *
32   * @author gojomo
33   */
34  public abstract class PredicatedDecideRule extends ConfiguredDecideRule {
35      public PredicatedDecideRule(String name) {
36          super(name);
37          setDescription("ABSTRACT: Should not appear as choice.");
38      }
39  
40      public Object decisionFor(Object object) {
41          if(evaluate(object)) {
42              return super.decisionFor(object);
43          }
44          return PASS;
45      }
46  
47      protected abstract boolean evaluate(Object object);
48  }