org.opennms.api.reporting

Interface ReportService

All Known Implementing Classes:

AvailabilityReportService, JasperReportService

public interface ReportService

This interface provides an API for implementing additional database reports inside the opennms webapp

Version:

$Id: $

Author:

Jonathan Sartin

Method Summary

Methods

Modifier and Type	Method and Description
List<ReportFormat>	getFormats(String reportId) This method provides a list of formats supported by the report
ReportParameters	getParameters(String ReportId) This method retrieves the runtime parameters taken by the report
void	render(String ReportId, String location, ReportFormat format, OutputStream outputStream) This method renders the report into a given output stream.
String	run(Map<String,Object> reportParms, String reportId) This method runs the report
void	runAndRender(Map<String,Object> reportParms, String ReportId, ReportFormat format, OutputStream outputStream) This method runs the report and renders in into the given output stream with no intermediate steps
boolean	validate(Map<String,Object> reportParms, String reportId) This method validates that the map of report parameters matches the report parameters accepted by the report.

Method Detail

validate

boolean validate(Map<String,Object> reportParms,
               String reportId)

This method validates that the map of report parameters matches the report parameters accepted by the report. Used by the web interface.

Parameters:

reportParms - hashmap of parameters to be provided at runtime

reportId - reportId as defined in database-reports.xml

Returns:

true if the reportParms supplied match those in the report definition.

run

String run(Map<String,Object> reportParms,
         String reportId)
           throws ReportException

This method runs the report

Parameters:

reportParms - hashmap of parameters to be provided at runtime

reportId - reportId as defined in database-reports.xml

Returns:

a String object.

Throws:

ReportException - if any.

getFormats

List<ReportFormat> getFormats(String reportId)

This method provides a list of formats supported by the report

Parameters:

reportId - reportId as defined in database-reports.xml

Returns:

a list of supported formats

render

void render(String ReportId,
          String location,
          ReportFormat format,
          OutputStream outputStream)
            throws ReportException

This method renders the report into a given output stream.

Parameters:

ReportId - reportId as defined in database-reports.xml

location - location of the report on disk

format - format to render the report

outputStream - stream to render the resulting report

Throws:

ReportException - if any.

runAndRender

void runAndRender(Map<String,Object> reportParms,
                String ReportId,
                ReportFormat format,
                OutputStream outputStream)
                  throws ReportException

This method runs the report and renders in into the given output stream with no intermediate steps

Parameters:

ReportId - reportId as defined in database-reports.xml

format - format to render the report

outputStream - stream to render the resulting report

reportParms - a HashMap object.

Throws:

ReportException - if any.

getParameters

ReportParameters getParameters(String ReportId)
                               throws ReportException

This method retrieves the runtime parameters taken by the report

Parameters:

ReportId - a String object.

Returns:

a ReportParameters object containing the parameters taken by the report

Throws:

ReportException