View Javadoc

    1   /* Criteria
    2    *
    3    * $Id: Criteria.java 3704 2005-07-18 17:30:21Z stack-sf $
    4    *
    5    * Created on Apr 8, 2004
    6    *
    7    * Copyright (C) 2004 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.settings.refinements;
    26
    27  import org.archive.net.UURI;
    28
    29
    30  /***
    31   * Superclass for the refinement criteria.
    32   *
    33   * @author John Erik Halse.
    34   */
    35  public interface Criteria {
    36      /***
    37       * Check if a uri is within the bounds of this criteria.
    38       *
    39       * @param uri the UURI to check.
    40       * @return true if the curi is within the bounds.
    41       */
    42      public boolean isWithinRefinementBounds(UURI uri);
    43
    44      /***
    45       * Returns the name of the Criteria type.
    46       * @return the name of the Criteria type
    47       */
    48      public String getName();
    49
    50      /***
    51       * Returns a description of the Criteria's current settings.
    52       * @return a description of the Criteria's current settings.
    53       */
    54      public String getDescription();
    55  }