Refactor: Rename class

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/database/DatabaseHandler.java → CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/database/EmbeddedDatabaseHandler.java

@@ -30,13 +30,13 @@ import java.util.Map;
 /**
  * Utility class for setup and access of the embedded database.
  */
-public class DatabaseHandler {
+public class EmbeddedDatabaseHandler {
 
-    private static final Logger logger = LogManager.getLogger(DatabaseHandler.class);
+    private static final Logger logger = LogManager.getLogger(EmbeddedDatabaseHandler.class);
     private static final String DB_NAME = "/database/cd_db";
     private DataSourceWrapper dataSource;
 
-    public DatabaseHandler(){
+    public EmbeddedDatabaseHandler(){
         try {
             String jdbcurl = H2GISDBFactory.createDataSource(DB_NAME,
                     true, ";AUTO_SERVER=TRUE").getConnection().getMetaData().getURL();
@@ -88,7 +88,7 @@ public class DatabaseHandler {
     }
 
     /**
-     * Saves a CityObject to the embedded database, updating an existing entry if it exists.
+     * Saves a CityObject to the embedded database, updating the entry if it already exists.
      * @param co the CityObject
      */
     public void marshallCityObject(CityObject co) {
@@ -119,6 +119,11 @@ public class DatabaseHandler {
         }
     }
 
+    /**
+     * Tries to save all CityObjects in a Map to the embedded database as a batched statement, updating already existing entries.
+     * @param map a Map containing the CityObjects
+     * @return true if the batched statement was successfully created and commited, false otherwise
+     */
     public boolean tryMarshallCityObjectMap(Map<GmlId, CityObject> map) {
         // Id String for error logging
         String id = "";
@@ -199,6 +204,10 @@ public class DatabaseHandler {
         return null;
     }
 
+    /**
+     * Retrieves a List of GmlIds of CityObjects that contain any {@link de.hft.stuttgart.citydoctor2.check.CheckError CheckError}.
+     * @return a List of GmlIds of CityObjects containing any CheckError
+     */
     public List<GmlId> getIdsOfAllCityObjectsWithErrors(){
         List<GmlId> ids = new ArrayList<>();
         try (Connection con = dataSource.getConnection()){

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/database/FeatureCache.java

@@ -33,12 +33,12 @@ public class FeatureCache implements CityObjectCache{
     private static final Logger logger = LogManager.getLogger(FeatureCache.class);
 
     private final LoadingCache<GmlId, CityObject> cache;
-    private final DatabaseHandler handler;
+    private final EmbeddedDatabaseHandler handler;
     private final AtomicInteger putsCounter = new AtomicInteger(0);
     private boolean parsingFinished = false;
 
     FeatureCache() {
-        handler = new DatabaseHandler();
+        handler = new EmbeddedDatabaseHandler();
         cache = Caffeine.newBuilder().maximumSize(3000).removalListener((GmlId key, CityObject value, RemovalCause cause) -> {
                     if (value != null && cause.wasEvicted()) {
                         handler.marshallCityObject(value);

CityDoctorParent/CityDoctorModel/src/test/java/de/hft/stuttgart/citydoctor2/database/DataBaseHandlerTest.java

@@ -32,12 +32,12 @@ import static org.junit.Assert.fail;
 
 public class DataBaseHandlerTest {
 
-    private DatabaseHandler handler;
+    private EmbeddedDatabaseHandler handler;
 
     @Before
     public void resetDatabase() {
         try {
-            handler = new DatabaseHandler();
+            handler = new EmbeddedDatabaseHandler();
             handler.setupFeaturesTable();
         } catch (Exception e) {
             fail(e.getMessage());

CityDoctorParent/CityDoctorModel/src/test/java/de/hft/stuttgart/citydoctor2/database/FeatureCacheTest.java

@@ -28,7 +28,7 @@ public class FeatureCacheTest {
     @Test
     public void testGet(){
         FeatureCache cache = new FeatureCache();
-        DatabaseHandler handler = new DatabaseHandler();
+        EmbeddedDatabaseHandler handler = new EmbeddedDatabaseHandler();
         Building b = new Building();
         b.setGmlId(new GmlId("building"));
         b.addGeometry(GeometryTestUtils.createDummyGeometry(GeometryType.SOLID, Lod.LOD0));

CityDoctorParent/Extensions/CityDoctorGUI/src/main/java/de/hft/stuttgart/citydoctor2/gui/MainWindow.java

@@ -453,6 +453,7 @@ public class MainWindow extends Application {
         });
     }
 
+    @SuppressWarnings("java:S2629")
     private void checkForStartupLoading() {
         if (loadFileAtStartup) {
             logger.info(Localization.getText("MainWindow.loadGivenFile"));