org.openmrs.report

Interface ReportRenderer

All Known Implementing Classes:

CsvReportRenderer, DelimitedTextReportRenderer, TsvReportRenderer

Deprecated.

see reportingcompatibility module

@Deprecated
public interface ReportRenderer

Takes a ReportSchema and renders it, often acting as a connector that delegates to a sophisticated package like BIRT or Jasper Reports. Implementations of this class should only use a no-arg constructor, since they will be instantiated by the ReportObjectService via reflection.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilename(ReportSchema schema, java.lang.String argument) Deprecated. Should be null if getLinkUrl() returns a non-null value.
java.lang.String	getLabel() Deprecated.
java.lang.String	getRenderedContentType(ReportSchema schema, java.lang.String argument) Deprecated. The content-type that will be rendered
java.util.Collection<RenderingMode>	getRenderingModes(ReportSchema schema) Deprecated. Returns the modes in which this report schema could be rendered.
void	render(ReportData reportData, java.lang.String argument, java.io.OutputStream out) Deprecated. Render the report's data to a stream
void	render(ReportData reportData, java.lang.String argument, java.io.Writer writer) Deprecated. Render the report's data to a stream

Method Detail

getLabel

java.lang.String getLabel()

Deprecated.

Returns:

What should this renderer be called, e.g. in a drop-down list where the user picks which renderer to use

getRenderingModes

java.util.Collection<RenderingMode> getRenderingModes(ReportSchema schema)

Deprecated.

Returns the modes in which this report schema could be rendered.

Parameters:

schema -

Returns:

a Collection of all modes in which the given ReportSchema can be rendered

getRenderedContentType

java.lang.String getRenderedContentType(ReportSchema schema,
                                        java.lang.String argument)

Deprecated.

The content-type that will be rendered

Should be null if getLinkUrl() returns a non-null value.

Parameters:

schema - The ReportSchema to render

argument - Argument from the RenderingMode that the user selected

Returns:

the String representation of the rendered content type

getFilename

java.lang.String getFilename(ReportSchema schema,
                             java.lang.String argument)

Deprecated.

Should be null if getLinkUrl() returns a non-null value.

Parameters:

schema -

argument - Argument from the RenderingMode that the user selected

Returns:

Suggested filename to save the rendered report as.

render

void render(ReportData reportData,
            java.lang.String argument,
            java.io.OutputStream out)
     throws java.io.IOException,
            ReportRenderingException

Deprecated.

Render the report's data to a stream

Parameters:

reportData - Data that was calculated by the Reporting API and service

argument - Argument from the RenderingMode that the user selected

out -

Throws:

ReportRenderingException

java.io.IOException

render

void render(ReportData reportData,
            java.lang.String argument,
            java.io.Writer writer)
     throws java.io.IOException,
            ReportRenderingException

Deprecated.

Render the report's data to a stream

Parameters:

reportData - Data that was calculated by the Reporting API and service

argument - Argument from the RenderingMode that the user selected

writer - the object to write the output to

Throws:

ReportRenderingException

java.io.IOException