Project History

Use Cases Scenarios
Use Case Requirements
Bugs and Known Limitations

User Manuals Getting Started
General Tour
Configuration Options
Logging Tool Tour
Administration Tool Tour

Developers Architecture
Analysis of Design
Creating Plugins
Future Enhancements

Coding Practices


Classes which manage UI code should not extend swing classes

It is common in Java tutorials for UI classes to extend Java swing classes such as JPanel, JDialog and JMenuItem. However, often it is better for a class to have an instance of a Swing class rather than extend it through inheritance. One of the benefits of using this practice is that the generated JavaDocs are simpler.

Avoid using Singleton patterns that rely on static methods to return a single factory instance.

Any class found in packages *.presentationLayer.* which manages UI code should not extend swing classes such as JPanel or JMenuItem

Naming Conventions

Package naming conventions

Class Naming Conventions

Method Naming Conventions

Variable Naming Conventions

Coding Conventions within Class Files

Author: Kevin Garwood

(c)2010 Medical Research Council. Licensed under Apache 2.0.