Objective

This homework has several objectives.  Those objectives are:

• Learn how to design and develop Graphical User Interfaces (GUI) using Java.
• How to write JUnit tests.
• Understand the concept of Code Coverage.
• Stream manipulation for I/O.
• Practice Java inner classes.
• Practice using the Java API.
• Use of software development tools (Eclipse Debugger, Findbugs tool, Code Coverage Tool).
• Get a better understanding of the MVC model by designing the view/controller associated with an application.

This homework is considered a closed homework.  Make sure you read the Open/Closed policy before continuing working on this project.

Overview

For this project you will complete the following tasks:

• Implement a Graphical User Interface (GUI) for the cruise application of Project #2.
• Expand the functionality of the cruise application according the specifications provided below.
• Write a set of JUnit tests that provides the maximum code coverage possible according to the specifications described in lecture.

Your project will be graded as follows:

GUI                                                            50 %
Java Construct Requirements                 10 %

Student Tests Implementation                 25 %

Provided JUnit tests                                   5 %

Style                                                          10 %

For this project:

• We encourage you to start working on this project as soon as possible, as there are a lot of details that can not be completely specified in this description, in particular the GUI requirements.  You should address these doubts ahead of time during lab session, or office hours. 

• Even if you are not planning to work on the project for a while make sure that:

  • You can compile a simple class using the provided code distribution.  If you have problems compiling a simple class see your TA immediately.

  • Submit your project using the "Submit Project" option in Eclipse and verify your submission has been received in the submit server.  It is important that you submit your project using the "Submit Project" option rather than uploading a jar file to the submit server.  If you are having problems with this submission process contact your TA or instructor immediately.

• You must debug your code using the Eclipse debugger and should not use "System.out.println" as a debug tool.  TAs in office hours will require you to use the debugger to show any problems you are experiencing.

• No release testing is associated with this project.

• Keep in mind that the submit server does not test the GUI you will define. 

• You do not need to provide an UML diagram for this project, although you are encouraged to create one for the GUI.

• The project's code distribution is available by checking out the project named p3. The code distribution provides you with the following:
  • A folder named src - In this folder you will find two packages named cruise and tests.
  • A package named cruise - You must implement all your classes and/or interfaces associated with the Model component in this package.
  • A package named tests - You will find the JUnit public tests we provided in this package.  You must provide JUnit tests by defining your tests in the StudentTests.java file we have left in this package.
  • PublicTests.java - This class represents a set of JUnit public tests  The expected results for each test can be found in the text files of the code distribution.

Specifications

Cruise Class Modifications

You must modify your Cruise class so that is now implements the Java interface CruiseInterface.  This interface is available in the cruise package and it includes all the methods you implemented for project #2 and two additional methods named loadPassengers and generateReport. 

• loadPassengers(String inputFileName) - Adds the passengers specified in the file inputFileName to the database.  The first line of the file indicates the number of passengers and subsequent lines provide information about the passengers.  The file databaseSource.txt in the code distribution illustrates the format in which the passengers' data will appear.
• generateReport(String outputFileName, ReportType type) - This method creates a file with a report.  The type of report generated depends on the type parameter which can assume the values Passengers, Crew, and All.  By the way, you must define the enumerated type ReportType in the cruise package (in a file by itself).  The Passengers report provides only information about passengers, the Crew report provides information about officers, engineers, and room attendants, and All report includes information about the ship, crew and passengers.  The files pubTest6ReportPassengers.txt,  pubTest6ReportCrew.txt, and pubTest6ReportAll.txt in the code distribution illustrate the format to follow for each report.

You will notice that the cruise methods in the CruiseInterface have been annotated with @NonNull, @CheckForNull or @CheckReturnValue.  These are annotations that allow the submit server findbugs tool to determine possible problems in your code.  You don't need to understand annotations in order to complete this project, however you should check the findbugs report (available through the submit server) for any possible errors findbugs might be detecting (more details about this will be provided in lecture).

Graphical User Interface (GUI)

You must implement your GUI in the cruiseGui package.  Make sure you implement a class named CruiseGui with a main that allow us to run your system.  Notice that you don't need to implement a fancy and beautiful interface in order to get full credit for the GUI component of this project.  You will receive full credit as long as you satisfy the following requirements:

• You must define a package named cruiseGui inside of the src folder of your code distribution.  Inside of the cruiseGui package you must define a class named CruiseGui with a main method that allow us to run the complete system.  Any classes associated with the GUI must appear in the cruiseGui package.
• You must define and use at least one inner class (not an anonymous class) in your implementation of the GUI.
• You must define and use at least one one anonymous inner class in your implementation of the GUI.
• You cannot read user input using System.in.
• You cannot generate results using System.out
• You must define one button (JButton) for each of the possible operations present in the CruiseInterface.  Choose a name that resembles the operation (e.g., AddPassenger).
• You can use any of the classes provided by the Swing library except the JOptionPane class.
• You must use at least the following components:
  • Box
  • JLabel
  • JTextArea
  • JScrollPane
  • JPanel
  • JFrame

Java Construct Requirements

• Your Cruise class must implement the CruiseInterface (e.g., public class Cruise implements CruiseInterface).  You will lose significant points if your class does not implements the interface.

• You must define an enumerated type called ReportType in the cruise package which can assume the values Passengers, Crew, and All.  Define the enumerated type in a file by itself.

• You must use the new for loop construct at least once.

• You must handle exceptions dealing with file manipulation by defining the appropriate catch clause.

• You may not use System.exit(0) in your code.  If you understand that at some point you need to stop the program execution then throw an exception with an appropriate message as follows:

                                       throw new IllegalArgumentException("Your message here");

JUnit Tests Implementation

You must provide tests in the file StudentTests.java present in the tests package.  These tests must try to achieve the maximum test coverage possible as described in lecture.  Keep in mind that these tests only tests the model component of the cruise application and not the GUI. 

Provided JUnit Tests

We have provided a couple of JUnit tests that verify the new features of the cruise application.  The JUnit tests include the Project#2 public and release tests.  Make sure your implementation satisfies these tests. 

Style Requirements

• You must avoid code duplication.  For example, if several methods in your class share the same code fragment place that fragment in a private method.
• You must follow Java conventions for identifiers.  For example, class/interface names must start with capitals.
• You must use meaningful variable names.
• You must indent your code using three or four spaces or by using the Eclipse "Correct Indentation" option.
• You must use the same style for blocks of curly brackets ({ }) throughout your code. 

Honor Section Requirements

In addition to the above requirements you must satisfy the following requirement:

• Your GUI must provide a menu (implemented using JMenuBar, JMenu, etc.) that allow us to generate the different types of reports.

Submission

Submit your project using the submit project option associated with Eclipse. 

Academic Integrity

Please make sure you read the academic integrity section of the syllabus so you understand what is permissible in our programming projects.  We want to remind you that we check your project against other students' projects and any case of academic dishonesty will be referred to the University's Office of Judicial Program