Java Doc for AbstractModule.java in  » Graphic-Library » jcommon-components » org » jfree » base » modules » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Graphic Library » jcommon components » org.jfree.base.modules 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jfree.base.modules.DefaultModuleInfo
      org.jfree.base.modules.AbstractModule

All known Subclasses:   org.jfree.base.log.DefaultLogModule,
AbstractModule
abstract public class AbstractModule extends DefaultModuleInfo implements Module(Code)
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
public  AbstractModule()
     Default Constructor.

Method Summary
public  voidconfigure(SubSystem subSystem)
     Configures the module by loading the configuration properties and adding them to the package configuration.
public  StringgetDescription()
     Returns the module description.
public  StringgetName()
     Returns the name of this module.
public  ModuleInfo[]getOptionalModules()
     Returns a copy of the required modules array.
public  StringgetProducer()
     Returns the producer of the module.
public  ModuleInfo[]getRequiredModules()
     Returns a copy of the required modules array.
public  StringgetSubSystem()
     Returns the modules subsystem.
protected static  booleanisClassLoadable(String name)
     Tries to load a class to indirectly check for the existence of a certain library.
Parameters:
  name - the name of the library class.
protected  voidloadModuleInfo()
     Loads the default module description from the file "module.properties".
protected  voidloadModuleInfo(InputStream in)
     Loads the module descriptiong from the given input stream.
protected  voidperformExternalInitialize(String classname)
     Tries to load an module initializer and uses this initializer to initialize the module.
protected  voidsetDescription(String description)
     Defines the description of the module.
protected  voidsetName(String name)
     Defines the name of the module.
public  voidsetOptionalModules(ModuleInfo[] optionalModules)
     Defines the optional module descriptions for this module.
protected  voidsetProducer(String producer)
     Defines the producer of the module.
protected  voidsetRequiredModules(ModuleInfo[] requiredModules)
     Defines the required module descriptions for this module.
protected  voidsetSubSystem(String name)
     Defines the subsystem name for this module.
public  StringtoString()
     Returns a string representation of this module.


Constructor Detail
AbstractModule
public AbstractModule()(Code)
Default Constructor.




Method Detail
configure
public void configure(SubSystem subSystem)(Code)
Configures the module by loading the configuration properties and adding them to the package configuration.
Parameters:
  subSystem - the subsystem.



getDescription
public String getDescription()(Code)
Returns the module description.
See Also:   Module.getDescription the description of the module.



getName
public String getName()(Code)
Returns the name of this module.
See Also:   Module.getName the module name



getOptionalModules
public ModuleInfo[] getOptionalModules()(Code)
Returns a copy of the required modules array. This array contains all description of the optional modules that may improve the modules functonality.
See Also:   Module.getRequiredModules an array of all required modules.



getProducer
public String getProducer()(Code)
Returns the producer of the module.
See Also:   Module.getProducer the producer.



getRequiredModules
public ModuleInfo[] getRequiredModules()(Code)
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.
See Also:   Module.getRequiredModules an array of all required modules.



getSubSystem
public String getSubSystem()(Code)
Returns the modules subsystem. If this module is not part of an subsystem then return the modules name, but never null. the name of the subsystem.



isClassLoadable
protected static boolean isClassLoadable(String name)(Code)
Tries to load a class to indirectly check for the existence of a certain library.
Parameters:
  name - the name of the library class. true, if the class could be loaded, false otherwise.



loadModuleInfo
protected void loadModuleInfo() throws ModuleInitializeException(Code)
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
protected void loadModuleInfo(InputStream in) throws ModuleInitializeException(Code)
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.



performExternalInitialize
protected void performExternalInitialize(String classname) throws ModuleInitializeException(Code)
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



setDescription
protected void setDescription(String description)(Code)
Defines the description of the module.
Parameters:
  description - the module's desciption.



setName
protected void setName(String name)(Code)
Defines the name of the module.
Parameters:
  name - the module name.



setOptionalModules
public void setOptionalModules(ModuleInfo[] optionalModules)(Code)
Defines the optional module descriptions for this module.
Parameters:
  optionalModules - the optional modules.



setProducer
protected void setProducer(String producer)(Code)
Defines the producer of the module.
Parameters:
  producer - the producer.



setRequiredModules
protected void setRequiredModules(ModuleInfo[] requiredModules)(Code)
Defines the required module descriptions for this module.
Parameters:
  requiredModules - the required modules.



setSubSystem
protected void setSubSystem(String name)(Code)
Defines the subsystem name for this module.
Parameters:
  name - the new name of the subsystem.



toString
public String toString()(Code)
Returns a string representation of this module.
See Also:   java.lang.Object.toString the string representation of this module for debugging purposes.



Methods inherited from org.jfree.base.modules.DefaultModuleInfo
public boolean equals(Object o)(Code)(Java Doc)
public String getMajorVersion()(Code)(Java Doc)
public String getMinorVersion()(Code)(Java Doc)
public String getModuleClass()(Code)(Java Doc)
public String getPatchLevel()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public void setMajorVersion(String majorVersion)(Code)(Java Doc)
public void setMinorVersion(String minorVersion)(Code)(Java Doc)
public void setModuleClass(String moduleClass)(Code)(Java Doc)
public void setPatchLevel(String patchLevel)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.