fr.opensagres.xdocreport.document.dump

Class AbstractDumper

java.lang.Object

fr.opensagres.xdocreport.document.dump.AbstractDumper

All Implemented Interfaces:

IDumper

Direct Known Subclasses:

AbstractProjectDumper, JavaMainDumper

public abstract class AbstractDumper
extends java.lang.Object
implements IDumper

Constructor Summary

Constructors

Constructor and Description
AbstractDumper()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doDump(IXDocReport report, java.io.InputStream documentIn, IContext context, DumperOptions option, ITemplateEngine templateEngine, java.io.OutputStream out)
void	dump(IXDocReport report, 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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fr.opensagres.xdocreport.document.dump.IDumper

getMimeMapping

Constructor Detail

AbstractDumper

public AbstractDumper()

Method Detail

dump

public void dump(IXDocReport report,
                 IContext context,
                 DumperOptions option,
                 java.io.OutputStream out)
          throws java.io.IOException,
                 XDocReportException

Description copied from interface: IDumper

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.

Specified by:

dump in interface IDumper

Parameters:

report - the IXDocReport to dump.

context - the IContext to dump.

option - the dumper options.

out - the output stream where dump must be written.

Throws:

java.io.IOException

XDocReportException

dump

public final void dump(IXDocReport report,
                       java.io.InputStream documentIn,
                       IContext context,
                       DumperOptions option,
                       java.io.OutputStream out)
                throws java.io.IOException,
                       XDocReportException

Description copied from interface: IDumper

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.

Specified by:

dump in interface IDumper

Parameters:

report - the IXDocReport to dump.

documentIn - the InputStream of the report.

context - the IContext to dump.

out - the output stream where dump must be written.

Throws:

java.io.IOException

XDocReportException

doDump

protected abstract void doDump(IXDocReport report,
                               java.io.InputStream documentIn,
                               IContext context,
                               DumperOptions option,
                               ITemplateEngine templateEngine,
                               java.io.OutputStream out)
                        throws java.io.IOException,
                               XDocReportException

Throws:

java.io.IOException

XDocReportException