reporter.java

爬虫

/* Reporter
 * 
 * Created on May 5, 2005
 *
 * Copyright (C) 2005 Internet Archive.
 * 
 * This file is part of the Heritrix web crawler (crawler.archive.org).
 * 
 * Heritrix is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * any later version.
 * 
 * Heritrix is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser Public License
 * along with Heritrix; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package org.archive.util;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.Writer;

/**
 * @author stack
 * @version $Date: 2005/10/07 00:28:48 $, $Revision: 1.5 $
 */
public interface Reporter {
    /**
     * Get an array of report names offered by this Reporter. 
     * A name in brackets indicates a free-form String, 
     * in accordance with the informal description inside
     * the brackets, may yield a useful report.
     * 
     * @return String array of report names, empty if there is only
     * one report type
     */
    public String[] getReports();
    
    /**
     * Make a report of the given name to the passed-in Writer,
     * If null, give the default report. 
     * 
     * @param writer to receive report
     */
    public void reportTo(String name, PrintWriter writer);
    
    /**
     * Make a default report to the passed-in Writer. Should
     * be equivalent to reportTo(null, writer)
     * 
     * @param writer to receive report
     */
    public void reportTo(PrintWriter writer) throws IOException;
    
    /**
     * Make a single-line summary report to the passed-in writer
     * 
     * @param writer to receive report
     */
    public void singleLineReportTo(PrintWriter writer) throws IOException;
    
    /**
     * Return a short single-line summary report as a String.
     * 
     * @return String single-line summary report
     */
    public String singleLineReport();
    
    /**
     * Return a  legend for the single-line summary report as a String.
     * 
     * @return String single-line summary legend
     */
    public String singleLineLegend();
}