org.apache.rat.report.claim

Class ClaimStatistic

java.lang.Object

org.apache.rat.report.claim.ClaimStatistic

public class ClaimStatistic
extends Object

This class provides a numerical overview about the report.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClaimStatistic.Counter The counter types

Constructor Summary

Constructors

Constructor and Description
ClaimStatistic()

Method Summary

Modifier and Type	Method and Description
int	getCounter(ClaimStatistic.Counter counter) Returns the counts for the counter.
int	getCounter(Document.Type documentType) Gets the counts for the Document.Type.
int	getLicenseCategoryCount(String licenseFamilyCategory) Gets the counts for hte license category.
Set<String>	getLicenseFamilyCategories() Gets the set of license family categories that were seen.
int	getLicenseFamilyNameCount(String licenseFilename) Retrieves the number of times a license family name was seen.
Set<String>	getLicenseFamilyNames() Gets the set of license family names that were seen.
void	incCounter(ClaimStatistic.Counter counter, int value) Increments the counts for hte counter.
void	incCounter(Document.Type documentType, int value) Increments the number of times the Document.Type was seen.
void	incLicenseCategoryCount(String licenseFamilyCategory, int value) Increments the number of times a license family category was seen.
void	incLicenseFamilyNameCount(String licenseFamilyName, int value) Increments the license family name count.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClaimStatistic

public ClaimStatistic()

Method Detail

getCounter

public int getCounter(ClaimStatistic.Counter counter)

Returns the counts for the counter.

Parameters:

counter - the counter to get the value for.

Returns:

Returns the number times the Counter type was seen.

incCounter

public void incCounter(ClaimStatistic.Counter counter,
                       int value)

Increments the counts for hte counter.

Parameters:

counter - the counter to increment.

value - the value to increment the counter by.

getCounter

public int getCounter(Document.Type documentType)

Gets the counts for the Document.Type.

Parameters:

documentType - the Document.Type to get the counter for.

Returns:

Returns the number times the Document.Type was seen

incCounter

public void incCounter(Document.Type documentType,
                       int value)

Increments the number of times the Document.Type was seen.

Parameters:

documentType - the Document.Type to increment.

value - the vlaue to increment the counter by.

getLicenseCategoryCount

public int getLicenseCategoryCount(String licenseFamilyCategory)

Gets the counts for hte license category.

Parameters:

licenseFamilyCategory - the license family category to get the count for.

Returns:

the number of times the license family category was seen.

incLicenseCategoryCount

public void incLicenseCategoryCount(String licenseFamilyCategory,
                                    int value)

Increments the number of times a license family category was seen.

Parameters:

licenseFamilyCategory - the License family category to incmrement.

value - the value to increment the count by.

getLicenseFamilyCategories

public Set<String> getLicenseFamilyCategories()

Gets the set of license family categories that were seen.

Returns:

A set of license family categories.

getLicenseFamilyNames

public Set<String> getLicenseFamilyNames()

Gets the set of license family names that were seen.

Returns:

a Set of license family names that were seen.

getLicenseFamilyNameCount

public int getLicenseFamilyNameCount(String licenseFilename)

Retrieves the number of times a license family name was seen.

Parameters:

licenseFilename - the license family name to look for.

Returns:

the number of times the license family name was seen.

incLicenseFamilyNameCount

public void incLicenseFamilyNameCount(String licenseFamilyName,
                                      int value)

Increments the license family name count.

Parameters:

licenseFamilyName - the license family name to increment.

value - the value to increment the count by.