org.pentaho.reporting.engine.classic.core.modules.output.table.xls
Class ExcelTableModule

java.lang.Object
  extended by org.pentaho.reporting.libraries.base.boot.DefaultModuleInfo
      extended by org.pentaho.reporting.libraries.base.boot.AbstractModule
          extended by org.pentaho.reporting.engine.classic.core.modules.output.table.xls.ExcelTableModule
All Implemented Interfaces:
org.pentaho.reporting.libraries.base.boot.Module, org.pentaho.reporting.libraries.base.boot.ModuleInfo

public class ExcelTableModule
extends org.pentaho.reporting.libraries.base.boot.AbstractModule

The module definition for the Excel table export module.

Author:
Thomas Morgner

Field Summary
static String CONFIGURATION_PREFIX
          Deprecated. The configuration prefix should not be needed anymore. Always provide the full name.
static String EXCEL_FLOW_EXPORT_TYPE
           
static String EXCEL_PAGE_EXPORT_TYPE
           
static String EXCEL_STREAM_EXPORT_TYPE
           
static String XLSX_FLOW_EXPORT_TYPE
           
static String XLSX_PAGE_EXPORT_TYPE
           
static String XLSX_STREAM_EXPORT_TYPE
           
 
Constructor Summary
ExcelTableModule()
          DefaultConstructor.
 
Method Summary
 void initialize(org.pentaho.reporting.libraries.base.boot.SubSystem subSystem)
          Initializes the module.
 
Methods inherited from class org.pentaho.reporting.libraries.base.boot.AbstractModule
configure, getDescription, getName, getOptionalModules, getProducer, getRequiredModules, getSubSystem, setOptionalModules, toString
 
Methods inherited from class org.pentaho.reporting.libraries.base.boot.DefaultModuleInfo
equals, getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel, hashCode, setMajorVersion, setMinorVersion, setModuleClass, setPatchLevel
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.pentaho.reporting.libraries.base.boot.ModuleInfo
getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel
 

Field Detail

CONFIGURATION_PREFIX

public static final String CONFIGURATION_PREFIX
Deprecated. The configuration prefix should not be needed anymore. Always provide the full name.
The configuration prefix when reading the configuration settings from the report configuration.

See Also:
Constant Field Values

EXCEL_STREAM_EXPORT_TYPE

public static final String EXCEL_STREAM_EXPORT_TYPE
See Also:
Constant Field Values

EXCEL_FLOW_EXPORT_TYPE

public static final String EXCEL_FLOW_EXPORT_TYPE
See Also:
Constant Field Values

EXCEL_PAGE_EXPORT_TYPE

public static final String EXCEL_PAGE_EXPORT_TYPE
See Also:
Constant Field Values

XLSX_STREAM_EXPORT_TYPE

public static final String XLSX_STREAM_EXPORT_TYPE
See Also:
Constant Field Values

XLSX_FLOW_EXPORT_TYPE

public static final String XLSX_FLOW_EXPORT_TYPE
See Also:
Constant Field Values

XLSX_PAGE_EXPORT_TYPE

public static final String XLSX_PAGE_EXPORT_TYPE
See Also:
Constant Field Values
Constructor Detail

ExcelTableModule

public ExcelTableModule()
                 throws org.pentaho.reporting.libraries.base.boot.ModuleInitializeException
DefaultConstructor. Loads the module specification.

Throws:
org.pentaho.reporting.libraries.base.boot.ModuleInitializeException - if an error occured.
Method Detail

initialize

public void initialize(org.pentaho.reporting.libraries.base.boot.SubSystem subSystem)
                throws org.pentaho.reporting.libraries.base.boot.ModuleInitializeException
Initializes the module. Use this method to perform all initial setup operations. This method is called only once in a modules lifetime. If the initializing cannot be completed, throw a ModuleInitializeException to indicate the error,. The module will not be available to the system.

Parameters:
subSystem - the subSystem.
Throws:
org.pentaho.reporting.libraries.base.boot.ModuleInitializeException - if an error ocurred while initializing the module.