Package org.faceless.publisher.ext

Interface ReportFactoryExtension

All Known Subinterfaces:
SignatureExtension
All Known Implementing Classes:
ContentMathMLExtension, DefaultSignatureExtension, FreeMarkerExtension, GlobalSignSignatureExtension, HtmlAutoDirExtension, HtmlNamespaceExtension, IndexFilter, LessStylesheetExtension, LinkProcessingInstructionExtension, MailExtension, MailServerExtension, ScssStylesheetExtension, SpiderExtension, SSMLExtension, XIncludeExtension, XmlStylesheetExtension, XsltAttributeExtension, ZTemplateExtension
public interface ReportFactoryExtension
Represents an extension to the ReportFactory, adding the ability to parse new types of input or process it in a different way in response to a processing instruction.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    configure(Json json)
    Configure the extension.
    default boolean
    load(Object o, Report report)
    Attempt to load the specified object into the specified Report.
    default void
    register(Report report)
    Notify this object it has beem added to a Report.
    default void
    register(ReportFactory factory)
    Notify this object it has beem added to a ReportFactory.
    default void
    unregister(Report report)
    Notify this object when the Report it was registered on has completed parsing.
    default void
    unregister(ReportFactory factory)
    Notify this object it has been removed from a ReportFactory.

  • Method Details

    • unregister

      default void unregister(ReportFactory factory)
      Notify this object it has been removed from a ReportFactory. Will be called when this object is removed from the list returned by ReportFactory.getReportFactoryExtensions(). The default implementation is a no-op.

    • register

      default void register(ReportFactory factory)
      Notify this object it has beem added to a ReportFactory. Will be called when this object is added to the list returned by ReportFactory.getReportFactoryExtensions(). The default implementation is a no-op.

    • register

      default void register(Report report)
      Notify this object it has beem added to a Report. Will be called when this object is added to the list returned by ReportFactory.getReportFactoryExtensions(). The default implementation is a no-op.

    • unregister

      default void unregister(Report report)
      Notify this object when the Report it was registered on has completed parsing. Will be called when this object is added to the list returned by ReportFactory.getReportFactoryExtensions(). The default implementation is a no-op.

    • configure

      default void configure(Json json)
      Configure the extension. This method will be called by the web-service immediately after the extension is added, to pass in any parameters set by the user. The default implementation does nothing
      Since:
      1.3

    • load

      default boolean load(Object o, Report report) throws IOException
      Attempt to load the specified object into the specified Report. If this extension can load the specified type of object, it should configure the report however it needs to, eventually call load(java.lang.Object, org.faceless.publisher.Report) with an InputSource, Reader or similar, and return true. If this extension cannot load the specified type of object, return false. This is the default.
      Throws:
      IOException