org.openmrs.report.impl

Class DelimitedTextReportRenderer

java.lang.Object

org.openmrs.report.impl.DelimitedTextReportRenderer

All Implemented Interfaces:

ReportRenderer

Direct Known Subclasses:

CsvReportRenderer, TsvReportRenderer

Deprecated.

see reportingcompatibility module

@Deprecated
public abstract class DelimitedTextReportRenderer
extends Object
implements ReportRenderer

Constructor Summary

Constructors

Constructor and Description
DelimitedTextReportRenderer() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	escape(String text) Deprecated.
abstract String	getAfterColumnDelimiter() Deprecated.
abstract String	getAfterRowDelimiter() Deprecated.
abstract String	getBeforeColumnDelimiter() Deprecated.
abstract String	getBeforeRowDelimiter() Deprecated.
String	getFilename(ReportSchema schema, String argument) Deprecated. Should be null if getLinkUrl() returns a non-null value.
abstract String	getFilenameExtension() Deprecated.
String	getLinkUrl(ReportSchema schema) Deprecated. TODO: this appears to be unused.
Collection<RenderingMode>	getRenderingModes(ReportSchema schema) Deprecated. Returns the modes in which this report schema could be rendered.
void	render(ReportData results, String argument, OutputStream out) Deprecated. Render the report's data to a stream
void	render(ReportData results, String argument, Writer writer) Deprecated. Render the report's data to a stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.report.ReportRenderer

getLabel, getRenderedContentType

Constructor Detail

DelimitedTextReportRenderer

public DelimitedTextReportRenderer()

Deprecated.

Method Detail

getFilenameExtension

public abstract String getFilenameExtension()

Deprecated.

getBeforeColumnDelimiter

public abstract String getBeforeColumnDelimiter()

Deprecated.

getAfterColumnDelimiter

public abstract String getAfterColumnDelimiter()

Deprecated.

getBeforeRowDelimiter

public abstract String getBeforeRowDelimiter()

Deprecated.

getAfterRowDelimiter

public abstract String getAfterRowDelimiter()

Deprecated.

escape

public abstract String escape(String text)

Deprecated.

getLinkUrl

public String getLinkUrl(ReportSchema schema)

Deprecated.

TODO: this appears to be unused. Its not in the super interface or overridden in subclasses.

getFilename

public String getFilename(ReportSchema schema,
                 String argument)

Deprecated.

Description copied from interface: ReportRenderer

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

Specified by:

getFilename in interface ReportRenderer

argument - Argument from the RenderingMode that the user selected

Returns:

Suggested filename to save the rendered report as.

See Also:

ReportRenderer.getFilename(ReportSchema, String)

getRenderingModes

public Collection<RenderingMode> getRenderingModes(ReportSchema schema)

Deprecated.

Description copied from interface: ReportRenderer

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

Specified by:

getRenderingModes in interface ReportRenderer

Returns:

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

See Also:

ReportRenderer.getRenderingModes(org.openmrs.report.ReportSchema)

render

public void render(ReportData results,
          String argument,
          OutputStream out)
            throws IOException,
                   RenderingException

Deprecated.

Description copied from interface: ReportRenderer

Render the report's data to a stream

Specified by:

render in interface ReportRenderer

Parameters:

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

argument - Argument from the RenderingMode that the user selected

Throws:

IOException

RenderingException

See Also:

ReportRenderer.render(ReportData, String, OutputStream)

render

public void render(ReportData results,
          String argument,
          Writer writer)
            throws IOException,
                   RenderingException

Deprecated.

Description copied from interface: ReportRenderer

Render the report's data to a stream

Specified by:

render in interface ReportRenderer

Parameters:

results - 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:

IOException

RenderingException

See Also:

ReportRenderer.render(ReportData, String, Writer)