02115 Java Programming
The solution to this assignment should be made in the form of a
report that contains the sections mentioned below.
The report should be kept short.
First be aware of the entrance at the course home page entitled
Supplementary notes material
opening up for a little collection
of specific notes to which we refer below by using their titles put in
In section 2 (Advice on style) of
Documentation of software systems you find
many useful advises on the style of a report.
Sections of the report
- A front page that contains:
- 02115 (the course number)
- Java Programming (the course name)
- DTU Informatics (the department name)
- Technical University of Denmark
- A simple Cinema Booking System
- date (day, month and year)
- study number, full name and signature of the
single student having done the work.
- A table of contents including headings of sections and subsections.
Each class file is considered a section.
- A section Summary with highlights, especially on what has
and what has not been achieved. Actually, a summary could be
considered as an evaluation by the author of the work
done and presented in the report. Remember to be honest.
(at most one page)
- A section Analysis and Design on how you can make a
program solving the given problem. Describe and discuss
e.g. how data can be represented and how the desired results
can be achieved. As part of a conclusion of the analysis, it
will probably make sense to give a very short overview of the
class design, with emphasis on data fields and public
methods of each class. This part must contain class diagrams.
(at most five text pages plus class diagram pages)
- If needed a short section
From design to implementation bridging
from design to source code states some superior matters
on the implementation. One example on that is refactoring.
(only one or two pages)
The program listings as such should be found in an appendix
- A section Testing stating your planning and strategy
of testing, documentation of the actual tests done and your
evaluation of the test results. The detailed test
results should be kept in an appendix. It's important to
argue about the tests necessary for the functional and
the structural tests. JUnit tests could be a good idea.
Document the tests using screen dumps.
(three to five pages)
- A section User's guide to inform a user of the program
how to apply and run your program. Supply with a commented sample
input/output dialogue from a program run using the line
based terminal user interface. It's important that the
dialogue illustrates the full functionality of the program.
Select the input with care thus limiting the size of the
printout to the minimum needed.
- An appendix containing a printout of all program listings of
your solution. Also listings of test programs.
Follow the advices given in section 1 (Programs considered as
Documentation of software systems and in the course
textbook when editing the program text.
- An appendix that contains the design of a functional test and a
structural test (as illustrated in Systematic Software
Test), and the results of running your tests.
Besides the advices given in the textbook be inspired by
reading section 3 (Documentation of quality) of
Documentation of software.
- An appendix with a listing of the file catalogues on the writable
CD attached to the report and holding your solution:
- A catalogue source with your separate Java
files and the same files packed into one .jar file
- A catalogue doc with the complete javadoc
documentation of all classes
Jens Thyge Kristensen,
Newest edition: 6. October (a link to 'Supplementaray notes
material' has been added)
- 5. October