Assignment 5

Description

Use NetBeans to create a new JavaFX Application project.

Project Specs

Project Name: A5_LoginName (where LoginName is your own sheridan login name).

Package Name: loginname (your own login name, in lower-case letters). Do not use prog24178.loginname or anything else, just loginname.

Main Application Class Name: Assign5

This is a JavaFX application. You will also be adding a .jar file of classes that have already been written for you. You must add this to your project in order to complete this assignment.

When you create your project, make sure the main Application class is called Assign5.

To complete this project, you will need to download the Assignment 5 Distribution File. This file contains the following items:

• cookies.jar file: (see what I did there?) this is a library that contains the Cookies enumeration and CookieInventoryItem class. Add this .jar file to your project.
• /javadoc folder: this contains the javadocs for the classes in the cookies.jar file. Read this documentation so you can get an idea as to how to use the classes given to you. You don't have to do anything with the files in this folder, just load the index.html file into your browser and read the documentation.
• cookies.txt: a sample cookie data file you can use to test your program, if you want. If you do decide to use this file, be sure to place it in your project's root folder.

Failure to follow the above instructions could result in penalties. I'll be testing your assignment using JUnit and it relies on having your package and class names following the specifications above.

This application is used to keep track of cookie inventory: Crepe and her daughter Aubrey have a small home bakery which sells a variety of cookies in a small kiosk at the local farmer's market. They don't bake all the flavours every day because they only have the one oven in their kitchen, so they decide the night before which flavours they will bake the next day.

Early in the morning as the cookies are made, Crepe goes into the Cookie Inventory program on her tablet and adds the number and type of cookies baked. These are saved to a data file called "cookies.txt", which has the following structure:

The file uses the new-line as the record delimiter and the pipe symbol (|) as the field delimiter.

After all the cookies are baked, Crepe and Aubrey pack them up and take them to the farmer's market.

At the farmer's market, people purchase cookies. As each purchase is made, Crepe or Aubrey will enter the number of each flavour of cookie purchased, and this updates the initial inventory they started with. At the end of the day, the file contains the same records, but the quantities have been adjusted to reflect the numbers of each flavour of cookie sold.

Sometimes, if the market is exceptionally busy, Aubrey will run home and bake a quick batch of cookies that are selling out. When this happens, they need to update the quantity of that cookie in the inventory program.

This is the UI for the program you will be creating:

There are three additional classes in this assignment besides the Assign5 Application class (specific details further down):

• The Cookies Enum
  • This enumeration has already been created for you and is in the cookies.jar file you will be adding to this application.
• The CookieInventoryItem Class
  • This class has already been created for you and is in the cookies.jar file you will be adding to this application.
  • This class models a single record in the cookies.txt file.
• The CookieInventoryFile class
  • Models the file of cookie records as an ArrayList.
  • This class is a similar version of the list classes you wrote in past assignments however, this class extends ArrayList.

All classes must be part of the same package.

The class in blue are already written for you. You only need to code the classes in green.

The Cookies Enum

The Cookie enumeration is already written for you and is included in the cookies.jar file.

This enumeration contains constants for each cookie flavour. Every flavour is assigned a name (displayed on the UI), a unqiue ID number, and a price.

See the Javadocs files you were given to see more information or to see what constants are in the Cookies enum.

The CookieInventoryItem Class

The CookieInventoryItem class is already written for you and is included in the cookies.jar file

This class models a single record in the cookies.txt file. A CookieInventoryItem has a data member for the cookie flavour ID and the quantity of cookies currently available.

See the Javadocs files you were given to see more information on the CookieInventoryItem class.

CookieInventoryFile Class

The CookieInventoryFile class models the collection of records (modeled by CookieInventoryItem) in the cookies.txt file. Unlike previous list classes you've written, this one extends ArrayList instead of including an ArrayList data member. The benefit of this is that you don't need a lot of the methods you needed in other list classes, plus this one is easier to iterate through.

Extending ArrayList:
Just extend ArrayList as you would extend any other class. Make sure you include the concrete type. For example:

public class CookieInventoryFile extends ArrayList<CookieInventoryItem> { ... }

The specs for the CookieInventoryFile class are shown in the diagram below:

• The default constructor doesn't need to do anything.
• The single-parameter constructor only calls the loadFromFile() method (see below).
• The find() method accepts a cookie flavour ID number and searches the CookieInventoryFile elements for a CookieInventoryItem with the same ID. If an item is found, that CookieInventoryItem is returned. If there is no item with that flavour ID, a null object (null) is returned.
• The loadFromFile() method accepts a File object. The method must read all the records from the file and construct a CookieInventoryItem object for each record. Each CookieInventoryItem object is added to the ArrayList inside the CookieInventoryFile.
• The writeToFile() method accepts a File object. The method iterates through all of the CookieInventoryItem objects in the ArrayList and deconstructs them into a delimited string that can be written to the file. Use the toFileString() method in the CookieInventoryItem class!

The Assign5 Application Class

This is the main Assign5 class for your JavaFX Application.

This program allows Crepe and Aubrey to update their cookie inventory for the day.

The UI Controls, Layout, and Styling

Your program has the following UI elements (specific details about functionality are outlined later):

• Choose Cookie Flavour: An HBox contains a label and a combo box that allows the user to choose a cookie flavour. The combox box contents come from the Cookies enumeration.
• The Amount Sold VBox: The user enters the number of cookies of a certain flavour purchased in the text field and then clicks the SELL button. The sell button subtracts the input value from the selected cookie's quantity.
• The Amount Baked VBox: The user enters the number of cookies of a certain flavour baked in the text field and then clicks the ADD button. This finds the matching CookieInventoryItem in the CookieInventoryFile list and adds the input value to the selected cookie's quantity.
• Exit button: The exit button has to do a few things:
  • Confirm exit with the user using an alert dialog box.

    

  • If the user confirms that they want to exit:
    • Have the CookieInventoryFile object write all of its CookieInventoryItem objects to the cookies.txt file. Overwrite the file, don't append to it.
    • Exit the program.

The UI elements must be laid out and displayed similar to what is shown in the screen shots (you can change the border style/colour if you wish). Your UI must contain a meaningful title in the title bar.

Any formatting of the UI elements must be done via external CSS file.

Be sure that you use the necessary methods to apply styling to the various components on your UI in the most efficient way possible.

Startup:
On startup, the following tasks need to be performed:

• The combo box's ObservableList needs to be loaded with the Cookie enums. This is really easy: the enumeration is already set up so that all you have to do is use the collection of enum values to create the ObservableList using FXCollections.
• Connect an input stream to the cookies.dat file and read in the records:
  • If the cookies.dat file exists, use it to construct a new CookieInventoryFile object.
  • If the cookies.dat file doesn't exist, construct an empty (default) CookieInventoryFile object.
  • Checked exceptions should be handed by showing a user-friendly alert dialog with a descriptive and appropriate error message.

Handling Errors and Exceptions

You must deal with the following situations in a user-friendly and efficient manner without redundant code. See the sample screen shots below for error messages:

• Empty text fields: if the user clicks Sell or Add when the text field is empty, an alert message is shown.

  

  

• Purchasing items not in inventory: if the user attempts to purchase cookies that aren't in inventory, an alert message is shown.

  

• Purchasing more items than the quantity on hand: if the user attempts to purchase more of a certain flavour of cookie than is currently available in inventory, an alert message is shown.

  

• Entering 0 or negative values: if the user enters a 0 or negative quantity in either text field, an error is shown.

  

• Entering non-numeric values: if the user enters any non-numeric value in either text field, an error message is shown.

  

In all cases above, focus returns to the field that caused the problem. If the user entered text in the field, that text should be selected.

Error handling code must be efficient. Use re-usable methods to avoid redundant code.

Bonus Marks: You can do any of the following for bonus marks (or all of them!). Note that bonus marks are only assigned when the code is efficient, well-written, follows standards, and is correct. Part-marks are not given for bonus: it's all or nothing.

• End-Of-Day Report: Add a button that prints an end-of-day report. The report should print the inventory at the end of the day. Show the report in a separate scene or window. Don't forget to include controls that allow the user to return to the main screen. (+4 marks)
• Make the End-Of-Day report also display a summary of transactions. For example, the total amount sold and total amount baked for each cookie type in today's inventory (additional +2)

Submission

Follow these instructions carefully or you risk penalties up to 100% of your grade!

Your submission must follow all the submission requirements outlined in the Submission Standards.

It is expected that all code will conform to the industry standards outlined in Java Standards for this Course.

You are to submit 2 files, separately:

1. The NetBeans project that contains your assignment, in a ZIP/RAR file.
2. A text or word processed document containing all of your source code for both the Inventory class and the Main class.

1. ZIP/RAR of NetBeans Project:

• Your project file should ONLY contain the files needed for this current assignment. It should NOT contain any other projects or files.
• I will be changing the reference to the JAR file to my own copy of the JAR file, so you don't have to worry about the JAR's location on your system.
• If you use any other JAR file of your own (e.g. your Validator JAR), make sure you add it to the zip/rar file separately so I can properly reference it).
• Your project must be a valid NetBeans project. No other project types will be accepted.
• Your submission file must be archived into a valid ZIP or RAR file.
• The name of this file should be loginName_a5.zip or loginName_a5.rar where "loginName" is your Sheridan user name.

See Archiving a NetBeans Project if you're not sure how to do zip/rar a NetBeans project.

2. Document of Source:

You must also copy and paste all of your source code from your CookieInventoryFile class and your Assign5 Application class into a plain text file (e.g. .TXT) or Word document (e.g. .DOC/.DOCX).

You don't have to format this code - it's used by TurnItIn (the originality checker in SLATE, which is a piece of software that checks your submission for plagiarism against other submissions in the college, in other colleges, from the web, and various other sources).

Submit this document in addition to your source code zip/rar file. DO NOT add it inside your zip/rar file - it must be a separate file. This is used for TurnItIn (it won't accept java programs and won't examine the contents of zip/rar files).

Upload Both Files

Submit your assignment to the Assignment 5 drop box in SLATE. Upload the ZIP/RAR file and upload the TXT/DOC file separately to the same drop box.

Failure to follow any of the instructions above will result in penalties or a grade of 0.

Evaluation

It is expected that all code will conform to the industry standards outlined in Java Standards for this Course.

Your submission will be evaluated based on the following criteria: