org.openmrs.report.impl
Class DelimitedTextReportRenderer

java.lang.Object
  extended by org.openmrs.report.impl.DelimitedTextReportRenderer
All Implemented Interfaces:
ReportRenderer
Direct Known Subclasses:
CsvReportRenderer, TsvReportRenderer

Deprecated. see reportingcompatibility module

@Deprecated
public abstract class DelimitedTextReportRenderer
extends java.lang.Object
implements ReportRenderer


Constructor Summary
DelimitedTextReportRenderer()
          Deprecated.  
 
Method Summary
abstract  java.lang.String escape(java.lang.String text)
          Deprecated.  
abstract  java.lang.String getAfterColumnDelimiter()
          Deprecated.  
abstract  java.lang.String getAfterRowDelimiter()
          Deprecated.  
abstract  java.lang.String getBeforeColumnDelimiter()
          Deprecated.  
abstract  java.lang.String getBeforeRowDelimiter()
          Deprecated.  
 java.lang.String getFilename(ReportSchema schema, java.lang.String argument)
          Deprecated. Should be null if getLinkUrl() returns a non-null value.
abstract  java.lang.String getFilenameExtension()
          Deprecated.  
 java.lang.String getLinkUrl(ReportSchema schema)
          Deprecated. TODO: this appears to be unused.
 java.util.Collection<RenderingMode> getRenderingModes(ReportSchema schema)
          Deprecated. Returns the modes in which this report schema could be rendered.
 void render(ReportData results, java.lang.String argument, java.io.OutputStream out)
          Deprecated. Render the report's data to a stream
 void render(ReportData results, java.lang.String argument, java.io.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 java.lang.String getFilenameExtension()
Deprecated. 

getBeforeColumnDelimiter

public abstract java.lang.String getBeforeColumnDelimiter()
Deprecated. 

getAfterColumnDelimiter

public abstract java.lang.String getAfterColumnDelimiter()
Deprecated. 

getBeforeRowDelimiter

public abstract java.lang.String getBeforeRowDelimiter()
Deprecated. 

getAfterRowDelimiter

public abstract java.lang.String getAfterRowDelimiter()
Deprecated. 

escape

public abstract java.lang.String escape(java.lang.String text)
Deprecated. 

getLinkUrl

public java.lang.String getLinkUrl(ReportSchema schema)
Deprecated. 
TODO: this appears to be unused. Its not in the super interface or overridden in subclasses.


getFilename

public java.lang.String getFilename(ReportSchema schema,
                                    java.lang.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 java.util.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,
                   java.lang.String argument,
                   java.io.OutputStream out)
            throws java.io.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:
java.io.IOException
RenderingException
See Also:
ReportRenderer.render(ReportData, String, OutputStream)

render

public void render(ReportData results,
                   java.lang.String argument,
                   java.io.Writer writer)
            throws java.io.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:
java.io.IOException
RenderingException
See Also:
ReportRenderer.render(ReportData, String, Writer)

OpenMRS-1.7.x

Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change