Project PhilosophySeaPorts ProjectDate: July 10, 2016by Nicholas Duchon
|
Outline: |
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:
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:
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.
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:
CAUTION: the file size should be reasonable, currently < 5
MBytes, mostly < 1 MB.
The goals are:
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
// the yellow field should be ignored
// dock name index parent(port)shipIndex
// dock <string> <int> <int><int>
dock Pier_5 20005 1000130005 // 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.
// 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
Methods that should be implemented.
Each class should have an appropriate toString method. Here is an
example of two such methods:
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:
In the World class, we want to read the text file line by line.
Here are some useful methods types and code fragments that
you should find helpful:
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:
Extend Project 1 to use
advanced data structures and support sorting on various keys.
Elaboration:
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:
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:
//
j:<index>:<name>:<creature
index>:<time>[:<required artifact
type>:<number>]*
class Job extends CaveElement
implements Runnable {
static Random
rn = new Random ();
JPanel
parent;
Creature
worker = null;
int jobIndex;
long jobTime;
String
jobName = "";
JProgressBar
pm = new JProgressBar ();
boolean
goFlag = true, noKillFlag = true;
JButton
jbGo = new JButton ("Stop");
JButton
jbKill = new JButton ("Cancel");
Status status
= Status.SUSPENDED;
enum Status
{RUNNING, SUSPENDED, WAITING, DONE};
public Job (HashMap
<Integer, CaveElement> hmElements, JPanel cv, Scanner
sc) {
parent = cv;
sc.next (); // dump first field, j
jobIndex = sc.nextInt ();
jobName = sc.next ();
int target = sc.nextInt ();
worker = (Creature) (hmElements.get (target));
jobTime = sc.nextInt ();
pm = new JProgressBar ();
pm.setStringPainted (true);
parent.add (pm);
parent.add (new JLabel (worker.name, SwingConstants.CENTER));
parent.add (new JLabel (jobName ,
SwingConstants.CENTER));
parent.add (jbGo);
parent.add (jbKill);
new Thread (this).start();
}
// end constructor
// JLabel jln = new JLabel
(worker.name);
//
following shows how to align text relative to icon
// jln.setHorizontalTextPosition
(SwingConstants.CENTER);
// jln.setHorizontalAlignment
(SwingConstants.CENTER);
// parent.jrun.add (jln);
public void toggleGoFlag () {
goFlag = !goFlag;
}
// end method toggleRunFlag
public void setKillFlag () {
noKillFlag = false;
jbKill.setBackground (Color.red);
}
// end setKillFlag
void showStatus (Status st) {
status = st;
switch (status) {
case RUNNING:
jbGo.setBackground
(Color.green);
jbGo.setText
("Running");
break;
case SUSPENDED:
jbGo.setBackground
(Color.yellow);
jbGo.setText
("Suspended");
break;
case WAITING:
jbGo.setBackground
(Color.orange);
jbGo.setText
("Waiting turn");
break;
case DONE:
jbGo.setBackground
(Color.red);
jbGo.setText
("Done");
break;
}
// end switch on status
}
// end showStatus
public void run () {
long time = System.currentTimeMillis();
long startTime = time;
long stopTime = time + 1000 * jobTime;
double duration = stopTime - time;
synchronized (worker.party) { // party since looking forward
to P4 requirements
while (worker.busyFlag) {
showStatus
(Status.WAITING);
try {
worker.party.wait();
}
catch
(InterruptedException e) {
} // end try/catch
block
} // end while waiting for
worker to be free
worker.busyFlag = true;
} // end
sychronized on worker
while (time < stopTime && noKillFlag) {
try {
Thread.sleep (100);
} catch (InterruptedException e)
{}
if (goFlag) {
showStatus
(Status.RUNNING);
time += 100;
pm.setValue
((int)(((time - startTime) / duration) * 100));
} else {
showStatus
(Status.SUSPENDED);
} // end if stepping
}
// end runninig
pm.setValue (100);
showStatus (Status.DONE);
synchronized (worker.party) {
worker.busyFlag = false;
worker.party.notifyAll ();
}
}
// end method run - implements runnable
public String toString () {
String sr = String.format ("j:%7d:%15s:%7d:%5d", jobIndex,
jobName, worker.index, jobTime);
return sr;
}
//end method toString
} // end class Job
Extend project 3 to include making jobs wait until people with
the resources required by the job are available at the port.
Elaboration:
Your project is due by midnight, EST, on the day of the date
posted in the class schedule. We do not recommend staying up all
night working on your project - it is so very easy to really mess
up a project at the last minute by working when one was overly
tired.
Your instructor's policy on late projects applies to this
project.
Submitted projects that show evidence of plagiarism will be
handled in accordance with UMUC Policy 150.25 — Academic
Dishonesty and Plagiarism.
Documentation format and length. The documentation describing and
reflecting on your design and approach should be written using
Microsoft Word, and should be of reasonable length. The font size
should be 12 point. The page margins should be one inch. The
paragraphs should be double spaced. All figures, tables,
equations, and references should be properly labeled and formatted
using APA, IEEE or ACM style.
Attributes | Value |
Project design | 20 points |
Project functionality | 40 points |
Test data | 20 points |
Approach documentation | 15 points |
Approach documentation grammar and spelling |
5 points |
Total | 100 points |
The files in the zip file package: