Description
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 JFramevariables 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:
Read a data file, create the internal data structure, create a GUI to display the structure, and let the user search the structure.
Sort the structure, use hash maps to create the structure more efficiently.
Create a thread for each job, cannot run until ship has a dock, create a GUI to show the progress of each job.
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 2 General Objectives:
Project 2 – Map class, Comparator, sorting
Use the JDK Map class to write more efficient code when constructing the internal data structures from the data file.
Implement SORTING using the Comparator interface together with the JDK support for sorting data structures, thus sorting on different fields of the classes from Project 1.
Extend the GUI from Project 1 to let the user sort the data at run-time.
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 Guidehow would a user start and run your project
any special features
effective screen shots are welcome, but don’t overdo this
Test Plando 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 2 Specific Goals:
Extend Project 1 to use advanced data structures and support sorting on various keys.
Required data structure – the data structure specified in
Project 1:
World has SeaPort’s
SeaPort has Dock’s, Ship’s, and Person’s
Dock has a Ship
Ship has Job’s
PassengerShip
CargoShip
Person has a skill
Job requires skills – optional until Project 3
PortTime
Use the HashMap class to support efficient linking of the classes used in Project 1.
The instances of the hash map class should be local to the readFile (Scanner) method.
These instances should be passed as explicit parameters to other methods used when reading the data file.
For example, the body of the methods like the following should be replaced to effectively use a <Integer, Ship hash map, the surrounding code needs to support this structure:
Ship getShipByIndex (int x, java.util.HashMap <Integer,
Ship hms) {
return hms.get(x);
} // end getDockByIndex
Since the body of this method has become trivial, perhaps the call to this method can be simply replaced by the get method of the HashMap.
Your code should be sure to handle a null return from this call gracefully.
The instances should be released (go out of scope, hence available for garbage collection) when the readFile method returns.
Comments: The idea here, besides getting some experience with an interesting JDK Collections class, is to change the operation of searching for an item with a particular index from an O(N) operation, ie searching through the entire data structure to see if the code can find the parent index parameter, to an O(1) operation, a hash map lookup. Of course, this isn’t so very interesting in such a small program, but consider what might happen with hundreds of ports, thousands of ships, and perhaps millions of persons and jobs.
Comments: Also, after the readFile operation, the indices are no longer interesting, and could be completely eliminated from the program. In this program, removing the index references could be accomplished by removing those variables from the parent class, Thing.
Implement comparators to support sorting:ships in port que ArrayList’s by weight, length, width, draft within their port que
all items withing their ArrayList’s by name
OPTIONALLY: sorting by any other field that can be compared
The sorting should be within the parent ArrayList
Extend the GUI from Project 1 to allow the user to:sort by the comparators defined in part 2.
Again, the GUI elements should be distinct from the other
classes in the program.
