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 Details

    • isPageBlank

      boolean isPageBlank()
      Return true if the current page is blank

    • markPage

      void markPage()
      Record that this page is not blank
      Specified by:
      markPage in interface org.faceless.publisher.output.ReportCanvasContext

    • addDataList

      void addDataList(String id, List<String> options)

    • 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)

    • getEnvironmentAsString

      default String getEnvironmentAsString(String name, String dflt)

    • getEnvironmentAsStringList

      default List<String> getEnvironmentAsStringList(String name, List<String> dflt)

    • getEnvironmentAsInt

      default Integer getEnvironmentAsInt(String name, Integer dflt)

    • getEnvironmentAsURL

      default URL2 getEnvironmentAsURL(String name, URL2 dflt)

    • getEnvironmentAsBoolean

      default Boolean getEnvironmentAsBoolean(String name, Boolean dflt)

    • getEnvironmentAsFloat

      default Float getEnvironmentAsFloat(String name, Float dflt)

    • getEnvironmentAsFloatOrInf

      default Float getEnvironmentAsFloatOrInf(String name, Float dflt)

    • getEnvironmentAsLength

      default org.faceless.publisher.type.Length getEnvironmentAsLength(String name, org.faceless.publisher.type.Length dflt)

    • getEnvironmentAsResolution

      default Float getEnvironmentAsResolution(String name, Float dflt)

    • getEnvironmentAsResolutionOrInf

      default Float getEnvironmentAsResolutionOrInf(String name, Float dflt)

    • getEnvironmentAsTime

      default Float getEnvironmentAsTime(String name, Float dflt)

    • getEnvironmentAsColor

      default org.faceless.publisher.type.CSSColor getEnvironmentAsColor(String name, org.faceless.publisher.type.CSSColor dflt)