Code Cleaning

Author: jo-bao

src/main/java/edu/ie3/datamodel/Main.java

@@ -1,3 +1,8 @@
+/*
+ * © 2024. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
 package edu.ie3.datamodel;
 
 import edu.ie3.datamodel.exceptions.EntityProcessorException;
@@ -6,16 +11,13 @@
 import edu.ie3.datamodel.models.input.system.type.StorageTypeInput;
 
 public class Main {
-    public static void main(String[] args) {
-        try {
-            System.out.println(SqlUtils.queryCreateTableUniqueEntity(
-                    StorageTypeInput.class,
-                    "public"
-            ));
-        } catch (EntityProcessorException e) {
-            throw new RuntimeException(e);
-        } catch (ProcessorProviderException e) {
-            throw new RuntimeException(e);
-        }
+  public static void main(String[] args) {
+    try {
+      System.out.println(SqlUtils.queryCreateTableUniqueEntity(StorageTypeInput.class, "public"));
+    } catch (EntityProcessorException e) {
+      throw new RuntimeException(e);
+    } catch (ProcessorProviderException e) {
+      throw new RuntimeException(e);
     }
+  }
 }

src/main/java/edu/ie3/datamodel/io/DbGridMetadata.java

@@ -5,7 +5,7 @@
 */
 package edu.ie3.datamodel.io;
 
-import static edu.ie3.datamodel.io.IoUtil.quote;
+import static edu.ie3.datamodel.io.SqlUtils.quote;
 
 import java.util.UUID;
 import java.util.stream.Stream;
@@ -21,6 +21,7 @@ public String toString() {
     return GRID_NAME + "=" + gridName + ", " + GRID_UUID + "=" + uuid.toString();
   }
 
+  /** @return Stream with grid uuid */
   public Stream<String> getStreamForQuery() {
     return Stream.of(quote(uuid.toString(), "'"));
   }

src/main/java/edu/ie3/datamodel/io/IoUtil.java

@@ -7,8 +7,6 @@
 
 import java.io.File;
 import java.nio.file.Path;
-import java.time.ZonedDateTime;
-import java.time.format.DateTimeFormatter;
 import java.util.Optional;
 
 public class IoUtil {
@@ -51,16 +49,4 @@ public static Path harmonizeFileSeparator(Path path) {
   public static Optional<Path> pathOption(String in) {
     return Optional.of(Path.of(in));
   }
-
-  public String timeFormatter(ZonedDateTime time, String timePattern) {
-    return time.format(DateTimeFormatter.ofPattern(timePattern));
-  }
-
-  public static String quote(String input, String quoteSymbol) {
-    if (input == "") {
-      return "NULL";
-    } else {
-      return input.matches("^\".*\"$") ? input : quoteSymbol + input + quoteSymbol;
-    }
-  }
 }

src/main/java/edu/ie3/datamodel/io/SqlUtils.java

@@ -12,10 +12,10 @@
 import edu.ie3.datamodel.io.naming.DatabaseNamingStrategy;
 import edu.ie3.datamodel.io.processor.ProcessorProvider;
 import edu.ie3.datamodel.models.Entity;
-import edu.ie3.datamodel.models.UniqueEntity;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Objects;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import org.slf4j.Logger;
@@ -43,8 +43,7 @@ public static String queryCreateGridTable(String schemaName) {
   }
 
   /** @return query to create a SQL table for an unique entity */
-  public static String queryCreateTableUniqueEntity(
-          Class<? extends Entity> cls, String schemaName)
+  public static String queryCreateTableUniqueEntity(Class<? extends Entity> cls, String schemaName)
       throws EntityProcessorException, ProcessorProviderException {
     ProcessorProvider processorProvider = new ProcessorProvider();
     DatabaseNamingStrategy namingStrategy = new DatabaseNamingStrategy();
@@ -75,7 +74,7 @@ public static String queryCreateTableUniqueEntity(
    * @return Map column name -> data type
    */
   public static Map<String, String> columnToSqlDataType() {
-    HashMap map = new HashMap();
+    Map<String, String> map = new HashMap<>();
 
     map.put("uuid", "uuid PRIMARY KEY");
     map.put("time_series", "uuid NOT NULL");
@@ -181,7 +180,7 @@ public static Map<String, String> columnToSqlDataType() {
     map.put("opex", "double precision NOT NULL");
     map.put("active_power_gradient", "double precision NOT NULL");
 
-    // not all data types are implemented
+    // TODO: Not all data types are implemented
 
     return map;
   }
@@ -192,7 +191,7 @@ public static Map<String, String> columnToSqlDataType() {
    * @return input with quoteSymbol
    */
   public static String quote(String input, String quoteSymbol) {
-    if (input == "") {
+    if (Objects.equals(input, "")) {
       return "NULL";
     } else {
       return input.matches("^\".*\"$") ? input : quoteSymbol + input + quoteSymbol;

src/main/java/edu/ie3/datamodel/io/connectors/SqlConnector.java

@@ -156,11 +156,19 @@ public Map<String, String> extractFieldMap(ResultSet rs) {
     return insensitiveFieldsToAttributes;
   }
 
+  /**
+   * Executes a query to check if a table exists
+   *
+   * @param tableName Name of the table, that should be checked
+   * @return True, if the table exists
+   */
   public boolean tableExistsSQL(String tableName) throws SQLException {
-    PreparedStatement preparedStatement = connection.prepareStatement("SELECT count(*) "
-            + "FROM information_schema.tables "
-            + "WHERE table_name = ?"
-            + "LIMIT 1;");
+    PreparedStatement preparedStatement =
+        connection.prepareStatement(
+            "SELECT count(*) "
+                + "FROM information_schema.tables "
+                + "WHERE table_name = ?"
+                + "LIMIT 1;");
     preparedStatement.setString(1, tableName);
 
     ResultSet resultSet = preparedStatement.executeQuery();

src/main/java/edu/ie3/datamodel/io/naming/DatabaseNamingStrategy.java

@@ -8,12 +8,12 @@
 import static edu.ie3.datamodel.io.naming.EntityPersistenceNamingStrategy.logger;
 
 import edu.ie3.datamodel.io.naming.timeseries.ColumnScheme;
+import edu.ie3.datamodel.models.Entity;
 import edu.ie3.datamodel.models.timeseries.TimeSeries;
 import edu.ie3.datamodel.models.timeseries.TimeSeriesEntry;
 import edu.ie3.datamodel.models.timeseries.individual.IndividualTimeSeries;
 import edu.ie3.datamodel.models.timeseries.repetitive.LoadProfileInput;
 import edu.ie3.datamodel.models.value.Value;
-import edu.ie3.datamodel.models.Entity;
 import java.util.Optional;
 
 /** A naming strategy for database entities */

src/main/java/edu/ie3/datamodel/io/processor/Processor.java

@@ -24,7 +24,6 @@
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.time.ZonedDateTime;
-import java.time.format.DateTimeFormatter;
 import java.util.*;
 import java.util.stream.Collectors;
 import javax.measure.Quantity;

src/main/java/edu/ie3/datamodel/io/processor/ProcessorProvider.java

@@ -78,8 +78,8 @@ Try<LinkedHashMap<String, String>, ProcessorProviderException> handleEntity(T en
                     .transformF(ProcessorProviderException::new));
   }
 
-  public <T extends Entity> Set<LinkedHashMap<String, String>> handleEntities(
-      List<T> entities) throws ProcessorProviderException {
+  public <T extends Entity> Set<LinkedHashMap<String, String>> handleEntities(List<T> entities)
+      throws ProcessorProviderException {
     Set<T> setOfEntities = new HashSet<>(entities);
     Set<LinkedHashMap<String, String>> setOfMaps = new HashSet<>();
     for (T entity : setOfEntities) {