org.pentaho.reporting.libraries.base.boot
public abstract class AbstractModule extends DefaultModuleInfo implements Module
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.
Constructor Summary | |
---|---|
protected | AbstractModule()
Default Constructor. |
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. |
protected static boolean | isClassLoadable(String name, Class context)
Tries to load a class to indirectly check for the existence
of a certain library.
|
protected void | loadModuleInfo()
Loads the default module description from the file "module.properties". |
protected void | loadModuleInfo(InputStream in)
Loads the module descriptiong from the given input stream. |
protected void | performExternalInitialize(String classname)
Tries to load an module initializer and uses this initializer to initialize
the module.
|
protected void | performExternalInitialize(String classname, Class context)
Executes an weakly referenced external initializer. |
protected void | setDescription(String description)
Defines the description of the module.
|
protected void | setName(String name)
Defines the name of the module.
|
void | setOptionalModules(ModuleInfo[] optionalModules)
Defines the optional module descriptions for this module.
|
protected void | setProducer(String producer)
Defines the producer of the module.
|
protected void | setRequiredModules(ModuleInfo[] requiredModules)
Defines the required module descriptions for this module.
|
protected void | setSubSystem(String name)
Defines the subsystem name for this module. |
String | toString()
Returns a string representation of this module.
|
Parameters: subSystem the subsystem.
Returns: the description of the module.
See Also: getDescription
Returns: the module name
See Also: getName
Returns: an array of all required modules.
See Also: getRequiredModules
Returns: the producer.
See Also: getProducer
Returns: an array of all required modules.
See Also: getRequiredModules
Returns: the name of the subsystem.
Parameters: name the name of the library class. context the context class to get a classloader from.
Returns: true, if the class could be loaded, false otherwise.
Throws: ModuleInitializeException if an error occurs.
Parameters: in the input stream from where to read the file
Throws: ModuleInitializeException if an error occurs.
Deprecated: Use the method that provides a class-context instead.
Tries to load an module initializer and uses this initializer to initialize the module.Parameters: classname the class name of the initializer.
Throws: ModuleInitializeException if an error occures
Parameters: classname the classname of the ModuleInitializer
implementation context the class-loader context from where to load the module's classes.
Throws: ModuleInitializeException if an error occured or the initializer could not be found.
Parameters: description the module's desciption.
Parameters: name the module name.
Parameters: optionalModules the optional modules.
Parameters: producer the producer.
Parameters: requiredModules the required modules.
Parameters: name the new name of the subsystem.
Returns: the string representation of this module for debugging purposes.
See Also: Object#toString()