org.pentaho.reporting.engine.classic.core.modules.misc.referencedoc
Class ReferenceDocModule

java.lang.Object
  org.pentaho.reporting.libraries.base.boot.DefaultModuleInfo
      org.pentaho.reporting.libraries.base.boot.AbstractModule
          org.pentaho.reporting.engine.classic.core.modules.misc.referencedoc.ReferenceDocModule

All Implemented Interfaces:

org.pentaho.reporting.libraries.base.boot.Module, org.pentaho.reporting.libraries.base.boot.ModuleInfo

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

The module definition for the reference documentation generator module.

Author:

Thomas Morgner

Constructor Summary

ReferenceDocModule()
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

Constructor Detail

ReferenceDocModule

public ReferenceDocModule()
                   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)

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.