|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.libraries.base.boot.DefaultModuleInfo
org.pentaho.reporting.libraries.base.boot.AbstractModule
public abstract class AbstractModule
The abstract module provides a default implementation of the module interface.
The module can be specified in an external property file. The file name of this specification defaults to "module.properties". The first and mandatory section is always the module info and contains the basic module properties like name, version and a short description.module.name: xls-export-gui module.producer: The JFreeReport project - www.jfree.org/jfreereport module.description: A dialog component for the Excel table export. module.version.major: 0 module.version.minor: 84 module.version.patchlevel: 0The properties name, producer and description are simple strings. They may span multiple lines, but may not contain a colon (':'). The version properties are integer values. This section may be followed by one or more "depends" sections. These sections describe the base modules that are required to be active to make this module work. The package manager will enforce this policy and will deactivate this module if one of the base modules is missing.
dependency.module-id.module: org.pentaho.reporting.engine.classic.core.modules.output.table.xls.XLSTableModule dependency.module-id.version.major: 0 dependency.module-id.version.minor: 84The property *.module references to the module implementation of the module package. The module-id is a per-module-definition-unique identifier and it is recommended to set it to the referenced module's name for documentary purposes.
Method Summary | |
---|---|
void |
configure(SubSystem subSystem)
Configures the module by loading the configuration properties and adding them to the package configuration. |
String |
getDescription()
Returns the module description. |
String |
getName()
Returns the name of this module. |
ModuleInfo[] |
getOptionalModules()
Returns a copy of the required modules array. |
String |
getProducer()
Returns the producer of the module. |
ModuleInfo[] |
getRequiredModules()
Returns a copy of the required modules array. |
String |
getSubSystem()
Returns the modules subsystem. |
void |
setOptionalModules(ModuleInfo[] optionalModules)
Defines the optional module descriptions for this module. |
String |
toString()
Returns a string representation of this module. |
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.Module |
---|
initialize |
Methods inherited from interface org.pentaho.reporting.libraries.base.boot.ModuleInfo |
---|
getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel |
Method Detail |
---|
public String getName()
getName
in interface Module
Module.getName()
public String getDescription()
getDescription
in interface Module
Module.getDescription()
public String getProducer()
getProducer
in interface Module
Module.getProducer()
public ModuleInfo[] getRequiredModules()
getRequiredModules
in interface Module
Module.getRequiredModules()
public ModuleInfo[] getOptionalModules()
getOptionalModules
in interface Module
Module.getRequiredModules()
public void setOptionalModules(ModuleInfo[] optionalModules)
optionalModules
- the optional modules.public String toString()
toString
in class DefaultModuleInfo
Object.toString()
public void configure(SubSystem subSystem)
configure
in interface Module
subSystem
- the subsystem.public String getSubSystem()
getSubSystem
in interface Module
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |