View Javadoc

1   /* $Id: CompletedCrawlJob.java 4183 2006-03-09 02:12:19Z danavery $
2    *
3    * Created on Dec 12, 2005
4    *
5    * Copyright (C) 2005 Internet Archive.
6    *  
7    * This file is part of the Heritrix Cluster Controller (crawler.archive.org).
8    *  
9    * HCC 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.hcc.client;
24  
25  /***
26   * Defines the interface for interacting with a completed crawl job.
27   * @author Daniel Bernstein (dbernstein@archive.org)
28   */
29  public interface CompletedCrawlJob extends CrawlJob {
30      /***
31       * Returns a crawl report which is some statistics summarizing
32       * the end state of the crawl.
33       * @return
34       * @throws ClusterException
35       */
36      public String getCrawlReport() throws ClusterException;
37      /***
38       * Returns a seed report which details final crawl status of all the seeds.
39       * @return
40       * @throws ClusterException
41       */
42  
43      public String getSeedReport() throws ClusterException;
44  
45      /***
46       * A count of bytes and docs collected by host.
47       * @return
48       * @throws ClusterException
49       */
50      public String getHostReport() throws ClusterException;
51     
52      /***
53       * A count of docs per host per source seed.
54       * @return
55       * @throws ClusterException
56       */
57      public String getSourceReport() throws ClusterException;
58  
59      /***
60       * A count of bytes and docs collected by mime type.
61       * @return
62       * @throws ClusterException
63       */
64      
65      public String getMimeTypeReport() throws ClusterException;
66  }