ReportHelper (eframe 0.5 API)

org.simplemes.eframe.reports.ReportHelper

```
@groovy.util.logging.Slf4j
class ReportHelper
extends java.lang.Object
```
Provides helper methods for finding and using reports from the external report engine.

Properties Summary

Properties
Type	Name and description
`private static java.lang.String`	`REPORT_PAGE` The page that serves up the reports.
`private static ReportHelper`	`instance` A singleton-style instance for this class.

Constructor Summary

Constructors
Constructor and description
`ReportHelper ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`FieldDefinitions`	`buildFieldDefinitionsFromParameters(Report report)` Builds the FieldDefinitions from the list of report parameters.
	`java.util.List<java.lang.String>`	`determineBuiltinReports()` Finds the list of available built-in reports from the file system and/or the class path.
	`java.lang.String`	`determineReportBaseName(java.lang.String fullPath)` Determines the base file name for the given report path.
	`java.io.InputStream`	`getInputStream(Report reportDetails)` Opens an input stream for the report's jrxml file.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - private static final java.lang.String REPORT_PAGE
    
    The page that serves up the reports. Used mainly for user preference storage.
  - private static ReportHelper instance
    
    A singleton-style instance for this class. Used to make testing easier.
- Constructor Detail
  - ReportHelper()
- Method Detail
  - FieldDefinitions buildFieldDefinitionsFromParameters(Report report)
    
    Builds the FieldDefinitions from the list of report parameters. This is used for display purposes.
    Parameters:
    report - The report.
    Returns:
    The FieldDefinitions.
  - java.util.List<java.lang.String> determineBuiltinReports()
    
    Finds the list of available built-in reports from the file system and/or the class path. Ignores .jrxml files that start with underscore (_).
    Returns:
    The list of location strings.
  - java.lang.String determineReportBaseName(java.lang.String fullPath)
    
    Determines the base file name for the given report path. For example, 'reports/Metrics.jrxml' returns 'Metrics'.
    Parameters:
    fullPath - The full path of the report.
    Returns:
    The base file name.
  - @java.lang.SuppressWarnings(value: JavaIoPackageAccess) java.io.InputStream getInputStream(Report reportDetails)
    
    Opens an input stream for the report's jrxml file. Supports built-in reports found on the classpath.
    Parameters:
    reportDetails - The report details.
    Returns:
    The input stream. Can be null if not found.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ReportHelper

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private static final java.lang.String REPORT_PAGE

private static ReportHelper instance

Constructor Detail

ReportHelper()

Method Detail

FieldDefinitions buildFieldDefinitionsFromParameters(Report report)

java.util.List<java.lang.String> determineBuiltinReports()

java.lang.String determineReportBaseName(java.lang.String fullPath)

@java.lang.SuppressWarnings(value: JavaIoPackageAccess) java.io.InputStream getInputStream(Report reportDetails)