School of ITEE
CSSE2002/7023 — Semester 1, 2021
Assignment 1
Due: 1 April 2021 16:00 AEST
Revision: 1.0.0
Abstract
The goal of this assignment is to implement and test a set of classes and interfaces1
to be used in
the second assignment.
Language requirements: Java version 11, JUnit 4.
Please carefully read the Appendix A Document. It outlines critical mistakes
which you must avoid in order to avoid losing marks. This is being heavily emphasised
here because these are critical mistakes which must be avoided.
If at any point you are even slightly unsure, please check as soon as possible with
course staff !
Preamble
All work on this assignment is to be your own individual work. As detailed in Lecture 1, code
supplied by course staff (from this semester) is acceptable, but there are no other exceptions. You
are expected to be familiar with “What not to do” from Lecture 1 and https://www.itee.uq.
edu.au/itee-student-misconduct-including-plagiarism. If you have questions about what
is acceptable, please ask course staff.
All times are given in Australian Eastern Standard Time. It is your responsibility to ensure that
you adhere to this timezone for all assignment related matters. Please bear this in mind, especially
if you are enrolled in the External offering and may be located in a different time zone.
Introduction
In this assignment, and continuing into the second assignment, you will build a simple simulation
of an air traffic control (ATC) system. The first assignment will focus on implementing the classes
that provide the core model for the system.
An ATC system manages the movement of aircraft around an airport, including assigning
aircraft to terminals and gates, and managing situations such as emergencies. An ATC system
also maintains various queues including a landing queue, and takeoff queue (more about this in
assignment 2).
Terminals each contain a number of Gates, and can be designed to only cater to specific types
of aircraft, such as Airplanes or Helicopters.
An aircraft can be either an Airplane or a Helicopter. An Aircraft can have two primary
purposes; they can either be a Passenger aircraft, or a Freight aircraft.
Each aircraft has various characteristics which are known to the ATC system including the
aircraft’s empty weight, fuel capacity, passenger capacity, and freight capacity. These characteristics
can determine how long it can take to complete various actions such as boarding passengers
1From now on, classes and interfaces will be shortened to simply “classes”
1
or freight, or refueling the aircraft. The total weight of an aircraft can change depending on the
occupancy level (passengers or freight) of the aircraft (for example, more passengers means the
aircraft will be heavier).
Each aircraft also has a list of tasks that it completes. Tasks represent the actions or states
that an aircraft can take including: being away from the airport (for assignment simplicity we
only care the aircraft is in an away state, we do not care what it might be doing in this time),
waiting to land, waiting to take off, loading (i.e. passengers or freight), and waiting idle at the
gate. Tasks can take different amounts of time depending on characteristics of the aircraft, and
the requirements of each recorded task (for example, loading takes longer when there are more
passengers or freight).
The list of tasks which an aircraft has must follow a strict set of requirements. The tasks can
only occur in a specific order (for example, it would not make logical sense to be waiting in the
air in a landing queue, and then takeoff – the aircraft must land first). Aircraft also complete a
task list in a circular manner. Once the aircraft has completed the last task in the list, it will then
commence the first task in the list again. This behaviour will go on forever (this simplification
of aircraft behavior is for assignment simplicity. A real aircraft would have much more complex
schedules, but this is way beyond the scope of this course).
Supplied Material
❼ This task sheet.
❼ Code specification document (Javadoc).2
❼ Gradescope, an online website where you will submit your assignment.3
❼ An empty assignment solution (i.e. skeleton code) is provided in your Subversion repository.
These files provide a minimal framework for you to work from, and build upon. These files
have been provided so that you can avoid (some of) the critical mistakes described in the
Appendix. Each of these files:
– is in the correct directory (do not change this!)
– has the correct package declaration at the top of the file (do not change this!)
– has the correct public class or public interface declaration. Note that you may still need
to make classes abstract, extend classes, implement interfaces etc. as detailed in the
specifications.
As the first step in the assignment (after reading through the specifications) you should checkout
the ass1 repository from Subversion. Once you have created a new project from the repository
you have checked out, you should start implementing the specifications.
Javadoc
Code specifications are an important tool for developing code in collaboration with other people.
Although assignments in this course are individual, they still aim to prepare you for writing
code to a strict specification by providing a specification document (in Java, this is called Javadoc).
You will need to implement the specification precisely as it is described in the specification document.
The Javadoc can be viewed in either of the two following ways:
1. Open https://csse2002.uqcloud.net/assignment/1/ in your web browser. Note that this
will only be the most recent version of the Javadoc.
2Detailed in the Javadoc section
3Detailed in the Submission section
2
2. Navigate to the relevant assignment folder under Assessment on Blackboard and you will be
able to download the Javadoc .zip file containing HTML documentation. Unzip the bundle
somewhere, and open doc/index.html with your web browser.
Tasks
1. Fully implement each of the classes and interfaces described in the Javadoc.
2. Write JUnit 4 tests for all the methods in the following classes:
❼ Gate (in a class called GateTest)
❼ TaskList (in a class called TaskListTest)
Marking
The 100 marks available for the assignment will be divided as follows:
Symbol Marks Marked Description
F T 45 Electronically Functionality according to the specification
CF 10 Electronically Conformance to the specification
SL 10 Electronically Code Style: Structure and Layout
CR 20 By course staff Code Style review: (Style and Design)
JU 15 Electronically Whether JUnit tests identify and distinguish between
correct and incorrect implementations
The overall assignment mark will be A1 = F T + CF + SL + CR + JU with the following
adjustments:
1. If F T is 0, then the manual code style review will not be marked. CR will be automatically
0.
2. If SL is 0, then the manual code style review will not be marked. CR will be automatically
0.
3. If SL + CR > F T, then SL + CR = F T.
❼ For example: F T = 22, CF = 8, SL = 7, CR = 18, J = 13
⇒ A1 = 22 + 8 + (7 + 18) + 13.
The reasoning here is to place emphasis on good quality functional code.
Well styled code that does not implement the required functionality is of no value
in a project, consequently marks will not be given to well styled code that is not
functional.
Functionality Marking
The number of functionality marks given will be
F T =
Unit Tests passed
Total number of Unit Tests · 45
3
Conformance
Conformance is marked starting with a mark of 10.
Every single occurrence of a conformance violation in your solution then results in a 1 mark deduction,
down to a minimum of 0. Note that multiple conformance violations of the same type
will each result in a 1 mark deduction.
Conformance violations include (but are not limited to):
❼ Placing files in incorrect directories.
❼ Incorrect package declarations at the top of files.
❼ Using modifiers on classes, methods and member variables that are different to those specified
in the Javadoc. Modifiers include private, protected, public, abstract, final, and
static. For example, declaring a method as public when it should be private.
❼ Adding extra public methods, constructors, member variables or classes that are not described
in the Javadoc.
❼ Incorrect parameters and exceptions declared as thrown for constructors.
❼ Incorrect parameters, return type and exceptions declared as thrown for methods.
❼ Incorrect types of public fields.
Code Style
Code Structure and Layout
The Code Structure and Layout category is marked starting with a mark of 10.
Every single occurrence of a style violation in your solution, as detected by CheckStyle using the
course-provided configuration4
, results in a 0.5 mark deduction, down to a minimum of 0. Note
that multiple style violations of the same type will each result in a 0.5 mark deduction.
Note: There is a plugin available for IntelliJ which will highlight style violations in your code.
Instructions for installing this plugin are available in the Java Programming Style Guide on Blackboard
(Learning Resources → Guides). If you correctly use the plugin and follow the style requirements,
it should be relatively straightforward to get high marks for this section.
Code Review
Your assignment will be style marked with respect to the course style guide, located under Learning
Resources → Guides. The marks are broadly divided as follows:
Metric Marks Allocated
Naming 6
Commenting 6
Readability 3
Code Review 5
Note that style marking does involve some aesthetic judgement (and the marker’s aesthetic judgement
is final).
Note that the plugin available for IntelliJ mentioned in the Code Structure and Layout section
cannot tell you whether your code violates style guidelines for this section. To do so, it would need
complex AI capabilities, which is not realistic. You will need to manually check your code against
4The latest version of the course CheckStyle configuration can be found at http://csse2002.uqcloud.net/
checkstyle.xml. See the Style Guide for instructions.
4
the style guide.
The Code Review is marked starting with a mark of 20. Penalities are then applied where applicable,
to a minimum of 0.
Metric How it is marked
Naming Misnamed variables (-4 marks max)
e.g.
→ Non-meaningful or one-letter names
• String temp; // bad naming
• char a; // bad naming
• int myVar, var, myVariable; // all bad naming
→ Variable names using Hungarian notation
• int roomInteger; // bad naming
• ListhGatei gateList; // bad naming
Commenting Javadoc comments lacking sufficient detail (-4 marks max)
e.g.
→ Insufficient detail or non-meaningful Javadoc comments on (any) classes
→ Insufficient detail or non-meaningful Javadoc comments on (any) methods
→ Insufficient detail or non-meaningful Javadoc comments on (any) constructors
→ Insufficient detail or non-meaningful Javadoc comments on (any) class variables
→ etc.
Lack of inline comments, or comments not meaningful (-2 marks max)
e.g.
→ There needs to be sufficient comments which explain your code so that
someone else can readily understand what is going. Someone should not need
to guess or make assumptions.
→ Lack of inline comments, or comments not meaningful in methods
→ Lack of inline comments, or comments not meaningful in constructors
→ Lack of inline comments, or comments not meaningful for variables
→ etc.
Readability Readability issues (-3 marks max)
e.g.
→ Class content is laid out in a way which is not straightforward to follow
→ Methods are laid out in Classes or Interfaces in a way which is not straightforward
to follow
→ Method content is laid out in a way which is not straightforward to follow
→ Variables are not placed in logical locations
→ etc.
Code Design Code duplication issues (-2 marks max)
e.g.
→ Using class member variables where local variables could be used
→ Duplicating sections of code instead of extracting into a private helper
method
→ Using magic numbers without explanatory comments
• object.someMethod(50); // what does 50 mean? What is the
unit/metric?
JUnit Test Marking
See Appendix B for more details.
The JUnit tests that you provide in GateTest and TaskListTest will be used to test both correct
5
and incorrect implementations of the Gate and TaskList classes. Marks will be awarded for test
sets which distinguish between correct and incorrect implementations5
. A test class which passes
every implementation (or fails every implementation) will likely get a low mark. Marks will be
rewarded for tests which pass or fail correctly.
There will be some limitations on your tests:
1. If your tests take more than 20 seconds to run, or
2. If your tests consume more memory than is reasonable or are otherwise malicious,
then your tests will be stopped and a mark of zero given. These limits are very generous (e.g. your
tests should not take anywhere near 20 seconds to run).
Electronic Marking
The electronic aspects of the marking will be carried out in a Linux environment. The environment
will not be running Windows, and neither IntelliJ nor Eclipse (or any other IDE) will be involved.
OpenJDK 11 will be used to compile and execute your code and tests.
It is critical that your code compiles.
If your submission does not compile, you will receive zero for Functionality (FT).
Submission
How/Where to Submit
Submission is via Gradescope (submission is not via SVN repository like in previous semesters).
Instructions for submitting to Gradescope will be made available on Blackboard (under Assessment
→ Assignment 1) towards the start of week 4. You will not be able to submit your assignment before
then.
You must ensure that you have submitted your code to Gradescope before the submission deadline.
Code that is submitted after the deadline will not be marked (1 nanosecond late is still late).
What to Submit
Your submission should have the following internal structure:
src/ folders (packages) and .java files for classes described in the Javadoc
test/ folders (packages) and .java files for the JUnit test classes
A complete submission would look like:
5And get them the right way around
6
src/towersim/aircraft/Aircraft.java
src/towersim/aircraft/AircraftCharacteristics.java
src/towersim/aircraft/AircraftType.java
src/towersim/aircraft/FreightAircraft.java
src/towersim/aircraft/PassengerAircraft.java
src/towersim/control/ControlTower.java
src/towersim/ground/AirplaneTerminal.java
src/towersim/ground/Gate.java
src/towersim/ground/HelicopterTerminal.java
src/towersim/ground/Terminal.java
src/towersim/tasks/Task.java
src/towersim/tasks/TaskList.java
src/towersim/tasks/TaskType.java
src/towersim/util/EmergencyState.java
src/towersim/util/NoSpaceException.java
src/towersim/util/NoSuitableGateException.java
src/towersim/util/OccupancyLevel.java
src/towersim/util/Tickable.java
test/towersim/ground/GateTest.java (must be test directory, not src!)
test/towersim/tasks/TaskListTest.java (must be test directory, not src!)
Ensure that your classes and interfaces correctly declare the package they are within. For example,
Gate.java should declare package towersim.ground.
Do not submit any other files (e.g. no .class files).
Note that GateTest and TaskListTest will be compiled individually against a sample solution
without the rest of your test files.
Provided set of unit tests
A small number of the unit tests (about 10-20%) used for assessing Functionality (FT) (not conformance,
style, or JUnit tests) will be provided in Gradescope prior to the submision deadline,
which you will be able to test your submission against.
The purpose of this is to provide you with an opportunity to receive feedback on whether the
basic functionality of your classes is correct or not. Passing all the provided unit tests does not
guarantee that you will pass all of the full set of unit tests used for functionality marking.
Instructions about the provided set of unit tests will be made available on Blackboard (under
Assessment → Assignment 1) towards the start of week 4. Instructions will not be provided before
then. This will still give you over two weeks to submit and check your work before the assignment
is due.
Late Submission
Assignments submitted after the submission deadline of 16:00 on April 1 2021 (by any amount
of time), will receive a mark of zero unless an extension is granted as outlined in the Electronic
Course Profile — see the Electronic Course Profile for details.
7
Do not wait until the last minute to submit the final version of your assignment. A submission
that starts before 16:00 but finishes after 16:00 will not be marked. Exceptions cannot be made
for individual students, as this would not be fair to all other students.
Assignment Extensions
For assignment one, extensions longer than 7 calendar days will not be possible due to the dependency
of assignment two on the work completed in assignment one. This matches what is outlined
in the respective Electronic Course Profile.
All requests for extensions must be made via my.UQ as outlined in section 5.3 of the respective
Electronic Course Profile. Please not directly email the course coordinator seeking an extension
(you will be redirected to my.UQ).
Remark Requests
To submit a remark of this assignment please follow the information presented here:
https://my.uq.edu.au/information-and-services/manage-my-program/exams-and-assessment/
querying-result.
Revisions
If it becomes necessary to correct or clarify the task sheet or Javadoc, a new version will be issued
and an announcement will be made on the Blackboard course site.
Appendix A: Critical Mistakes which can cause loss in marks.
Things you need to avoid!
This is being heavily emphasised here because these are critical mistakes which must be avoided.
The way assignments are marked has been heavily revised this semester to address many of these
issues where possible, but there are still issues which can only be avoided by making sure the
specification is followed correctly.
Code may run fine locally on your own computer in IntelliJ, but it is required that it also builds
and runs correctly when it is marked with the electronic marking tool in Gradescope. Your solution
needs to conform to the specification for this to occur.
Correctly reading specification requirements is a key objective for the course.
❼ Files must be in the exact correct directories specified by the Javadoc. If files are in incorrect
directories (even slightly wrong), you may lose marks for functionality in these files because
the implementation does not conform to the specification.
❼ Files must have the exact correct package declaration at the top of the file. If files have
incorrect package declarations (even slightly wrong), you may lose marks for functionality in
these files because the implementation does not conform to the specification.
❼ You must implement the public and protected members exactly as described in the supplied
documentation (no extra public/protected members or classes). Creating public or protected
data members in a class when it is not required will result in loss of marks, because the
implementation does not conform to the specification.
– Private members may be added at your own discretion.
8
❼ Never import the org.junit.jupiter.api package. This is from JUnit 5. This will automatically
cause the marks for the JUnit section to be 0 because JUnit 5 functionality is not
supported.
❼ Do NOT use any version of Java newer than 11 when writing your solution! If you accidentally
use Java features which are only present in a version newer than 11, then your submission
may fail to compile when marked. This will automatically cause the marks for associated
files with this functionality to be 0.
Appendix B: How your JUnit unit tests are marked.
The JUnit tests you write for a class (e.g. GateTest.java) are evaluated by checking whether they
can distinguish between a correct implementation of the respective class (e.g. Gate.java)
(made by the teaching staff), and incorrect implementations of the respective class (deliberately
made by the teaching staff).
First, we run your unit tests (e.g. GateTest.java, TaskListTest.java) against the correct implementation
of the respective classes (e.g. Gate.java, TaskList.java).
We look at how many unit tests you have, and how many have passed. Let us imagine that you
have 5 unit tests (it should be more than this, 5 is just an example) for GateTest.java and
4 unit tests (it should be more than this, 4 is just an example) for TaskListTest.java, and
they all pass (i.e. none result in Assert.fail() in JUnit4).
We will then run your unit tests in both classes (GateTest.java, TaskListTest.java) against an
incorrect solution implementation of the respective class (e.g. Gate.java). For example, the
getGateNumber() method in the Gate.java file is incorrect.
We then look at how many of your unit tests pass.
TaskListTest.java should still pass 5 unit tests. However, we would expect that GateTest.java
would pass less than 4 unit tests.
If this is the case, we know that your unit tests can identify that there is a problem with this
specific implementation of Gate.java.
This would get you one identified faulty implementation towards your JUnit mark.
The total marks you receive for JUnit are the correct number of identified faulty implementations,
out of the total number of faulty implementations which the teaching staff create.
If your unit tests identified 60% of the faulty implementations, you would receive a mark of:
60% of 15 → 9/15.