CLICK HERE TO DOWNLOAD THIS ANSWER INSTANTLY $28 Only
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:
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 try ask you to implement as many of these objectives as possible in some compelling way. We are always open to additions and suggestions.
General objects for each project:
Project 1 - classes, text data file, GUI, searchingDefine and implement appropriate classes, including:
instance and class variables,
constructors,
toString methods, and
other appropriate methods.
Read data from a text file:specified at run time,
JFileChooser jfc = new JFileChooser (".");
// start at dot, the current directory
using that data to create instances of the classes,
creating a multi-tree (class instances related in hierarchical, has-some, relationships), and
organizing those instances in existing JDK structures which can be sorted, such as ArrayList's.
Create a simple GUI:
presenting the data in the structures with with some buttons and
text fields supporting SEARCHING on the various fields of each class.
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.
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.
Project 4 - ConcurrencyResource pools
Threads competing for multiple resources
Blocking threads
Extending the GUI interface to visualize the resource pools and progress of the various threads.
Documentation
HINT: 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
express yourself here
a way to keep good memories of successes after hard work
CAUTION: the file size should be reasonable, currently < 5 MBytes, mostly < 1 MB.
Project 1 - Also see Grading
The goals are:
Create a GUI
Let the user select a data file, using JFileChooser
Read the data file, creating the specified internal data structure (see the Introduction for the classes and variables of the structure).
Display the internal data structure in a nice format in the GUI
use JScrollPane and JTextArea
Display the results of a Search specified by the user
JTextField to specify the search target
Searching targets: name, index, skill would be a minimum
you are encouraged to provide other options
Note that a search may return more than one item
DO NOT create new data structures (beyond the specified internal data structure) to search
you may create a structure of found items as a return value
Data file format:
Each item in the simulation will appear on a single line of the data file.
The data file may have comment lines, which will start with a //.
There may be blank lines in the data file, which your program should accept and ignore.
The data lines will start with one of the following flag values, indicating which item is being specified, its name, its index, and the index of its parent - which is used to specify the connections used to create the internal data structure (ie, assign an item to it parent or parent ArrayList).
For most items there will be additional fields appropriate to the class of that item.
The fields on a line are space delimited (perhaps more than one space)
This works well with Scanner methods, such as next(), nextInt() and nextDouble().
Here are the details of valid lines, with an example of each line.
// port name index parent(null)
// port <string> <int> <int>
port Kandahar 10002 0
// dock name index parent(port)
// dock <string> <int> <int>
dock Pier_5 20005 10001 30005
// ship name index parent(dock/port) weight length width draft
// ship <string> <int> <int> <double> <double> <double> <double>
ship Reason 40003 10000 165.91 447.15 85.83 27.07
// cship name index parent(dock/port) weight length width draft cargoWeight cargoVolume cargoValue
// cship <string> <int> <int> <double> <double> <double> <double> <double> <double> <double>
cship Suites 40003 10000 165.91 447.15 85.83 27.07 125.09 176.80 857.43
// pship name index parent(dock/port) weight length width draft numPassengers numRooms numOccupied
// pship <string> <int> <int> <double> <double> <double> <double> <int> <int> <int>
pship "ZZZ_Hysterics" 30002 20002 103.71 327.92 56.43 30.23 3212 917 917
// person name index parent skill
// person <string> <int> <int> <string>
person Alberto 50013 10001 cleaner
// job name index parent duration [skill]* (zero or more, matches skill in person, may repeat)
// job <string> <int> <int> <double> [<string>]* (ie, zero or more)
job Job_10_94_27 60020 30007 77.78 carpenter cleaner clerk
You may assume that the data file is correctly formatted and that the parent links exist and are encountered in the data file as item indices before they are referenced as parent links.
There is a Java program (CreateSeaPortDataFile.java) provided with this package that will generate data files with various characteristics with the correct format. You should be using the program to generate your own data files to test various aspects of your project programs.
Sample input file:
// File: aSPaa.txt
// Data file for SeaPort projects
// Date: Sat Jul 09 22:51:16 EDT 2016
// parameters: 1 1 5 5 1 5
// ports, docks, pships, cships, jobs, persons
// port name index parent(null)
// port <string> <int> <int>
port Lanshan 10000 0
// dock name index parent(port)
// dock <string> <int> <int>
dock Pier_4 20004 10000 30004
dock Pier_0 20000 10000 30000
dock Pier_1 20001 10000 30001
dock Pier_3 20003 10000 30003
dock Pier_2 20002 10000 30002
// pship name index parent(dock/port) weight length width draft numPassengers numRooms numOccupied
// pship <string> <int> <int> <double> <double> <double> <double> <int> <int> <int>
pship Gallinules 30000 20000 125.99 234.70 60.67 37.14 746 246 246
pship Remora 30001 20001 126.38 358.27 74.12 31.54 3768 979 979
pship Absentmindedness 30004 20004 86.74 450.43 33.13 41.67 2143 920 920
pship Preanesthetic 30003 20003 149.85 483.92 125.71 31.21 166 409 83
pship Shoetrees 30002 20002 134.41 156.96 120.31 35.20 1673 633 633
// cship name index parent(dock/port) weight length width draft cargoWeight cargoVolume cargoValue
// cship <string> <int> <int> <double> <double> <double> <double> <double> <double> <double>
cship Erosional 40001 10000 200.80 242.33 38.31 23.49 172.73 188.54 235.57
cship Kielbasas 40000 10000 120.85 362.55 96.82 19.09 33.08 188.31 261.57
cship Generics 40002 10000 79.90 234.26 73.18 15.71 125.27 179.00 729.95
cship Barcelona 40003 10000 219.92 443.54 104.44 34.16 86.69 139.89 813.72
cship Toluene 40004 10000 189.12 448.99 73.97 37.67 88.90 175.03 1002.63
// person name index parent skill
// person <string> <int> <int> <string>
person Sara 50000 10000 electrician
person Duane 50002 10000 inspector
person Betsy 50004 10000 cleaner
person Archie 50003 10000 captain
person Thomas 50001 10000 clerk
Sample output as plain text - which should be displayed in a JTextArea on a JScrollPane in the BorderLayout.CENTER area of a JFrame:
>>>>> The world:
SeaPort: Lanshan 10000
Dock: Pier_4 20004
Ship: Passenger ship: Absentmindedness 30004
Dock: Pier_0 20000
Ship: Passenger ship: Gallinules 30000
Dock: Pier_1 20001
Ship: Passenger ship: Remora 30001
Dock: Pier_3 20003
Ship: Passenger ship: Preanesthetic 30003
Dock: Pier_2 20002
Ship: Passenger ship: Shoetrees 30002
--- List of all ships in que:
> Cargo Ship: Erosional 40001
> Cargo Ship: Kielbasas 40000
> Cargo Ship: Generics 40002
> Cargo Ship: Barcelona 40003
> Cargo Ship: Toluene 40004
--- List of all ships:
> Passenger ship: Gallinules 30000
> Passenger ship: Remora 30001
> Passenger ship: Absentmindedness 30004
> Passenger ship: Preanesthetic 30003
> Passenger ship: Shoetrees 30002
> Cargo Ship: Erosional 40001
> Cargo Ship: Kielbasas 40000
> Cargo Ship: Generics 40002
> Cargo Ship: Barcelona 40003
> Cargo Ship: Toluene 40004
--- List of all persons:
> Person: Sara 50000 electrician
> Person: Duane 50002 inspector
> Person: Betsy 50004 cleaner
> Person: Archie 50003 captain
> Person: Thomas 50001 clerk
Suggestions:
Methods that should be implemented.
Each class should have an appropriate toString method. Here is an example of two such methods:
In SeaPort - showing all the data structures:
public String toString () {
String st = "\n\nSeaPort: " + super.toString();
for (Dock md: docks) st += "\n" + md;
st += "\n\n --- List of all ships in que:";
for (Ship ms: que ) st += "\n > " + ms;
st += "\n\n --- List of all ships:";
for (Ship ms: ships) st += "\n > " + ms;
st += "\n\n --- List of all persons:";
for (Person mp: persons) st += "\n > " + mp;
return st;
} // end method toString
In PassengerShip, using parent toString effectively:
public String toString () {
String st = "Passenger ship: " + super.toString();
if (jobs.size() == 0)
return st;
for (Job mj: jobs) st += "\n - " + mj;
return st;
} // end method toString
Each class should have an appropriate Scanner constructor, allowing the class to take advantage of super constructors, and any particular constructor focusing only on the addition elements of interest to that particular class. As an example, here's one way to implement the PassengerShip constructor:
PassengerShip Scanner constructor, the earlier fields are handled by Thing (fields: name, index, parent) and Ship (fields: weight, length, width, draft) constructors.
public PassengerShip (Scanner sc) {
super (sc);
if (sc.hasNextInt()) numberOfPassengers = sc.nextInt();
if (sc.hasNextInt()) numberOfRooms = sc.nextInt();
if (sc.hasNextInt()) numberOfOccupiedRooms = sc.nextInt();
} // end end Scanner constructor
In the World class, we want to read the text file line by line. Here are some useful methods types and codefragments that you should find helpful:
Handling a line from the file:
void process (String st) {
// System.out.println ("Processing >" + st + "<");
Scanner sc = new Scanner (st);
if (!sc.hasNext())
return;
switch (sc.next()) {
case "port" : addPort (sc);
break;
Finding a ship by index - finding the parent of a job, for example:
Ship getShipByIndex (int x) {
for (SeaPort msp: ports)
for (Ship ms: msp.ships)
if (ms.index == x)
return ms;
return null;
} // end getDockByIndex
Linking a ship to its parent:
void assignShip (Ship ms) {
Dock md = getDockByIndex (ms.parent);
if (md == null) {
getSeaPortByIndex (ms.parent).ships.add (ms);
getSeaPortByIndex (ms.parent).que.add (ms);
return;
}
md.ship = ms;
getSeaPortByIndex (md.parent).ships.add (ms);
} // end method assignShip
You will probably find the comments in the following helpful, they are mostly about similar projects and general issues in Java relevant to our programs:
CMSC 335 Information
Cave Strategy - getting started
Project 2 - Also see Grading
Extend Project 1 to use advanced data structures and support sorting on various keys.
Elaboration:
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.
Project 3 - Also see Grading
Implement threads and a GUI interface using advanced Java Swing classes.
The project will be graded according the criteria for the final project - see below.
Elaboration:
Required data 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- NEW CLASS for this project!
PortTime
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.
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.
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.
As before, the GUI elements should be distinct (as appropriate) from the other classes in the program.
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:
Project 3 Example - Sorcerer's Cave, note that even this one isn't complete
run method - detailed analysis of the run method in the Job class in the Cave project
