View Javadoc

    1   /* CanonicalizationRule
    2    *
    3    * Created on Oct 7, 2004
    4    *
    5    * Copyright (C) 2004 Internet Archive.
    6    *
    7    * This file is part of the Heritrix web crawler (crawler.archive.org).
    8    *
    9    * Heritrix is free software; you can redistribute it and/or modify
    10   * it under the terms of the GNU Lesser Public License as published by
    11   * the Free Software Foundation; either version 2.1 of the License, or
    12   * any later version.
    13   *
    14   * Heritrix is distributed in the hope that it will be useful,
    15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    17   * GNU Lesser Public License for more details.
    18   *
    19   * You should have received a copy of the GNU Lesser Public License
    20   * along with Heritrix; if not, write to the Free Software
    21   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    22   */
    23  package org.archive.crawler.url;
    24
    25
    26  /***
    27   * A rule to apply canonicalizing a url.
    28   * @author stack
    29   * @version $Date: 2004-10-08 17:39:42 +0000 (Fri, 08 Oct 2004) $, $Revision: 2627 $
    30   */
    31  public interface CanonicalizationRule {
    32      /***
    33       * Apply this canonicalization rule.
    34       *
    35       * @param url Url string we apply this rule to.
    36       * @param context An object that will provide context for the settings
    37       * system.  The UURI of the URL we're canonicalizing is an example of
    38       * an object that provides context.
    39       * @return Result of applying this rule to passed <code>url</code>.
    40       */
    41      public String canonicalize(String url, Object context);
    42
    43      /***
    44       * @return Name of this rule.
    45       */
    46      public String getName();
    47
    48      /***
    49       * @param context An object that will provide context for the settings
    50       * system.  The UURI of the URL we're canonicalizing is an example of
    51       * an object that provides context.
    52       * @return True if this rule is enabled and to be run.
    53       */
    54      public boolean isEnabled(Object context);
    55  }