COSC2452-Assignment 1 Solved

create an interactive story, using GTerm (all inputs and outputs must be via GTerm). 

You must meet Functional Requirements (3.1), Code+Justification Requirements (3.2) and Documentation Requirements (3.3) to obtain the full mark for this assignment.

3.2) Code+Justification Requirements 

To receive marks for Code+Justification requirements, you must use the following code concepts as demonstrated during weekly live lectures and add code justification comments when meeting the 3.1 Functional Requirements. All requirements must be met exclusively using concepts and approaches shown in the weekly live lectures. Code without justification in the given format would attract no more than 50% of the mark allocated for that component. Comments without code will not attract any marks.

An important note on Java code validity: A program with even one red dot (compilation error) cannot be tested and therefore will attract 0 marks for this section. If the code produces run-time errors a 50% penalty will be applied to this section.
Code concept
 
CJ1) Java class
•                 Has only 1 class in 1 .java file and it is appropriately named to suit the application (must not use names such as Assignment1.java); Follows conventions shown in tutorial solution and lectures, other standard class materials and common ones in the Java API.

•                 All code must be within the main method.

•                 Formatting is consistent. Justification comments start on the line before the documented block/statement (e.g. not in-line comments).

•                 Only relevant, reachable code+comments included.

•                 Does not use return, break, continue, System.exit or similar branching (spaghetti code) anywhere in the code.
CJ2) Variables and inputs
•                 Must be able to store at least one relevant String value.

•                 Must be able to store at least one relevant numerical value.

•                 The user must be allowed to enter these values at run-time and the inputs must come via a suitable GTerm method. These values must be embedded in the story (refer CJ3).

•                 Demonstrates understanding of primitive data types vs. class types where relevant.
CJ3: User interface design using GTerm version ‘2020.08.25’ or newer.
•                 Story must be shown within the GTerm window (e.g. not via “show...Dialog” windows)

•                 Use GTerm exclusively for inputs

•                 Use GTerm exclusively for outputs

•                 Use GTerm methods setXY, setFontSize, setFontColor, setBackgroundColor, clear

•                 Uses GTerm method addImageIcon to enhance the presentation of the program by loading existing .gif, .png or .jpg images from the default/project folder (do not include folder names) without prompting the user to choose the file.
CJ4) If-statements
• Must exclusively use if-statements for non-repeating conditional execution (e.g. no switch).

• There must be at least one else-if statement.

Continued on next page...
 
• There must be an example of nested if-statements.

• There must be a conditional check performed on the text input.

• There must be a conditional check performed on the numerical input.

• Conditions do not include tautologies. Pathways are not redundant. Every code block in every conditional structure is reachable. 

• The story must branch and have pathways that vary depending on user entered values.

• Each branch/pathway must also include either inputs and/or outputs using GTerm (refer to CJ2 and CJ3)
Justification Requirements

Note: You will not receive all marks allocated for CJ requirements above unless each occurrence is justified as required below. 

Declarations, code blocks and conditions must be justified by following the rationales given in the ‘weekly live lectures’. Decision-making process and knowledge of suitable alternatives must be evident; Must not simply translate the code to English.
Type of code
Compare and justify your choice over other possible alternative...
Declarations

(also applies to method definitions)
Identifier names Data types
Contents of code blocks
Formulations (i.e. is there a simpler way to meet requirements without creating this code block?)

Inclusions (i.e. what you have added and why? Can these be done before/after this code block?)

Sequences (i.e. why are the statements in this order?)

Exclusions (i.e. what you haven’t added and why)
Conditions
Formulations of conditions (e.g. “is glass half empty” vs. “is glass half full”)
In places where this specification may not tell you how exactly you should implement a certain feature, the programmer (you) need to use your judgment to choose and apply the most appropriate concepts from class materials. Follow answers given by your “client” or “supervisor” (your coordinating instructor) under Canvas→Discussions→’Assignment 1’ when in doubt.
 
 
 
3.3) Documentation (User Guide) Requirements :
D1. Create an illustrated PDF user guide (one file). Shows screenshots of sample inputs. Shows screenshots of corresponding sample outputs. Has brief instructions on what the user can and cannot do (e.g. what they can and can’t input). Does not show code and does not have any references to code; the guide is intended for a user who is not a programmer