Project 1

For this set of projects for the course, 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
o variables used by the GUI interface
o world: World

Thing implement Comparable <Thing>
o index: int
o name: String
o parent: int

World extends Thing
o ports: ArrayList <SeaPort>
o time: PortTime

SeaPort extends Thing
o docks: ArrayList <Dock>
o que: ArrayList <Ship> // the list of ships waiting to dock
o ships: ArrayList <Ship> // a list of all the ships at this port
o persons: ArrayList <Person> // people with skills at this port

Dock extends Thing
o ship: Ship

Ship extends Thing
o arrivalTime, dockTime: PortTime
o draft, length, weight, width: double
o jobs: ArrayList <Job>

PassengerShip extends Ship
o numberOfOccupiedRooms: int
o numberOfPassengers: int
o numberOfRooms: int

CargoShip extends Ship
o cargoValue: double
o cargoVolume: double
o cargoWeight: double

Person extends Thing
o skill: String

Job extends Thing - optional till Projects 3 and 4
o duration: double
o requirements: ArrayList <String>
// should be some of the skills of the persons

PortTime
o 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 all 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 a 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.

Project 1 General Objectives
Project 1 - classes, text data file, GUI, searching

Define and implement appropriate classes, including: o instance and class variables,
o constructors,
o toString methods, and
o other appropriate methods.

Read data from a text file:
o specified at run time,
ï‚§ JFileChooserjfc=newJFileChooser("."); // start at dot, the current directory
o using that data to create instances of the classes,
o creating a multi-tree (class instances related in hierarchical, has-some, relationships)
o organizing those instances in existing JDK structures which can be sorted, such as
ArrayList's.

Create a simple GUI:
o presenting the data in the structures with some buttons and
o text fields supporting SEARCHING on the various fields of each class.

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
o including a UML class diagram
o classes, variables and methods: what they mean and why they are there o tied to the requirements of the project
ï‚· User's Guide
o how would a user start and run your project o any special features
o effective screen shots are welcome, but don't overdo this
ï‚·Test Plan
o do this BEFORE you code anything
o what do you EXPECT the project to do
o 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 1 Specific Goals:

1. Create a GUI
2. Let the user select a data file, using JFileChooser
3. Read the data file, creating the specified internal data structure (see the Introduction for the classes and variables of the structure).
4. Display the internal data structure in a nice format in the GUI
1. use JScrollPane and JTextArea
5. Display the results of a Search specified by the user
1. JTextField to specify the search target
2. Searching targets: name, index, skill would be a minimum you are encouraged to provide other options
3. Note that a search may return more than one item
4. 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)
   o 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 <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 person person person person
Sara 50000 10000 electrician Duane 50002 10000 inspector Betsy 50004 10000 cleaner
Archie 50003 10000 captain 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(Shipms: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 code fragments 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

Coding Hints:
ï‚· Code format: (See Google Java Style guide for specifics (https://google.github.io/styleguide/javaguide.html))
o Your program should have no warnings
o Use the following compiler flag to show all warnings: javac -Xlint *.java
o More about setting up IDE's to show warnings
o Generics - your code should use generic declarations appropriately, and to eliminate all warnings
ï‚· Elegance:
o just the right amount of code
o effective use of existing classes in the JDK
o effective use of the class hierarchy, including features related to polymorphism.
ï‚· GUI notes:
o GUI should resize nicely
o DO NOT use the GUI editor/generators in an IDE (integrated development environment, such as Netbeans and Eclipse)
o Do use JPanel, JFrame, JTextArea, JTextField, JButton, JLabel, JScrollPane
ï‚§ panels on panels gives even more control of the display during resizing
ï‚§ JTable and/or JTree for Projects 2, 3 and 4
ï‚§ Font using the following gives a nicer display for this program, setting for the
JTextArea jta:
jta.setFont (new java.awt.Font ("Monospaced", 0, 12));
o GridLayout and BorderLayout - FlowLayout rarely resizes nicely
ï‚§ GridBagLayoutforextremecontroloverthedisplays
ï‚§ youmaywishtoexploreotherlayoutmanagers
o ActionListener, ActionEvent - responding to JButton events
ï‚§ Starting with JDK 8, lambda expression make defining listeners MUCH simpler.
See the example below, with jbr (read), jbd (display) and jbs (search) three different JButtons.

jcb is a JComboBox <String> and jtf is a JTextField.
               jbr.addActionListener (e -> readFile());
               jbd.addActionListener (e -> displayCave ());
               jbs.addActionListener (e -> search
((String)(jcb.getSelectedItem()), jtf.getText()));

Project 1 For this set of projects for the course, we wish to si...