Package org.apache.rat.report.claim

Class AbstractClaimReporter

java.lang.Object

org.apache.rat.report.claim.AbstractClaimReporter

All Implemented Interfaces:

RatReport

Direct Known Subclasses:

ClaimAggregator

public abstract class AbstractClaimReporter
extends Object
implements RatReport

Abstract base implementation of RatReport. It is strongly suggested, that implementations derive from this class.

Constructor Summary

Constructors

Constructor	Description
AbstractClaimReporter()

Method Summary

Modifier and Type	Method	Description
protected void	handleApprovedLicenseClaim(MetaData metadata)	Increment the approved license claim.
protected void	handleDocumentCategoryClaim(Document.Type type)	Increment the document type counter.
protected void	handleLicenseClaim(ILicense license)	Increment the counts associated with the license The default implementation does nothing.
void	report(Document subject)	Performs the actual reporting on the given document.

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

endReport, startReport

Constructor Details

AbstractClaimReporter

public AbstractClaimReporter()

Method Details

handleDocumentCategoryClaim

protected void handleDocumentCategoryClaim(Document.Type type)

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

Parameters:

type - The document type counter to increment.

handleApprovedLicenseClaim

protected void handleApprovedLicenseClaim(MetaData metadata)

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

Parameters:

metadata - The metadata for the document

handleLicenseClaim

protected void handleLicenseClaim(ILicense license)

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

Parameters:

license - the license to record the category for.

report

public void report(Document subject)

Description copied from interface: RatReport

Performs the actual reporting on the given document. Default implementation does nothing.

Specified by:

report in interface RatReport

Parameters:

subject - write any reporting results into this document upon analysis.