Essay CMSC 335 Project 3 SeaPort

Essay CMSC 335 Project 3 SeaPort

CMSC 335 Project 3 SeaPort

Introduction – the SeaPort Project series
For this set of project, we wish to simulate some of the aspects of a number of Sea Ports.
Here are the classes and their instance variables we wish to define:

• SeaPortProgram extends JFrame
  • variables used by the GUI interface
  • world: World
• Thing implement Comparable <Thing>
  • index: int
  • name: String
  • parent: int
• World extends Thing
  • ports: ArrayList <SeaPort>
  • time: PortTime
• SeaPort extends Thing
  • docks: ArrayList <Dock>
  • que: ArrayList <Ship> // the list of ships waiting to
    dock
  • ships: ArrayList <Ship> // a list of all the ships at
    this port
  • persons: ArrayList <Person> // people with skills at
    this port
• Dock extends Thing
  • ship: Ship
• Ship extends Thing
  • arrivalTime, dockTime: PortTime
  • draft, length, weight, width: double
  • jobs: ArrayList <Job>
• PassengerShip extends Ship
  • numberOfOccupiedRooms: int
  • numberOfPassengers: int
  • numberOfRooms: int
• CargoShip extends Ship
  • cargoValue: double
  • cargoVolume: double
  • cargoWeight: double
• Person extends Thing
  • skill: String
• Job extends Thing – optional till Projects 3 and 4
  • duration: double
  • requirements: ArrayList <String>
    // should be some of the skills of the persons
• PortTime
  • time: int

Eventually, in Projects 3 and 4, you will be asked to show the progress of the jobs using JProgressBar’s.

Here’s a very quick overview of the projects:

1. Read a data file, create the internal data structure, create a GUI to display the structure, and let the user search the structure.
2. Sort the structure, use hash maps to create the structure more efficiently.
3. Create a thread for each job, cannot run until ship has a dock, create a GUI to show the progress of each job.
4. Simulate competing for resources (persons with particular skills) for each job.

General Objectives

Here are some notes about the projects, the particular features of object-oriented design and object-oriented programming (OOD/OOP) the we want to cover in this class and some of the features of Java to help support that style of programming. We also want to explore the Java GUI system a little, with particular emphasis on viewing the data structures and effective ways to display the running of multiple threads competing for resources.

The particular scenarios selected for each semester ask you to implement as many of these objectives as possible in some compelling way. We are always open to additions and suggestions.

Project 3 General Objectives
Project 3 – More JDK classes – GUI’s and threads

• Explore other GUI classes, such as JTree, JTable, and JProgressBar.
• Create and run threads
  • Competing for one resource.

Documentation Requirements:
You should start working on a documentation file before you do anything else with these projects, and fill in items as you go along. Leaving the documentation until the project is finished is not a good idea for any number of reasons.

The documentation should include the following (graded) elements:

• Cover page (including name, date, project, your class information)
• Design 
  • including a UML class diagram
  • classes, variables and methods: what they mean and why they are there
  • tied to the requirements of the project
• User’s Guide
  • how would a user start and run your project
  • any special features
  • effective screen shots are welcome, but don’t overdo this
• Test Plan
  • do this BEFORE you code anything
  • what do you EXPECT the project to do
  • justification for various data files, for example
• Lessons Learned o express yourself here o a way to keep good memories of successes after hard work

Project 3 Specific Goals:
Implement threads and a GUI interface using advanced Java Swing classes.

1. Required data the data structure specified in Project 1:
   1. World has SeaPort’s
   2. SeaPort has Dock’s, Ship’s, and Person’s
   3. Dock has a Ship
   4. Ship has Job’s
   5. PassengerShip
   6. CargoShip
   7. Person has a skill
   8. Job requires skills– NEW CLASS for this project!
   9. PortTime
2. Extend Project 2 to use the Swing class JTree effectively to display the contents of the data file.
   • (Optional) Implement a JTable to also show the contents of the data file. There are lots of options here for extending your program.
3. Threads:
   • Implement a thread for each job representing a task that ship requires.
   • Use the synchronize directive to avoid race conditions and insure that a dock is performing the jobs for only one ship at a time.
     • the jobs of a ship in the queue should not be progressing
     • when all the jobs for a ship are done, the ship should leave the dock, allowing a ship from the que to dock
     • once the ship is docked, the ships jobs should all progress
     • in Project 4, the jobs will also require persons with appropriate skills.
   • The thread for each job should be started as the job is read in from the data file immediately after the entire data file has been read.
   • Use delays to simulate the progress of each job.
   • Use a JProgressBar for each job to display the progress of that job.
   • Use JButton’s on the Job panel to allow the job to be suspended or cancelled.
4. As before, the GUI elements should be distinct (as appropriate) from the other classes in the program.
5. See the code at the end of this posting for some suggestions.

Suggestions for Project 3 Job class. Here is a sample of code for a Job class in another context, the Sorcerer’s Cave project. The code for this class will need some modifications, but this should give you an idea of the issues involved.
In fact, you should find much of this code redundant.

Also, some of the code at the following sites might give you some ideas about how to proceed with this project: