Package fr.opensagres.xdocreport.document.dump

Interface IDumper

All Known Implementing Classes:
AbstractDumper, AbstractProjectDumper, EclipseProjectDumper, JavaMainDumper, MavenProjectDumper
public interface IDumper
API of dumper. A dumper is enable to dump the whole context when report is generated :
  • the document template of the report.
  • the data context which can be exported as JSON.
  • the FieldsMetadata which can be exported as XML.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dump(IXDocReport report, fr.opensagres.xdocreport.template.IContext context, DumperOptions options, OutputStream out)
    Dump the given report and context by using the dumper configured with the given options and generates the result of the dump in the given out.
    void
    dump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, DumperOptions option, OutputStream out)
    Dump the given report and context by using the dumper configured with the given options and generates the result of the dump in the given out.
    fr.opensagres.xdocreport.converter.MimeMapping
    getMimeMapping()
    Returns mime mapping switch the kind of the dumper.

  • Method Details

    • dump

      void dump(IXDocReport report, fr.opensagres.xdocreport.template.IContext context, DumperOptions options, OutputStream out) throws IOException, fr.opensagres.xdocreport.core.XDocReportException
      Dump the given report and context by using the dumper configured with the given options and generates the result of the dump in the given out. This method must be called only if {@link IXDocReport#setCacheOriginalDocument(true)} is called when report is loaded.
      Parameters:
      report - the IXDocReport to dump.
      context - the IContext to dump.
      options - the dumper options.
      out - the output stream where dump must be written.
      Throws:
      IOException
      fr.opensagres.xdocreport.core.XDocReportException

    • dump

      void dump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, DumperOptions option, OutputStream out) throws IOException, fr.opensagres.xdocreport.core.XDocReportException
      Dump the given report and context by using the dumper configured with the given options and generates the result of the dump in the given out.
      Parameters:
      report - the IXDocReport to dump.
      documentIn - the InputStream of the report.
      context - the IContext to dump.
      options - the dumper options.
      out - the output stream where dump must be written.
      Throws:
      IOException
      fr.opensagres.xdocreport.core.XDocReportException

    • getMimeMapping

      fr.opensagres.xdocreport.converter.MimeMapping getMimeMapping()
      Returns mime mapping switch the kind of the dumper.
      Returns: