AbstractReport (Apache Creadur Rat::Core 0.13-SNAPSHOT API)

java.lang.Object
-
- org.apache.rat.report.AbstractReport
-

-
-
All Implemented Interfaces:
-
RatReport
-
-
-
Direct Known Subclasses:
-
AbstractClaimReporter, LicenseAddingReport, SimpleXmlClaimReporter
-
-
-
-
```
public abstract class AbstractReport
-extends Object
-implements RatReport
```
-
Abstract base class for deriving implementations of RatReport.
-

- -
- - - -
  Constructor Summary
  - - - - - - - - -
  Constructors
  Constructor and Description
  AbstractReport()
  -
- -
- - - -
  Method Summary
  - - - - - - - - - - - - - - - - - - -
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  void endReport()
  void report(Document document)
  void startReport()
  -
  - - - -
    Methods inherited from class java.lang.Object
    -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  -
-

Constructors
Constructor and Description
`AbstractReport()`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`endReport()`
`void`	`report(Document document)`
`void`	`startReport()`

- -
- - - -
  Constructor Detail
  - - - -
  - -
    AbstractReport
    -
```
public AbstractReport()
```
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    startReport
    -
```
public void startReport()
-                 throws RatException
```
    -
    -
    Specified by:
    -
    startReport in interface RatReport
    -
    Throws:
    -
    RatException
    -
    -
  - - - -
  - -
    report
    -
```
public void report(Document document)
-            throws RatException
```
    -
    -
    Specified by:
    -
    report in interface RatReport
    -
    Throws:
    -
    RatException
    -
    -
  - - - -
  - -
    endReport
    -
```
public void endReport()
-               throws RatException
```
    -
    -
    Specified by:
    -
    endReport in interface RatReport
    -
    Throws:
    -
    RatException
    -
    -
  -
-

-
-
All Known Implementing Classes:
-
ArchiveWalker, DirectoryWalker, Walker
-
-
-
-
```
public interface IReportable
```
-

- -
- - - -
  Method Summary
  - - - - - - - - - - -
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method and Description
  void run(RatReport report)
  -
-

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`run(RatReport report)`

- -
- - - -
  Method Detail
  - - - -
  - -
    run
    -
```
void run(RatReport report)
-  throws RatException
```
    -
    -
    Throws:
    -
    RatException
    -
    -
  -
-

-
-
All Known Implementing Classes:
-
AbstractClaimReporter, AbstractReport, ClaimAggregator, ClaimReporterMultiplexer, LicenseAddingReport, SimpleXmlClaimReporter
-
-
-
-
```
public interface RatReport
```
-

- -
- - - -
  Method Summary
  - - - - - - - - - - - - - - - - - - -
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method and Description
  void endReport()
  void report(Document document)
  void startReport()
  -
-

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`endReport()`
`void`	`report(Document document)`
`void`	`startReport()`

- -

- - -

Method Detail

- - - -

startReport

void startReport()
-          throws RatException

Throws:: RatException

- - - -

report

void report(Document document)
-     throws RatException

Throws:: RatException

- - - -

endReport

void endReport()
-        throws RatException

Throws:: RatException

java.lang.Object
-
- org.apache.rat.report.claim.ClaimStatistic
-

-
-
-
```
public class ClaimStatistic
-extends Object
```
-
This class provides a numerical overview about - the report.
-

- -

- - -
Constructor Summary
- - - - - - - - -
Constructors
Constructor and Description
ClaimStatistic()
-

Constructors
Constructor and Description
`ClaimStatistic()`

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Integer>`	`getDocumentCategoryMap()`
`Map<String,Integer>`	`getLicenseFileCodeMap()`
`Map<String,Integer>`	`getLicenseFileNameMap()`
`int`	`getNumApproved()`
`int`	`getNumGenerated()`
`int`	`getNumUnApproved()`
`int`	`getNumUnknown()`
`void`	`setDocumentCategoryMap(Map<String,Integer> pDocumentCategoryMap)` - Sets a map with the file types. -
`void`	`setLicenseFileCodeMap(Map<String,Integer> pLicenseFamilyCodeMap)` - Sets a map with the license family codes. -
`void`	`setLicenseFileNameMap(Map<String,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

- -
- - - -
  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(Map<String,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 Map<String,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 Map<String,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(Map<String,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 Map<String,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(Map<String,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.
    -
    -
  -
-

- - - - - - - - - - - - - - - - - - - - -
Packages that use ClaimStatistic
Package Description
org.apache.rat
org.apache.rat.report.claim.impl
org.apache.rat.report.xml
-

Packages that use ClaimStatistic
Package	Description
org.apache.rat
org.apache.rat.report.claim.impl
org.apache.rat.report.xml

- - -

Uses of ClaimStatistic in org.apache.rat

- - - - - - - - - - - - - - - - - - - - - - - - -

Methods in org.apache.rat that return ClaimStatistic
Modifier and Type	Method and Description
`static ClaimStatistic`	Report.`report(IReportable container, - Writer out, - ReportConfiguration pConfiguration)`
`ClaimStatistic`	Report.`report(PrintStream out)` - Deprecated. - use `Report.report(PrintStream, ReportConfiguration)` instead - -
`ClaimStatistic`	Report.`report(PrintStream out, - ReportConfiguration configuration)`
`static ClaimStatistic`	Report.`report(Writer out, - IReportable base, - InputStream style, - ReportConfiguration pConfiguration)` - Output a report that is styled using a defined stylesheet. -

- - -
Uses of ClaimStatistic in org.apache.rat.report.claim.impl
- - - - - - - - - - - - -
Methods in org.apache.rat.report.claim.impl with parameters of type ClaimStatistic
Modifier and Type Method and Description
void ClaimAggregator.fillClaimStatistic(ClaimStatistic pStatistic)
- - - - - - - - - - -
Constructors in org.apache.rat.report.claim.impl with parameters of type ClaimStatistic
Constructor and Description
ClaimAggregator(ClaimStatistic pStatistic)
-

Methods in org.apache.rat.report.claim.impl with parameters of type ClaimStatistic
Modifier and Type	Method and Description
`void`	ClaimAggregator.`fillClaimStatistic(ClaimStatistic pStatistic)`

Constructors in org.apache.rat.report.claim.impl with parameters of type ClaimStatistic
Constructor and Description
`ClaimAggregator(ClaimStatistic pStatistic)`

- - -

Uses of ClaimStatistic in org.apache.rat.report.xml

- - - - - - - - - - - - -

Methods in org.apache.rat.report.xml with parameters of type ClaimStatistic
Modifier and Type	Method and Description
`static RatReport`	XmlReportFactory.`createStandardReport(IXmlWriter writer, - ClaimStatistic pStatistic, - ReportConfiguration pConfiguration)`

Class AbstractReport

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractReport

Method Detail

startReport

report

endReport

Interface IReportable

Method Summary

Method Detail

run

Interface RatReport

Method Summary

Method Detail

startReport

report

endReport

Class ClaimStatistic

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClaimStatistic

Method Detail

getNumApproved

setNumApproved

getNumUnApproved

setNumUnApproved

getNumGenerated

setNumGenerated

getNumUnknown

setNumUnknown

setDocumentCategoryMap

getDocumentCategoryMap

getLicenseFileCodeMap

setLicenseFileCodeMap

getLicenseFileNameMap

setLicenseFileNameMap

Uses of Classorg.apache.rat.report.claim.ClaimStatistic

Uses of ClaimStatistic in org.apache.rat

Uses of ClaimStatistic in org.apache.rat.report.claim.impl

Uses of ClaimStatistic in org.apache.rat.report.xml

Uses of Class
org.apache.rat.report.claim.ClaimStatistic