System Structure and Informal Specifications

User Interface Structure The 5 Star User Interface consists of HTML forms and pages which connect to Java Servlets.

This product uses a combination of static [unchanging .html files] and dynamic [created as output from the Java Servlet] pages. The static web pages that are included are the front opening page, the advanced search page, the add a new business page, and the administrator's login page. The dynamic web pages are search results pages, business information pages, and messages (login success, login failure, delete a business success, and other errors).

To facilitate ease of use, every page has a similar page header (with common links, and if applicable, a search box) and a similar footer (common links, and if applicable, an administrator logout link).

For specific information on how to use the 5 Star web interface see the User Manual

Back End Structure The user submits data values through web interface forms running off of Java Web Server Development Kit. (This is what we used, but any web server running Java1.2 or higher will work with this project.) These forms are sent (along with a hidden "action" value to tell the Java Servlet what action to take) to the Java Servlet. The Java Servlet processes the request, opens a connection to the MySQL database and submits a query (created from the web input), processes the results, and outputs a web page (either the results of that action or a corresponding error message). Some webpages (both static and dynamic), such as Adding a New Business and Adding a New Comment, contain JavaScript validation. This is to insure that the user does not input anything invalid and that he/she does not forget required fields which the database needs. By having field validation on the web page instead of having the server handle it, the user can simply go back to change the wrong input, rather than having to re-enter everything on the form.

Java Servlet Back End

The following classes and their operations make up the Java Servlet:

First, FSmain is called and passes off the parameters received from the web form (in the form of an HttpServletRequest) to FSrequest.

FSrequest is a class which contains and processes the request. FSrequest processes the request, determines the action type, stores the parameters for the action type (in a more convenient data type: a HashMap). It also does some username and password processing in the form of cookies to store them.

FSmain then uses FSconnection to create a connection to the database with the username and password processed from FSrequest. FSconnection is a connection managing class. It handles opening and closing connections to the MySQL database, and can execute queries based on simply a passed query type and an FSrequest. It uses FSqueryString to manage queryStrings.

FSqueryString is a class that both creates a queryString and interprets it. From the parameters it is passed, it will create a valid MySQL queryString, and will also hint back to FSconnection what kind of query it is (either updating, or not).

This diagram shows the general path input and output takes. It gives a general overview of the entire system.

Back End Diagram

This diagram gives a more specific description of the entire process.

System Structure Diagram

Both diagrams created with Microsoft Word
Back to top
< Back * Contents * Next >