shelbourn / javafx-inventory-management-project Goto Github PK

Change the naming of local variables found in scene creation blocks.

eg...

System.out.println("User cancelled operation. Exiting to Main Screen.");
            Parent root = FXMLLoader.load(getClass().getResource("MainScreen.fxml"));
            Scene scene = new Scene(root);
            Stage mainScreenWindow = (Stage) ((Node) event.getSource()).getScene().getWindow();
            mainScreenWindow.setTitle("ABC Company: Inventory Management System");
            mainScreenWindow.setScene(scene);
            mainScreenWindow.show();

Make the variables such as root and scene something more descriptive.

These scene creation blocks are found throughout the various controllers.

Restructure code in throughout app so that the UI flow of the app follows the code organization. Also, in files that contain both PART and PRODUCT methods/properties/etc, group the PART stuff with the PART stuff and PRODUCT stuff with the PRODUCT stuff.

Add SYSOUT messages for all IO operations.

For instance...

if (partValueException.length() > 0) {
                    Alert alert = new Alert(Alert.AlertType.WARNING);
                    alert.setTitle("ERROR: INVALID VALUES PRESENT");
                    alert.setHeaderText("This part has not been modified");
                    alert.setContentText(partValueException);
                    alert.showAndWait();
                    partValueException = "";

Add doc-style comments to app for reviewer's benefit.

Add exception handling to the Part and Product classes.

Must include:

• Name
• Price
• Inventory Level
• Min inventory level
• Max inventory level
• Min vs Max inventory level
• Price vs Cost
• No nulls

• Remove Unnecessary File Imports
• Remove Unnecessary JavaFX IDs
• Comment Code for Reviewers
• Add SYSOUT Comments for all IO Ops
• Restructure Code (It's a MESS right now) 😠
• Change naming conventions for Scene creation
• Move Exception Handling for Controllers into a separate class