Friday, December 18, 2009

Coding Standards


 Coding Standards:
  1. All the methods name whether it is in java script or java methods start with a small letter and the second word starts with a capital letter.
  2. All the java classes start with a capital letter.
  3. The name of the methods or classes is a verb showing its functionality.
  4.  All the variable names are understandable nouns or verbs.
  5. All the variables have been assigned some default values.
  6. Every function has a description as of what it does and explaining the parameters.
  7. There will be comments in the code whenever it is necessary to describe.
  8. Inline comments to show the end of control statements.
  9. 3 spaces indentation is provided.
  10. As part of file organization , al the css and javascript files are placed in css and js folders respectively besides html codes.
  11. The WEB-INF has classes folder which contains the classes.
  12. Error handling is done using try catch statements of java code.
  13. Where ever necessary we are using the relative path names and not the absolute path names.
  14. When ever there are some reusable components , they are placed in separate file so that they can be included as part of header files.


Traceability Matrix



Traceability Matrix

1-> UI Controller               2->Create case


3->Tagging                         4->View Authored


5->Add Teaching Notes    6->Record Audio


7->Speech to Text converter 8->Questions based on type (Templates)


9->Searching cases             10->Add Multimedia


11->Mail Server


12->Authentication


13->View Case status

The above shows the dependencies among different modules that were identified in the project.
The ‘X’ mark denotes a dependency from a module in that particular row to the corresponding columns.


Deployment View


This is the deployment view of the whole project, these are the things need to be deployed at the server side.


Class Diagram



These are the packages going to be used.


Here add multimedia,  add Questions based on type, Add teaching notes, view status are grouped as single package. The links show the communication.



Architecture description


Architectural Drivers:
Time efficiency (Performance, reusability, plug and play architecture)
Usability.
Portability.
Architecture Style Used:
Three tier architecture, Object oriented with plug and play architecture.
Justification:                
Portability: A web based architecture  enables the portability on all the types of browsers and also Operating system compatible. Hence the three-tiered-Architecture
Resuability: An object oriented approach enables reusability.
Plug and play Architecture: The division of the business tier into two layers one as basic platform and the other for plug and play justifies this architectural driver.

The logical diagram below shows the list of modules and how the various modules communicate among themselves. The software is based on the 3 tier architecture.  The Business Layer is divided into 2 sub layers- Plug and play module Layer and Basic Module Layer. Plug and play module layer helps to add the features based on authors requirement.  The Basic modules are the minimum modules that will be present in case authoring tool. This serves as  platform. Below is the list of all the modules that will be present in the Plug and Play layer.

1.      Speech to Text Converter will be tool that user can install to convert the audio based case description into text there by increasing the productivity of the author.
2.      Record Audio will help author to Record conversation with company people. So that he can later reuse audio for future references and as well as add the audio to the case.
3.      View Tool module is used by users other than author to view the case.
4.      Tagging module is used to create tag for the case and store them in data base.
5.      Searching case makes use of the tags generated by Tagging modules. By using tags we increase the searching efficiency and performance.
6.      Networking modules help to develop the connection to the server from a remote desktop system.
7.      Teaching and scribbling points helps teacher or author to add additional points to help them to store data. This data will be stored in file system.
8.      Add Multimedia is used add multimedia features to the case to make it more lively and interesting to read and understand
Basic Modules includes
  1. Creating case which is further divided into sub modules which are helpful in creating the case.
  2. Authentication module comes under basic module as it is important to verify the author before letting anyone edit/create the existing case. All the authentication details will be stored in the database.
  3. Logging is also an important feature as it helps to keep track of all the activities that the user did.
  4. Registration module is used to get the registration details of the company and the user. All the registration details are stored in the database.


Architecture-Logical Diagram


Conceptual Diagram






This conceptual architecture tells about the various modules that are present in the system and how they communicate with each other. Its an abstract view of the system.
The modules were divided based on the functionalities.
A double arrow indicates a two way communication.




The various modules that were identified and their descriptions are as follows:
1. User Interface Controller: This is the controller for the user Interface. This enables communication with various other modules.
2. Questions Based on type (Template): This brings some predefined questions, in the form of template based on the type of case study.
3. Tagging: The main goal of this module is allow to Tags to Added to the Case. This can be used latter for searching and designing the template.
4. Searching: This enables the teacher to search for cases in the existing using tags.
5. Add Multimedia: This enables to add images, Audio and video to enrich the events.
6. Speech To Text Converter: The main goal of this module is to convert a given audio into text format.
7. View Authored: The main goal of this module is allow to author to check how the case written looks immediately while editing.
8. Mail Server: This module enables to send mails.
9. Teaching Notes: This module enables the author can who add teaching notes at any point of time, which will be useful for both students and author.
10. Record audio: This module enables the author to record the audio.
11. Authentication: This module enables only authenticated users use the system.
12. Create Case: This enables to create a new case or edit a new case by adding or deleting actors, events, narrations.
13. View Case status: This module enables the user to know the status of all the cases he is undertaking.