com.irisel.modules
Class AbstractModule

java.lang.Object
  com.irisel.modules.DefaultModuleInfo
      com.irisel.modules.AbstractModule

All Implemented Interfaces:

Module, ModuleInfo

public abstract class AbstractModule
extends DefaultModuleInfo
implements Module

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". This file is no real property file, it follows a more complex rule set.

Lines starting with '#' are considered comments. Section headers start at the beginning of the line, section properties are indented with at least one whitespace.

The first section is always the module info and contains the basic module properties like name, version and a short description.

 module-info:
   name: xls-export-gui
   producer: The JFreeReport project - www.jfree.org/jfreereport
   description: A dialog component for the Excel table export.
   version.major: 0
   version.minor: 84
   version.patchlevel: 0
 

The 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.

 depends:
   module: org.jfree.report.modules.output.table.xls.XLSTableModule
   version.major: 0
   version.minor: 84
 

The property module references to the module implementation of the module package.

Author:

Thomas Morgner

Constructor Summary

AbstractModule()
Default Constructor.

Method Summary

void	configure() Configures the module by loading the configuration properties and adding them to the package configuration.
java.lang.String	getDescription() Returns the module description.
java.lang.String	getName() Returns the name of this module.
ModuleInfo[]	getOptionalModules() Returns a copy of the required modules array.
java.lang.String	getProducer() Returns the producer of the module.
ModuleInfo[]	getRequiredModules() Returns a copy of the required modules array.
java.lang.String	getSubSystem() Returns the modules subsystem.
void	setOptionalModules(ModuleInfo[] optionalModules) Defines the optional module descriptions for this module.
java.lang.String	toString() Returns a string representation of this module.

Methods inherited from class com.irisel.modules.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 com.irisel.modules.Module

initialize

Methods inherited from interface com.irisel.modules.ModuleInfo

getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel

Constructor Detail

AbstractModule

public AbstractModule()

Default Constructor.

Method Detail

getName

public java.lang.String getName()

Returns the name of this module.

Specified by:

getName in interface Module

Returns:

the module name

See Also:

org.jfree.report.modules.Module#getName()

getDescription

public java.lang.String getDescription()

Returns the module description.

Specified by:

getDescription in interface Module

Returns:

the description of the module.

See Also:

org.jfree.report.modules.Module#getDescription()

getProducer

public java.lang.String getProducer()

Returns the producer of the module.

Specified by:

getProducer in interface Module

Returns:

the producer.

See Also:

org.jfree.report.modules.Module#getProducer()

getRequiredModules

public ModuleInfo[] getRequiredModules()

Returns a copy of the required modules array. This array contains all description of the modules that need to be present to make this module work.

Specified by:

getRequiredModules in interface Module

Returns:

an array of all required modules.

See Also:

org.jfree.report.modules.Module#getRequiredModules()

getOptionalModules

public ModuleInfo[] getOptionalModules()

Returns a copy of the required modules array. This array contains all description of the optional modules that may improve the modules functonality.

Specified by:

getOptionalModules in interface Module

Returns:

an array of all required modules.

See Also:

org.jfree.report.modules.Module#getRequiredModules()

setOptionalModules

public void setOptionalModules(ModuleInfo[] optionalModules)

Defines the optional module descriptions for this module.

Parameters:

optionalModules - the optional modules.

toString

public java.lang.String toString()

Returns a string representation of this module.

Overrides:

toString in class DefaultModuleInfo

Returns:

the string representation of this module for debugging purposes.

See Also:

Object.toString()

configure

public void configure()
               throws ConfigException

Configures the module by loading the configuration properties and adding them to the package configuration.

Specified by:

configure in interface Module

Throws:

ConfigException

getSubSystem

public java.lang.String getSubSystem()

Returns the modules subsystem. If this module is not part of an subsystem then return the modules name, but never null.

Specified by:

getSubSystem in interface Module

Returns:

the name of the subsystem.