Merge branch 'dev' into feature_json-gardenplan_M2

src/main/java/ch/zhaw/gartenverwaltung/io/JsonPlantDatabase.java

@@ -1,10 +1,13 @@
 package ch.zhaw.gartenverwaltung.io;
 
+import ch.zhaw.gartenverwaltung.json.PlantImageDeserializer;
 import ch.zhaw.gartenverwaltung.types.HardinessZone;
 import ch.zhaw.gartenverwaltung.types.Plant;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import com.fasterxml.jackson.datatype.jsr310.deser.MonthDayDeserializer;
+import javafx.scene.image.Image;
 
 import java.io.IOException;
 import java.net.URL;
@@ -31,11 +34,14 @@ public class JsonPlantDatabase implements PlantDatabase {
      * Creating constant objects required to deserialize the {@link MonthDay} classes
      */
     private final static JavaTimeModule timeModule = new JavaTimeModule();
+    private final static SimpleModule imageModule = new SimpleModule();
 
     static {
         DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("MM-dd");
         MonthDayDeserializer dateDeserializer = new MonthDayDeserializer(dateFormat);
         timeModule.addDeserializer(MonthDay.class, dateDeserializer);
+
+        imageModule.addDeserializer(Image.class, new PlantImageDeserializer());
     }
 
     /**
@@ -76,8 +82,9 @@ public class JsonPlantDatabase implements PlantDatabase {
         }
         if (dataSource != null) {
             currentZone = zone;
-            ObjectMapper mapper = new ObjectMapper();
-            mapper.registerModule(timeModule);
+            ObjectMapper mapper = new ObjectMapper()
+                    .registerModule(timeModule)
+                    .registerModule(imageModule);
 
             List<Plant> result;
             result = mapper.readerForListOf(Plant.class).readValue(dataSource);

src/main/java/ch/zhaw/gartenverwaltung/io/JsonTaskDatabase.java

@@ -0,0 +1,126 @@
+package ch.zhaw.gartenverwaltung.io;
+
+import ch.zhaw.gartenverwaltung.types.Task;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URL;
+import java.time.LocalDate;
+import java.time.format.DateTimeFormatter;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Implements the {@link TaskDatabase} interface for loading and writing {@link Task} objects
+ * from and to a JSON file.
+ * The reads are cached to minimize file-io operations.
+ */
+public class JsonTaskDatabase implements TaskDatabase{
+    IdProvider idProvider;
+    private final URL dataSource = getClass().getResource("taskdb.json");
+
+    private Map<Long, Task> taskMap = Collections.emptyMap();
+
+    /**
+     * Creating constant objects required to deserialize the {@link LocalDate} classes
+     */
+    private final static JavaTimeModule timeModule = new JavaTimeModule();
+    static {
+        DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd");
+        LocalDateDeserializer dateDeserializer = new LocalDateDeserializer(dateFormat);
+        timeModule.addDeserializer(LocalDate.class, dateDeserializer);
+    }
+
+    /**
+     * If no data is currently loaded, data is loaded from {@link #dataSource}.
+     * In any case, the values of {@link #taskMap} are returned.
+     *
+     * @see TaskDatabase#getTaskList(LocalDate, LocalDate)
+     */
+    @Override
+    public List<Task> getTaskList(LocalDate start, LocalDate end) throws IOException{
+        if(taskMap.isEmpty()) {
+            loadTaskListFromFile();
+        }
+        return taskMap.values().stream().filter(task -> task.isInTimePeriode(start, end)).toList();
+    }
+
+    /**
+     * If no data is currently loaded, data is loaded from {@link #dataSource}.
+     * If the {@link Task} has an id than the task is added to the {@link #taskMap}
+     * otherwise the id is generated with the {@link IdProvider} before adding
+     * it to the {@link #taskMap}. In any case, the {@link #taskMap} is written
+     * to the {@link #dataSource}.
+     *
+     * @see TaskDatabase#saveTask(Task)
+     */
+    @Override
+    public void saveTask(Task task) throws IOException {
+        if(taskMap.isEmpty()) {
+            loadTaskListFromFile();
+        }
+        if(task.getId() == 0) {
+            task.withId(idProvider.incrementAndGet());
+        }
+        writeTaskListToFile();
+    }
+
+    /**
+     * If no data is currently loaded, data is loaded from {@link #dataSource}.
+     * If the {@link Task}s id is found in the {@link #taskMap}, the Task is removed
+     * from the  {@link #taskMap}. Then the Task are written to the {@link #dataSource}.
+     *
+     * @see TaskDatabase#removeTask(Task)
+     */
+    @Override
+    public void removeTask(Task task) throws IOException {
+        if(taskMap.isEmpty()) {
+            loadTaskListFromFile();
+        }
+        if(taskMap.containsKey(task.getId())){
+            taskMap.remove(task.getId());
+            writeTaskListToFile();
+        }
+    }
+
+    /**
+     * Writes cached data to the {@link #dataSource}.
+     *
+     * @throws IOException If the database cannot be accessed
+     */
+    private void writeTaskListToFile() throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.registerModule(timeModule)
+                .registerModule(new Jdk8Module());
+
+        if(dataSource != null) {
+            mapper.writeValue(new File(dataSource.getFile()), taskMap);
+        }
+    }
+
+    /**
+     * Loads the database from {@link #dataSource} and updates the cached data.
+     *
+     * @throws IOException If the database cannot be accessed
+     */
+    private void loadTaskListFromFile() throws IOException {
+        if (dataSource != null) {
+            ObjectMapper mapper = new ObjectMapper();
+            mapper.registerModule(timeModule);
+
+            List<Task> result;
+            result = mapper.readerForListOf(Task.class).readValue(dataSource);
+
+            taskMap = result.stream()
+                    .collect(HashMap::new,
+                        (res, task) -> res.put(task.getId(), task),
+                        (existing, replacement) -> {});
+        }
+    }
+}

src/main/java/ch/zhaw/gartenverwaltung/io/TaskDatabase.java

@@ -1,13 +1,42 @@
 package ch.zhaw.gartenverwaltung.io;
 
+import ch.zhaw.gartenverwaltung.types.HardinessZone;
+import ch.zhaw.gartenverwaltung.types.Plant;
 import ch.zhaw.gartenverwaltung.types.Task;
 
 import java.io.IOException;
+import java.time.LocalDate;
 import java.util.Date;
 import java.util.List;
 
+/**
+ * A database of {@link Task}s.
+ * The interface specifies the minimal required operations.
+ */
 public interface TaskDatabase {
-    List<Task> getTaskList(Date start, Date end);
+    /**
+     * Yields a list of all {@link Task}s in the database with the start and end date of a period of time.
+     *
+     * @param start The start date of the wanted time period
+     * @param end The end date of the wanted time period
+     * @return A list of {@link Task}s planned in the specified time period
+     * @throws IOException If the database cannot be accessed
+     */
+    List<Task> getTaskList(LocalDate start, LocalDate end) throws IOException;
+
+    /**
+     * Saves the {@link Task} in the Cache.
+     *
+     * @param task The {@link Task} which is wanted to be saved in the TaskList
+     * @throws IOException If the database cannot be accessed
+     */
     void saveTask(Task task) throws IOException;
+
+    /**
+     * Removes the {@link Task}from the Cache.
+     *
+     * @param task The {@link Task} which has to be removed from the {@link Task} list.
+     * @throws IOException If the database cannot be accessed
+     */
     void removeTask(Task task) throws IOException;
 }