org.apache.rat.report.claim

Class ClaimStatistic

java.lang.Object

org.apache.rat.report.claim.ClaimStatistic

public class ClaimStatistic
extends java.lang.Object

This class provides a numerical overview about the report.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Integer>	documentCategoryMap
private java.util.Map<java.lang.String,java.lang.Integer>	licenseFamilyCodeMap
private java.util.Map<java.lang.String,java.lang.Integer>	licenseFamilyNameMap
private int	numApproved
private int	numGenerated
private int	numUnApproved
private int	numUnknown

Constructor Summary

Constructors

Constructor and Description
ClaimStatistic()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Integer>	getDocumentCategoryMap()
java.util.Map<java.lang.String,java.lang.Integer>	getLicenseFileCodeMap()
java.util.Map<java.lang.String,java.lang.Integer>	getLicenseFileNameMap()
int	getNumApproved()
int	getNumGenerated()
int	getNumUnApproved()
int	getNumUnknown()
void	setDocumentCategoryMap(java.util.Map<java.lang.String,java.lang.Integer> pDocumentCategoryMap) Sets a map with the file types.
void	setLicenseFileCodeMap(java.util.Map<java.lang.String,java.lang.Integer> pLicenseFamilyCodeMap) Sets a map with the license family codes.
void	setLicenseFileNameMap(java.util.Map<java.lang.String,java.lang.Integer> pLicenseFamilyNameMap) Sets map with the license family codes.
void	setNumApproved(int pNumApproved) Sets the number of files with approved licenses.
void	setNumGenerated(int pNumGenerated) Sets the number of generated files.
void	setNumUnApproved(int pNumUnApproved) Sets the number of files with unapproved licenses.
void	setNumUnknown(int pNumUnknown) Sets the number of files, which are neither generated nor have a known license header.

Methods inherited from class java.lang.Object

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

Field Detail

documentCategoryMap

private java.util.Map<java.lang.String,java.lang.Integer> documentCategoryMap

licenseFamilyCodeMap

private java.util.Map<java.lang.String,java.lang.Integer> licenseFamilyCodeMap

licenseFamilyNameMap

private java.util.Map<java.lang.String,java.lang.Integer> licenseFamilyNameMap

numApproved

private int numApproved

numUnApproved

private int numUnApproved

numGenerated

private int numGenerated

numUnknown

private int numUnknown

Constructor Detail

ClaimStatistic

public ClaimStatistic()

Method Detail

getNumApproved

public int getNumApproved()

Returns:

Returns the number of files with approved licenses.

setNumApproved

public void setNumApproved(int pNumApproved)

Sets the number of files with approved licenses.

Parameters:

pNumApproved - number of files with approved licenses.

getNumUnApproved

public int getNumUnApproved()

Returns:

Returns the number of files with unapproved licenses. Note: This might include files with unknown licenses.

See Also:

getNumUnknown()

setNumUnApproved

public void setNumUnApproved(int pNumUnApproved)

Sets the number of files with unapproved licenses.

Parameters:

pNumUnApproved - number of files with unapproved licenses.

getNumGenerated

public int getNumGenerated()

Returns:

Returns the number of generated files.

setNumGenerated

public void setNumGenerated(int pNumGenerated)

Sets the number of generated files.

Parameters:

pNumGenerated - the number of generated files.

getNumUnknown

public int getNumUnknown()

Returns:

Returns the number of files, which are neither generated nor have a known license header.

setNumUnknown

public void setNumUnknown(int pNumUnknown)

Sets the number of files, which are neither generated nor have a known license header.

Parameters:

pNumUnknown - set number of files.

setDocumentCategoryMap

public void setDocumentCategoryMap(java.util.Map<java.lang.String,java.lang.Integer> pDocumentCategoryMap)

Sets a map with the file types. The map keys are file type names and the map values are integers with the number of resources matching the file type.

Parameters:

pDocumentCategoryMap - doc-category map.

getDocumentCategoryMap

public java.util.Map<java.lang.String,java.lang.Integer> getDocumentCategoryMap()

Returns:

Returns a map with the file types. The map keys are file type names and the map values are integers with the number of resources matching the file type.

getLicenseFileCodeMap

public java.util.Map<java.lang.String,java.lang.Integer> getLicenseFileCodeMap()

Returns:

Returns a map with the license family codes. The map keys are license family category names, the map values are integers with the number of resources matching the license family code.

setLicenseFileCodeMap

public void setLicenseFileCodeMap(java.util.Map<java.lang.String,java.lang.Integer> pLicenseFamilyCodeMap)

Sets a map with the license family codes. The map keys are instances of license family category names and the map values are integers with the number of resources matching the license family code.

Parameters:

pLicenseFamilyCodeMap - license family map.

getLicenseFileNameMap

public java.util.Map<java.lang.String,java.lang.Integer> getLicenseFileNameMap()

Returns:

Returns a map with the license family codes. The map keys are the names of the license families and the map values are integers with the number of resources matching the license family name.

setLicenseFileNameMap

public void setLicenseFileNameMap(java.util.Map<java.lang.String,java.lang.Integer> pLicenseFamilyNameMap)

Sets map with the license family codes. The map keys are the name of the license families and the map values are integers with the number of resources matching the license family name.

Parameters:

pLicenseFamilyNameMap - license family-name map.