dk.netarkivet.harvester.harvesting.frontier
Interface FrontierReport

All Known Implementing Classes:
AbstractFrontierReport, FullFrontierReport, InMemoryFrontierReport

public interface FrontierReport

Common interface for an Heritrix frontier report wrapper.


Method Summary
 void addLine(FrontierReportLine line)
          Add a line to the report.
 FrontierReportLine[] getExhaustedQueues(int maxSize)
          Returns the exhausted queues, e.g.
 java.lang.String getJobName()
           
 FrontierReportLine getLineForDomain(java.lang.String domainName)
          Returns the line of the frontier report corresponding to the queue for the given domain name.
 FrontierReportLine[] getRetiredQueues(int maxSize)
          Returns the retired queues, e.g.
 long getTimestamp()
           
 

Method Detail

getJobName

java.lang.String getJobName()
Returns:
the jobName

getTimestamp

long getTimestamp()
Returns:
the creation timestamp

addLine

void addLine(FrontierReportLine line)
Add a line to the report.

Parameters:
line - line to add.

getLineForDomain

FrontierReportLine getLineForDomain(java.lang.String domainName)
Returns the line of the frontier report corresponding to the queue for the given domain name.

Parameters:
domainName - the domain name.
Returns:
null if no queue for this domain name exists, otherwise the line of the frontier report corresponding to the queue for the given domain name.

getRetiredQueues

FrontierReportLine[] getRetiredQueues(int maxSize)
Returns the retired queues, e.g. the queues that have hit the totalBudget value (queue-total-budget).

Parameters:
maxSize - maximum count of elements to fetch
Returns:
an array of retired queues of maxSize.

getExhaustedQueues

FrontierReportLine[] getExhaustedQueues(int maxSize)
Returns the exhausted queues, e.g. the queues whose current size is zero.

Parameters:
maxSize - maximum count of elements to fetch
Returns:
an array of exhausted queues.