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.

See Also:

https://code.google.com/p/xdocreport/wiki/XDocReportDumper

Method Summary

Modifier and Type	Method and Description
void	dump(IXDocReport report, IContext context, DumperOptions options, java.io.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, java.io.InputStream documentIn, IContext context, DumperOptions option, java.io.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.
MimeMapping	getMimeMapping() Returns mime mapping switch the kind of the dumper.

Method Detail

dump

void dump(IXDocReport report,
          IContext context,
          DumperOptions options,
          java.io.OutputStream out)
   throws java.io.IOException,
          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 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:

java.io.IOException

XDocReportException

dump

void dump(IXDocReport report,
          java.io.InputStream documentIn,
          IContext context,
          DumperOptions option,
          java.io.OutputStream out)
   throws java.io.IOException,
          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:

java.io.IOException

XDocReportException

getMimeMapping

MimeMapping getMimeMapping()

Returns mime mapping switch the kind of the dumper.

Returns: