From f1ec6a222ac82275fb2aaaaa7e93764fa9500b38 Mon Sep 17 00:00:00 2001
From: Dominic Rogetzer <e1627756@student.tuwien.ac.at>
Date: Tue, 12 Jun 2018 19:19:46 +0200
Subject: Add TODO comments as feedback which occurred during JourFixe [#28535]

---
 .../sepm/assignment/groupphase/application/MainApplication.java     | 2 ++
 .../einsatzverwaltung/controller/CreateCarController.java           | 3 ++-
 .../einsatzverwaltung/controller/CreateNewEmployeeController.java   | 6 ++++--
 .../groupphase/einsatzverwaltung/dao/EmployeeDatabaseDAO.java       | 3 +++
 .../groupphase/einsatzverwaltung/service/EmployeeServiceImpl.java   | 1 +
 .../groupphase/einsatzverwaltung/service/VehicleServiceImpl.java    | 1 +
 6 files changed, 13 insertions(+), 3 deletions(-)

(limited to 'src/main/java/at/ac')

diff --git a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/application/MainApplication.java b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/application/MainApplication.java
index d8365a7..d1569f6 100644
--- a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/application/MainApplication.java
+++ b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/application/MainApplication.java
@@ -27,6 +27,8 @@ public class MainApplication extends Application {
         primaryStage.centerOnScreen();
         primaryStage.setOnCloseRequest(event -> Platform.exit());
 
+        // TODO: close connection on program exit (feedback)
+
         configApplicationContext = new AnnotationConfigApplicationContext(MainApplication.class);
         final var fxmlLoader = configApplicationContext.getBean(SpringFXMLLoader.class);
         primaryStage.setScene(
diff --git a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/controller/CreateCarController.java b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/controller/CreateCarController.java
index 7e964cb..bc6b0bc 100644
--- a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/controller/CreateCarController.java
+++ b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/controller/CreateCarController.java
@@ -128,7 +128,8 @@ public class CreateCarController {
                 vehicleService.update(vehicle);
                 setToStart();
             } catch (InvalidVehicleException e) {
-                LOG.error("Invalid Vehicle: {}", e);
+                // TODO: Validation-Errors should be logged with log level debug only (like here)
+                LOG.debug("Invalid Vehicle: {}", e);
                 createComplete(AlertType.ERROR, "Ungültige Eingabe", e.getMessage());
                 setToStart();
                 return;
diff --git a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/controller/CreateNewEmployeeController.java b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/controller/CreateNewEmployeeController.java
index 15282cc..ecca44b 100644
--- a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/controller/CreateNewEmployeeController.java
+++ b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/controller/CreateNewEmployeeController.java
@@ -104,7 +104,8 @@ public class CreateNewEmployeeController {
                 employeeService.add(employee);
             }
         } catch (InvalidEmployeeException e) {
-            LOG.error("Invalid Employee: {}", e);
+            // TODO: on validation errors, only log at debug level (feedback)
+            LOG.debug("Invalid Employee: {}", e);
 
             showModalDialogWithOkButton(
                     AlertType.ERROR,
@@ -112,7 +113,8 @@ public class CreateNewEmployeeController {
                     "Mindestens eines der Eingabefelder haben einen ungültigen Wert!");
             return;
         } catch (ServiceException e) {
-            LOG.error("Employee could not be saved: {}", e);
+            // TODO: when errors occur, exceptions should be logged. Do not use "{}" (feedback)
+            LOG.error("Employee could not be saved: ", e);
 
             showModalDialogWithOkButton(
                     AlertType.ERROR,
diff --git a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/dao/EmployeeDatabaseDAO.java b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/dao/EmployeeDatabaseDAO.java
index b9f2079..8c8d8b2 100644
--- a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/dao/EmployeeDatabaseDAO.java
+++ b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/dao/EmployeeDatabaseDAO.java
@@ -19,6 +19,9 @@ import org.springframework.stereotype.Repository;
 @Repository
 public class EmployeeDatabaseDAO implements EmployeeDAO {
 
+    // TODO [optional] either implement own interface or use spring disposable
+    // bean to close prepared statements (feedback)
+
     private static final String INSERT_EMPLOYEE_VERSION =
             "INSERT INTO EmployeeVersion(name, birthday, educationLevel, isDriver, isPilot) "
                     + "VALUES(?, ?, ?, ?, ?)";
diff --git a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/service/EmployeeServiceImpl.java b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/service/EmployeeServiceImpl.java
index 700a5de..81261ee 100644
--- a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/service/EmployeeServiceImpl.java
+++ b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/service/EmployeeServiceImpl.java
@@ -30,6 +30,7 @@ public class EmployeeServiceImpl implements EmployeeService {
         try {
             return employeePersistence.add(employee);
         } catch (PersistenceException e) {
+            // TODO: Do not practice "log and rethrow"! (feedback)
             LOG.error("PersistenceException while adding Employee. Message: {}", e.getMessage());
             throw new ServiceException(e);
         }
diff --git a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/service/VehicleServiceImpl.java b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/service/VehicleServiceImpl.java
index 026bca6..527825e 100644
--- a/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/service/VehicleServiceImpl.java
+++ b/src/main/java/at/ac/tuwien/sepm/assignment/groupphase/einsatzverwaltung/service/VehicleServiceImpl.java
@@ -93,6 +93,7 @@ public class VehicleServiceImpl implements VehicleService {
                 break;
             case NAH:
                 if (vehicle.constructionType() == ConstructionType.MITTELHOCHDACH) {
+                    // TODO: eventually change to LOG.debug (feedback)
                     LOG.info("Invalid Vehicle: NAH cannot have a medium roof");
                     throw new InvalidVehicleException("NEF darf kein Mittelhochdach haben");
                 } else if (vehicle.constructionType() == ConstructionType.HOCHDACH) {
-- 
cgit v1.2.3-70-g09d2