com.cyberway.issue.crawler.datamodel.CrawlSubstats.java Source code

Introduction

Here is the source code for com.cyberway.issue.crawler.datamodel.CrawlSubstats.java

Source

/* CrawlSubstats
*
* $Id: CrawlSubstats.java 5439 2007-08-28 05:15:25Z gojomo $
*
* Created on Nov 4, 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 com.cyberway.issue.crawler.datamodel;

import java.io.Serializable;

import org.apache.commons.httpclient.HttpStatus;

/**
 * Collector of statististics for a 'subset' of a crawl,
 * such as a server (host:port), host, or frontier group 
 * (eg queue). 
 * 
 * @author gojomo
 */
public class CrawlSubstats implements Serializable, FetchStatusCodes {
    private static final long serialVersionUID = 8624425657056569036L;

    public enum Stage {
        SCHEDULED, SUCCEEDED, RETRIED, DISREGARDED, FAILED
    };

    public interface HasCrawlSubstats {
        public CrawlSubstats getSubstats();
    }

    long totalScheduled; // anything initially scheduled
                         // (totalScheduled - (fetchSuccesses + fetchFailures)
    long fetchSuccesses; // anything disposed-success 
                         // (HTTP 2XX response codes, other non-errors)
    long fetchFailures; // anything disposed-failure
    long fetchDisregards; // anything disposed-disregard
    long fetchResponses; // all positive responses (incl. 3XX, 4XX, 5XX)
    long robotsDenials; // all robots-precluded failures
    long successBytes; // total size of all success responses
    long totalBytes; // total size of all responses
    long fetchNonResponses; // processing attempts resulting in no response
                            // (both failures and temp deferrals)

    /**
     * Examing the CrawlURI and based on its status and internal values,
     * update tallies. 
     * 
     * @param curi
     * @deprecated
     */
    public synchronized void tally(CrawlURI curi) {
        if (curi.getFetchStatus() <= 0) {
            fetchNonResponses++;
            return;
        }
        fetchResponses++;
        totalBytes += curi.getContentSize();
        if (curi.getFetchStatus() >= HttpStatus.SC_OK && curi.getFetchStatus() < 300) {
            fetchSuccesses++;
            successBytes += curi.getContentSize();
        }
    }

    public synchronized void tally(CrawlURI curi, Stage stage) {
        switch (stage) {
        case SCHEDULED:
            totalScheduled++;
            break;
        case RETRIED:
            if (curi.getFetchStatus() <= 0) {
                fetchNonResponses++;
                return;
            }
            break;
        case SUCCEEDED:
            fetchSuccesses++;
            totalBytes += curi.getContentSize();
            successBytes += curi.getContentSize();
            break;
        case DISREGARDED:
            fetchDisregards++;
            if (curi.getFetchStatus() == S_ROBOTS_PRECLUDED) {
                robotsDenials++;
            }
            break;
        case FAILED:
            if (curi.getFetchStatus() <= 0) {
                fetchNonResponses++;
            } else {
                totalBytes += curi.getContentSize();
            }
            fetchFailures++;
            break;
        }
    }

    public long getFetchSuccesses() {
        return fetchSuccesses;
    }

    public long getFetchResponses() {
        return fetchResponses;
    }

    public long getSuccessBytes() {
        return successBytes;
    }

    public long getTotalBytes() {
        return totalBytes;
    }

    public long getFetchNonResponses() {
        return fetchNonResponses;
    }

    public long getTotalScheduled() {
        return totalScheduled;
    }

    public long getFetchDisregards() {
        return fetchDisregards;
    }

    public long getRobotsDenials() {
        return robotsDenials;
    }

    public long getRemaining() {
        return totalScheduled - (fetchSuccesses + fetchFailures + fetchDisregards);
    }

    public long getRecordedFinishes() {
        return fetchSuccesses + fetchFailures;
    }
}