System Design

I. System tools
  • GNU tomcat web server (4.1.27) is used as the web server.
    • bin: shutdown.sh, startup.sh
    • webapps: WebLvg
    • A port number 8100 is used for this web server.
  • GNU ant is used for development and deployment tool.
    • all: Clean build and dist, then compile
    • clean: Delete old build and dist directories
    • compile: Compile Java sources
    • deploy: Deploy application to servlets container
    • dist: Create binary distribution
    • javadoc: Create Javadoc API documentation
    • prepare: Create subdirectories as required
II. Project directory

The directory and file allocations for this project are relatively easy. Four tools, norm, luiNorm, wordInd, toAscii, and lvg, are clearly separated into four different directories. Another directory, called global, is used for source codes are shared between these four tools. A brief directory allocation is shown as follows:

------------------------------------------------------
+- WebLvg
|
+- src: all Java beans go here
|  +- global
|  +- luiNorm
|  +- lvg
|  +- norm
|  +- wordInd
|  +- toAscii
|
+- web
|  +- html
|  +- images
|  +- index.html: home page
|  +- jsp: all page ui & functions
|  |  +- global
|  |  +- luiNorm
|  |  +- lvg
|  |  +- norm
|  |  +- wordInd
|  |
|  +- WEB-INF
|  |  +- classes
|  |  +- lib
|  |  +- web.xml: project web parameters setup
------------------------------------------------------
III. Naming convention

Naming convention is not strictly enforced in this project due to the limited development time. However, the naming convention for files can be summarized as follows:

  • XXX.jsp: a jsp generates html page (with gui).
  • setXXX.jsp: a jsp which handle the form request from XXX.jsp (POST)
  • getXXX.jsp: a jsp which handle the hyper link request (GET).