org.apache.rat.report.claim.impl

Class AbstractClaimReporter

java.lang.Object

org.apache.rat.report.AbstractReport

org.apache.rat.report.claim.impl.AbstractClaimReporter

All Implemented Interfaces:

RatReport

Direct Known Subclasses:

ClaimAggregator

public abstract class AbstractClaimReporter
extends AbstractReport

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

Constructor Summary

Constructors

Constructor and Description
AbstractClaimReporter()

Method Summary

Modifier and Type	Method and 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) Empty default implementation.

Methods inherited from class org.apache.rat.report.AbstractReport

endReport, startReport

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractClaimReporter

public AbstractClaimReporter()

Method Detail

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)
            throws RatException

Description copied from class: AbstractReport

Empty default implementation.

Specified by:

report in interface RatReport

Overrides:

report in class AbstractReport

Parameters:

subject - the actual document

Throws:

RatException - on error.