org.pentaho.reporting.engine.classic.core.modules.parser.bundle.writer
Interface BundleDataFactoryWriterHandler

All Known Implementing Classes:

CompoundDataFactoryWriteHandler, DirectSqlDataFactoryWriterHandler, DirectStaticDataFactoryWriterHandler, ExternalDataFactoryWriteHandler, SQLDataFactoryWriteHandler, StaticDataFactoryWriterHandler, TableDataFactoryWriteHandler

public interface BundleDataFactoryWriterHandler

Todo: Document Me

Author:

Thomas Morgner

Method Summary

String

writeDataFactory(org.pentaho.reporting.libraries.docbundle.WriteableDocumentBundle bundle, DataFactory dataFactory, BundleWriterState state) Writes a data-source into a own file.

Method Detail

writeDataFactory

String writeDataFactory(org.pentaho.reporting.libraries.docbundle.WriteableDocumentBundle bundle,
                        DataFactory dataFactory,
                        BundleWriterState state)
                        throws IOException,
                               BundleWriterException

Writes a data-source into a own file. The name of file inside the bundle is returned as string. The file name returned is always absolute and can be made relative by using the IOUtils of LibBase. If the writer-handler did not generate a file on its own, it should return null.

Parameters:

bundle - the bundle where to write to.

dataFactory - the data factory that should be written.

state - the writer state to hold the current processing information.

Returns:

the name of the newly generated file or null if no file was created.

Throws:

IOException - if any error occured

BundleWriterException - if a bundle-management error occured.