Package org.apache.rat.report.claim

Class ClaimAggregator

java.lang.Object

org.apache.rat.report.claim.AbstractClaimReporter

org.apache.rat.report.claim.ClaimAggregator

All Implemented Interfaces:

RatReport

public class ClaimAggregator
extends AbstractClaimReporter

The aggregator is used to create a numerical statistic of claims.

Constructor Summary

Constructors

Constructor	Description
ClaimAggregator(ClaimStatistic statistic)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	endReport()	Signals the end of execution for the report.
protected void	handleApprovedLicenseClaim(MetaData metadata)	Increment the approved license claim.
protected void	handleDocumentCategoryClaim(Document.Type documentType)	Increment the document type counter.
protected void	handleLicenseClaim(ILicense license)	Increment the counts associated with the license The default implementation does nothing.

Methods inherited from class org.apache.rat.report.claim.AbstractClaimReporter

report

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.rat.report.RatReport

startReport

Constructor Details

ClaimAggregator

public ClaimAggregator(ClaimStatistic statistic)

Constructor.

Parameters:

statistic - The statistic to store the statistics in.

Method Details

handleDocumentCategoryClaim

protected void handleDocumentCategoryClaim(Document.Type documentType)

Description copied from class: AbstractClaimReporter

Increment the document type counter. The default implementations does nothing.

Overrides:

handleDocumentCategoryClaim in class AbstractClaimReporter

Parameters:

documentType - The document type counter to increment.

handleApprovedLicenseClaim

protected void handleApprovedLicenseClaim(MetaData metadata)

Description copied from class: AbstractClaimReporter

Increment the approved license claim. The default implementation does nothing.

Overrides:

handleApprovedLicenseClaim in class AbstractClaimReporter

Parameters:

metadata - The metadata for the document

handleLicenseClaim

protected void handleLicenseClaim(ILicense license)

Description copied from class: AbstractClaimReporter

Increment the counts associated with the license The default implementation does nothing.

Overrides:

handleLicenseClaim in class AbstractClaimReporter

Parameters:

license - the license to record the category for.

endReport

public void endReport()
               throws RatException

Description copied from interface: RatReport

Signals the end of execution for the report. Will be called after the report() method to ensure proper cleanup. Default implementation does nothing.

Throws:

RatException - on error.

See Also:

RatReport.report(Document)