Class AbstractModule
- All Implemented Interfaces:
Module
,ModuleInfo
- Direct Known Subclasses:
DefaultLogModule
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: 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.
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
The reader helper provides a pushback interface for the reader to read and buffer complete lines. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
A short description of the module.private String
The name of the module.private ModuleInfo[]
The list of optional modules.private String
The name of the module producer.private ModuleInfo[]
The list of required modules.private String
The modules subsystem. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Configures the module by loading the configuration properties and adding them to the package configuration.Returns the module description.getName()
Returns the name of this module.Returns a copy of the required modules array.Returns the producer of the module.Returns a copy of the required modules array.Returns the modules subsystem.protected static boolean
isClassLoadable
(String name) Deprecated.use the method that passes in a context-class.protected static boolean
isClassLoadable
(String name, Class context) Tries to load a class to indirectly check for the existence of a certain library.private boolean
Checks, whether the next line in the reader is a value line.protected void
Loads the default module description from the file "module.properties".protected void
Loads the module descriptiong from the given input stream.private String
Parses an string to find the key section of the line.private String
parseValue
(String line) Parses the value section of the given line.protected void
performExternalInitialize
(String classname) Deprecated.Use the method that provides a class-context instead.protected void
performExternalInitialize
(String classname, Class context) ???.private DefaultModuleInfo
Reads an external module description.private void
Reads the module definition header.private String
readValue
(AbstractModule.ReaderHelper reader, String firstLine) Reads a multiline value the stream.protected void
setDescription
(String description) Defines the description of the module.protected void
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.toString()
Returns a string representation of this module.Methods inherited from class org.jfree.base.modules.DefaultModuleInfo
equals, getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel, hashCode, setMajorVersion, setMinorVersion, setModuleClass, setPatchLevel
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jfree.base.modules.Module
initialize
Methods inherited from interface org.jfree.base.modules.ModuleInfo
getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel
-
Field Details
-
requiredModules
The list of required modules. -
optionalModules
The list of optional modules. -
name
The name of the module. -
description
A short description of the module. -
producer
The name of the module producer. -
subsystem
The modules subsystem.
-
-
Constructor Details
-
AbstractModule
public AbstractModule()Default Constructor.
-
-
Method Details
-
loadModuleInfo
Loads the default module description from the file "module.properties". This file must be in the same package as the implementing class.- Throws:
ModuleInitializeException
- if an error occurs.
-
loadModuleInfo
Loads the module descriptiong from the given input stream. The module description must conform to the rules define in the class description. The file must be encoded with "ISO-8859-1" (like property files).- Parameters:
in
- the input stream from where to read the file- Throws:
ModuleInitializeException
- if an error occurs.
-
readValue
Reads a multiline value the stream. This will read the stream until a new key is found or the end of the file is reached.- Parameters:
reader
- the reader from where to read.firstLine
- the first line (which was read elsewhere).- Returns:
- the complete value, never null
- Throws:
IOException
- if an IO error occurs.
-
isNextLineValueLine
Checks, whether the next line in the reader is a value line.- Parameters:
reader
- from where to read the lines.- Returns:
- true, if the next line is a value line, false otherwise.
- Throws:
IOException
- if an IO error occurs.
-
readModuleInfo
Reads the module definition header. This header contains information about the module itself.- Parameters:
reader
- the reader from where to read the content.- Throws:
IOException
- if an error occures
-
parseKey
Parses an string to find the key section of the line. This section ends with an colon.- Parameters:
line
- the line which to parse- Returns:
- the key or null if no key is found.
-
parseValue
Parses the value section of the given line.- Parameters:
line
- the line that should be parsed- Returns:
- the value, never null
-
readExternalModule
Reads an external module description. This describes either an optional or a required module.- Parameters:
reader
- the reader from where to read the module- Returns:
- the read module, never null
- Throws:
IOException
- if an error occures.
-
getName
Returns the name of this module. -
setName
Defines the name of the module.- Parameters:
name
- the module name.
-
getDescription
Returns the module description.- Specified by:
getDescription
in interfaceModule
- Returns:
- the description of the module.
- See Also:
-
setDescription
Defines the description of the module.- Parameters:
description
- the module's desciption.
-
getProducer
Returns the producer of the module.- Specified by:
getProducer
in interfaceModule
- Returns:
- the producer.
- See Also:
-
setProducer
Defines the producer of the module.- Parameters:
producer
- the producer.
-
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 interfaceModule
- Returns:
- an array of all required modules.
- See Also:
-
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 interfaceModule
- Returns:
- an array of all required modules.
- See Also:
-
setRequiredModules
Defines the required module descriptions for this module.- Parameters:
requiredModules
- the required modules.
-
setOptionalModules
Defines the optional module descriptions for this module.- Parameters:
optionalModules
- the optional modules.
-
toString
Returns a string representation of this module.- Overrides:
toString
in classDefaultModuleInfo
- Returns:
- the string representation of this module for debugging purposes.
- See Also:
-
isClassLoadable
Deprecated.use the method that passes in a context-class.Tries to load a class to indirectly check for the existence of a certain library.- Parameters:
name
- the name of the library class.- Returns:
- true, if the class could be loaded, false otherwise.
-
isClassLoadable
Tries to load a class to indirectly check for the existence of a certain library.- 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.
-
configure
Configures the module by loading the configuration properties and adding them to the package configuration. -
performExternalInitialize
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
-
performExternalInitialize
protected void performExternalInitialize(String classname, Class context) throws ModuleInitializeException ???.- Parameters:
classname
- ?context
- ?- Throws:
ModuleInitializeException
- if there is an initialisation error.
-
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 interfaceModule
- Returns:
- the name of the subsystem.
-
setSubSystem
Defines the subsystem name for this module.- Parameters:
name
- the new name of the subsystem.
-