Package org.faceless.publisher.output

Interface ReportOutput

All Superinterfaces:
org.faceless.publisher.type.EnvSource, org.faceless.publisher.output.ReportCanvasContext
All Known Implementing Classes:
PDFReportOutput, SVGReportOutput
public interface ReportOutput extends org.faceless.publisher.output.ReportCanvasContext, org.faceless.publisher.type.EnvSource
A ReportOutput is used to render a Report to some sort of Output.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    List<? extends Term>
    getEnvironment(String name)
     
    MediaType
    getMediaType()
    Return the type of object that would be written by write(java.io.OutputStream), or if that method doesn't apply, the type of Media generated by this ReportOutput.
    void
    write(OutputStream out)
    Write the object generated by this ReportOutput to the specified OutpuStream.

  • Method Details

    • write

      void write(OutputStream out) throws IOException
      Write the object generated by this ReportOutput to the specified OutpuStream. The exact object written is instance dependent, and if no single file is appropriate this method may throw an UnsupportedOperationException.
      Throws:
      IOException - if generated when writing.
      UnsupportedOperatonException - if this type of Output does not write to a single file.
      IllegalStateExeption - if called before the render has sucessfully completed

    • getMediaType

      MediaType getMediaType()
      Return the type of object that would be written by write(java.io.OutputStream), or if that method doesn't apply, the type of Media generated by this ReportOutput.

    • getEnvironment

      List<? extends Term> getEnvironment(String name)