Compare commits

...
Author SHA1 Message Date
giavaphi 96dc0ad827 fix show all tasks 2022-12-09 19:38:22 +01:00
giavaphi 4d2057d0df fix update scheduler 2022-12-09 14:16:12 +01:00
giavaphi 45035e565c update tasks with subscription from JsonTaskList 2022-12-09 01:27:37 +01:00
David Guler c7b23335b5 doc: javadoc for types 2022-12-05 15:26:10 +01:00
gulerdavandGitHub Enterprise 7c015d78f4 Merge pull request #76 from schrom01/feature_guiOverhaul_M3
changesFXMLFile_and_JavaDocControllerFiles
2022-12-05 13:15:36 +01:00
19 changed files with 213 additions and 60 deletions
@@ -3,6 +3,7 @@ package ch.zhaw.gartenverwaltung;
import ch.zhaw.gartenverwaltung.bootstrap.AppLoader;
import ch.zhaw.gartenverwaltung.bootstrap.Inject;
import ch.zhaw.gartenverwaltung.io.PlantList;
import ch.zhaw.gartenverwaltung.io.TaskList;
import ch.zhaw.gartenverwaltung.models.Garden;
import ch.zhaw.gartenverwaltung.io.HardinessZoneNotSetException;
import ch.zhaw.gartenverwaltung.models.GardenSchedule;
@@ -128,7 +129,14 @@ public class CropDetailController {
}
area_label.setText(String.valueOf(crop.getArea()));
setTaskListProperty(crop);
initializeTaskListProperty(crop);
TaskList.TaskListObserver taskListObserver = newTaskList -> {
taskListProperty.clear();
taskListProperty.addAll(gardenSchedule.getTaskListForCrop(crop.getCropId().get()));
};
gardenSchedule.setTaskListObserver(taskListObserver);
taskList_listView.itemsProperty().bind(taskListProperty);
pestListProperty.addAll(plant.pests());
@@ -185,10 +193,10 @@ public class CropDetailController {
}
/**
* update task list
* initialize task list
* @param crop {@link Crop} that is selected
*/
private void setTaskListProperty(Crop crop) {
private void initializeTaskListProperty(Crop crop) {
crop.getCropId().ifPresent(id -> {
List<Task> taskList;
try {
@@ -326,13 +334,15 @@ public class CropDetailController {
if (newTask) {
try {
gardenSchedule.addTask(task);
setTaskListProperty(this.crop);
} catch (IOException e) {
e.printStackTrace();
}
} else {
//ToDo method to edit task
setTaskListProperty(this.crop);
try {
gardenSchedule.addTask(givenTask.updateTask(task));
} catch (IOException e) {
throw new RuntimeException(e);
}
}
});
}
@@ -387,7 +397,7 @@ public class CropDetailController {
if (buttonType == ButtonType.OK) {
try {
gardenSchedule.removeTask(task);
setTaskListProperty(this.crop);
//setTaskListProperty(this.crop);
} catch (IOException e) {
// TODO: Show error alert
LOG.log(Level.SEVERE, "Could not remove crop.", e);
@@ -22,13 +22,14 @@ public class Main extends Application {
AppLoader appLoader = new AppLoader();
backgroundTasks = new BackgroundTasks((TaskList) appLoader.getAppDependency(TaskList.class),(CropList) appLoader.getAppDependency(CropList.class), (PlantList) appLoader.getAppDependency(PlantList.class));
// TODO reduce period
backGroundTaskTimer.scheduleAtFixedRate(backgroundTasks, 0, 1000);
appLoader.loadSceneToStage("MainFXML.fxml", stage);
stage.setTitle("Gartenverwaltung");
stage.show();
backGroundTaskTimer.scheduleAtFixedRate(backgroundTasks, 0, 60000);
}
@Override
@@ -3,15 +3,15 @@ package ch.zhaw.gartenverwaltung;
import ch.zhaw.gartenverwaltung.bootstrap.AfterInject;
import ch.zhaw.gartenverwaltung.bootstrap.Inject;
import ch.zhaw.gartenverwaltung.io.PlantList;
import ch.zhaw.gartenverwaltung.io.TaskList;
import ch.zhaw.gartenverwaltung.models.Garden;
import ch.zhaw.gartenverwaltung.io.HardinessZoneNotSetException;
import ch.zhaw.gartenverwaltung.models.GardenSchedule;
import ch.zhaw.gartenverwaltung.types.Crop;
import ch.zhaw.gartenverwaltung.types.Plant;
import ch.zhaw.gartenverwaltung.types.Task;
import javafx.application.Platform;
import javafx.beans.property.ListProperty;
import javafx.beans.property.SimpleListProperty;
import javafx.collections.FXCollections;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.fxml.FXML;
@@ -32,7 +32,6 @@ import java.util.logging.Logger;
*/
public class MyScheduleController {
private static final Logger LOG = Logger.getLogger(MyScheduleController.class.getName());
private final ListProperty<List<Task>> taskListProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
private Crop selectedCrop = null;
@@ -52,20 +51,35 @@ public class MyScheduleController {
@FXML
private ListView<Crop> scheduledPlants_listview;
@FXML
private void showAllTasks(ActionEvent actionEvent) throws IOException {
gardenSchedule.getTasksUpcomingWeek();
scheduledPlants_listview.getSelectionModel().clearSelection();
}
@AfterInject
@SuppressWarnings("unused")
public void init() {
public void init() throws IOException {
setCellFactoryCropListView();
setCellFactoryTaskListView();
scheduledPlants_listview.itemsProperty().bind(garden.getPlantedCrops());
ListProperty<List<Task>> taskListProperty = gardenSchedule.getWeeklyTaskListProperty();
week_listView.itemsProperty().bind(taskListProperty);
lookForSelectedListEntries();
information_label.setText("");
gardenSchedule.getTasksUpcomingWeek();
TaskList.TaskListObserver taskListObserver = newTaskList -> {
Platform.runLater(() -> {
try {
loadTaskList();
gardenSchedule.getTasksUpcomingWeek();
scheduledPlants_listview.getSelectionModel().clearSelection();
} catch (IOException e) {
e.printStackTrace();
throw new RuntimeException(e);
}
});
};
gardenSchedule.setTaskListObserver(taskListObserver);
}
/**
@@ -86,6 +100,8 @@ public class MyScheduleController {
* set cellFactory for the crops.
*/
private void setCellFactoryCropListView() {
MultipleSelectionModel<Crop> selectionModel = scheduledPlants_listview.getSelectionModel();
selectionModel.setSelectionMode(SelectionMode.MULTIPLE);
scheduledPlants_listview.setCellFactory(param -> new ListCell<>() {
@Override
protected void updateItem(Crop crop, boolean empty) {
@@ -117,8 +133,8 @@ public class MyScheduleController {
super.updateItem(taskList, empty);
if (empty || taskList == null) {
setGraphic(null);
setText(null);
setGraphic(null);
} else {
setText("");
setGraphic(weekTaskVBox(taskList, this.getIndex()));
@@ -134,12 +150,10 @@ public class MyScheduleController {
private void loadTaskList() throws IOException {
List<List<Task>> taskLists;
if (selectedCrop != null) {
taskLists = gardenSchedule.getTasksUpcomingWeekForCrop(selectedCrop.getCropId().get());
gardenSchedule.getTasksUpcomingWeekForCrop(selectedCrop.getCropId().get());
} else {
taskLists = gardenSchedule.getTasksUpcomingWeek();
gardenSchedule.getTasksUpcomingWeek();
}
taskListProperty.clear();
taskListProperty.addAll(taskLists);
}
/**
@@ -205,5 +219,4 @@ public class MyScheduleController {
});
}
}
@@ -59,7 +59,7 @@ public class TaskFormularController implements Initializable {
*/
public Task returnResult(Crop crop) {
int interval = 0;
if (!(interval_field.getText().isEmpty() || interval_field.getText().equals(""))) {
if (interval_field.getText() != null && !(interval_field.getText().isEmpty() || interval_field.getText().equals(""))) {
interval = Integer.parseInt(interval_field.getText());
}
Task task = new Task(taskName_field.getText(), description_area.getText(),
@@ -159,7 +159,7 @@ public class TaskFormularController implements Initializable {
*/
public void initSaveButton(Button button) {
interval_field.textProperty().addListener((observable, oldValue, newValue) -> {
if (!newValue.matches("\\d*")) {
if (newValue != null && !newValue.matches("\\d*")) {
interval_field.setText(newValue.replaceAll("[^\\d]", ""));
}
});
@@ -43,7 +43,8 @@ public class WeatherGradenTaskPlanner {
private void getSevereWeatherEvents() throws IOException {
SevereWeather actualWeather = weatherService.causeSevereWeather(1);
if (SevereWeather.HAIL.equals(actualWeather)) {
createPreHailTask();
//ToDo creates hail task all 3 seconds, pls fix
//createPreHailTask();
} else if (SevereWeather.FROST.equals(actualWeather)) {
createPreFrostTask();
} else if (SevereWeather.SNOW.equals(actualWeather)) {
@@ -67,11 +67,11 @@ public class JsonTaskList implements TaskList {
* @see TaskList#getTaskList(LocalDate, LocalDate)
*/
@Override
public List<Task> getTaskList(LocalDate start, LocalDate end) throws IOException{
public synchronized List<Task> getTaskList(LocalDate start, LocalDate end) throws IOException{
if(taskMap.isEmpty()) {
loadTaskListFromFile();
}
return taskMap.values().stream().filter(task -> task.isInTimePeriode(start, end)).toList();
return taskMap.values().stream().filter(task -> task.isInTimePeriod(start, end)).toList();
}
/**
@@ -80,7 +80,7 @@ public class JsonTaskList implements TaskList {
* @return List of Tasks for given Crop
*/
@Override
public List<Task> getTaskForCrop(long cropId) throws IOException {
public synchronized List<Task> getTaskForCrop(long cropId) throws IOException {
if(taskMap.isEmpty()) {
loadTaskListFromFile();
}
@@ -111,7 +111,7 @@ public class JsonTaskList implements TaskList {
* @see TaskList#saveTask(Task)
*/
@Override
public void saveTask(Task task) throws IOException {
public synchronized void saveTask(Task task) throws IOException {
if(taskMap.isEmpty()) {
loadTaskListFromFile();
}
@@ -154,7 +154,7 @@ public class JsonTaskList implements TaskList {
/**
* Calls the change handler method on all registered observers.
*/
private void notifySubscribers() {
private void notifySubscribers() throws IOException {
for (TaskListObserver subscriber : subscribers) {
subscriber.onChange(taskMap.values().stream().toList());
}
@@ -67,6 +67,6 @@ public interface TaskList {
* Method which will be called when changes occur.
* @param newTaskList The new values
*/
void onChange(List<Task> newTaskList);
void onChange(List<Task> newTaskList) throws IOException;
}
}
@@ -3,6 +3,10 @@ package ch.zhaw.gartenverwaltung.models;
import ch.zhaw.gartenverwaltung.Settings;
import ch.zhaw.gartenverwaltung.io.*;
import ch.zhaw.gartenverwaltung.types.*;
import javafx.application.Platform;
import javafx.beans.property.ListProperty;
import javafx.beans.property.SimpleListProperty;
import javafx.collections.FXCollections;
import java.io.IOException;
import java.time.LocalDate;
@@ -20,15 +24,28 @@ public class GardenSchedule {
*/
static final Comparator<Task> sortByStartDate = Comparator.comparing(Task::getStartDate);
static final Comparator<Task> sortByNextExecution = Comparator.comparing(Task::getNextExecution);
private final ListProperty<List<Task>> weeklyTaskListProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
/**
* Constructor to create Database Objects.
*/
public GardenSchedule(TaskList taskList, PlantList plantList) {
public GardenSchedule(TaskList taskList, PlantList plantList) throws IOException {
this.taskList = taskList;
this.plantList = plantList;
}
public ListProperty<List<Task>> getWeeklyTaskListProperty() {
return weeklyTaskListProperty;
}
/**
* subscribe task list observer to get notifications
* @param observer the task list which will be ovserved
*/
public void setTaskListObserver(TaskList.TaskListObserver observer) {
taskList.subscribe(observer);
}
/**
* Method to save a new Task to Task Database
* @param task the Task to save
@@ -163,18 +180,20 @@ public class GardenSchedule {
}
});
}
weeklyTaskListProperty.clear();
weeklyTaskListProperty.addAll(dayTaskList);
return dayTaskList;
}
/**
* Method to get an List of 7 Tasklists for the next 7 days. (Filtered Index 0 is Tasklist for Today.
* @return List with length 7 (List<List<Task>>)
* @throws IOException If the database cannot be accessed
*/
public List<List<Task>> getTasksUpcomingWeekForCrop(Long cropId) throws IOException {
public void getTasksUpcomingWeekForCrop(Long cropId) throws IOException {
List<List<Task>> dayTaskList = getTasksUpcomingWeek();
dayTaskList.forEach(taskList -> taskList.removeIf(task -> task.getCropId() != cropId));
return dayTaskList;
weeklyTaskListProperty.clear();
weeklyTaskListProperty.addAll(dayTaskList);
}
/**
@@ -1,12 +1,12 @@
package ch.zhaw.gartenverwaltung.types;
import ch.zhaw.gartenverwaltung.io.JsonPlantList;
import ch.zhaw.gartenverwaltung.io.PlantList;
import java.time.LocalDate;
import java.util.Objects;
import java.util.Optional;
/**
* Represents a crop, meaning a specific plant growing at a specific time.
*/
public class Crop {
private Long cropId = null;
private final long plantId;
@@ -7,7 +7,19 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.time.MonthDay;
import java.util.List;
/**
* Represents a growth phase of a plant.
* Plants go through several phases during their life (sowing, germinating, growing, ..., harvest).
* These phases are characterized by what kinds of tasks need to be executed by the gardener to stay alive.
* This class represents one such phase.
*
* @param startDate The earliest date on which this phase can start
* @param endDate The latest date on which this phase can start
* @param group Which group this phase belongs to (if the growth phase can occur multiple times a year, default: 0)
* @param type What {@link GrowthPhaseType} this represents
* @param zone The hardiness zone for which this growth phase is valid
* @param taskTemplates The (undated) tasks required to be performed by the gardener
*/
public record GrowthPhase(
MonthDay startDate,
MonthDay endDate,
@@ -1,5 +1,9 @@
package ch.zhaw.gartenverwaltung.types;
/**
* Enumerates the different possible types of {@link GrowthPhase}.
* (Subject to later expansion)
*/
public enum GrowthPhaseType {
SOW, PLANT, REPLANT, HARVEST
}
@@ -1,4 +1,11 @@
package ch.zhaw.gartenverwaltung.types;
/**
* Represents a pest or pathogen which may afflict a plant.
*
* @param name The name of the pest
* @param description A description of the pest
* @param measures Measures that can be taken against the pest.
*/
public record Pest(String name, String description, String measures) {
}
@@ -9,6 +9,20 @@ import java.util.stream.Collectors;
import static java.time.temporal.ChronoUnit.DAYS;
/**
* Represents a plant
*
* @param id A unique identifier
* @param name The name of the plant
* @param description A description of the plant
* @param image An image representing the plant
* @param spacing The amount of space needed between individual plants of this type
* @param light The amount of light preferred by the plant (h/d)
* @param soil The type of soil required for the plant
* @param pests {@link Pest}s that may afflict the plant
* @param wateringCycle The {@link WateringCycle} required by the plant
* @param lifecycle A list of {@link GrowthPhase}s constituting the plants lifecycle
*/
public record Plant(
long id,
String name,
@@ -30,9 +44,10 @@ public record Plant(
}
/**
* get all growthPhases of lifecycle group
* @param group lifecycle group
* @return list of growthPhases
* Get all {@link GrowthPhase}s of a lifecycle group
*
* @param group The lifecycle group
* @return A list of {@link GrowthPhase}s
*/
public List<GrowthPhase> lifecycleForGroup(int group) {
return lifecycle.stream()
@@ -40,6 +55,12 @@ public record Plant(
.collect(Collectors.toList());
}
/**
* Given a {@link LocalDate}, determines which lifecycle group contains it.
*
* @param date The date to look for
* @return Which lifecycle group the date is in
*/
public int getGrowphaseGroupForDate(LocalDate date) {
for(GrowthPhase growthPhase : lifecycle){
MonthDay plantingDate = MonthDay.of(date.getMonth().getValue(), date.getDayOfMonth());
@@ -51,16 +72,18 @@ public record Plant(
}
/**
* get sow date from given harvest day from lifecycle group
* Get sow date from given harvest date from lifecycle group
*
* @param harvestDate date of the harvest
* @return LocaleDate of sow date
* @return {@link LocalDate} of sow date
*/
public LocalDate sowDateFromHarvestDate(LocalDate harvestDate) {
return harvestDate.minusDays(timeToHarvest(lifecycleGroupFromHarvestDate(harvestDate)));
}
/**
* calculate the days between sow and harvest day for lifecycle group
* Calculate the number of days between sow and harvest date for lifecycle group
*
* @param group the lifecycle group
* @return Integer number of dates between sow and harvest day
*/
@@ -79,6 +102,12 @@ public record Plant(
return (int) DAYS.between(sow.startDate().atYear(currentYear),harvest.startDate().atYear(currentYear));
}
/**
* Given a harvest date, determines which lifecycle group it belongs to.
*
* @param harvestDate The harvest date
* @return Which lifecycle group the harvest date is in
*/
public int lifecycleGroupFromHarvestDate(LocalDate harvestDate) {
return lifecycle.stream()
.filter(growthPhase -> growthPhase.type().equals(GrowthPhaseType.HARVEST) &&
@@ -2,6 +2,10 @@ package ch.zhaw.gartenverwaltung.types;
import java.time.MonthDay;
/**
* Describes the 4 Seasons in terms of {@link java.time.LocalDate}s
* Also describes "All Seasons" as the full year.
*/
public enum Seasons {
ALLSEASONS("--01-01", "--12-31", "All Seasons"),
SPRING("--03-01", "--05-30", "Spring"),
@@ -1,11 +1,10 @@
package ch.zhaw.gartenverwaltung.types;
import java.time.LocalDate;
import java.util.Optional;
/**
* Models a Task
* Represents a Task
* May be created using the builder pattern.
*/
public class Task {
@@ -18,10 +17,9 @@ public class Task {
private LocalDate nextExecution;
private LocalDate nextNotification;
private long cropId;
private boolean done;
/**
* default constructor
* Default constructor
* (used by Json deserializer)
*/
public Task(){
@@ -32,6 +30,14 @@ public class Task {
nextExecution = startDate;
}
/**
* Constructor for a non-repeating task related to a {@link Crop}
*
* @param name The name of the task
* @param description A description of the task
* @param startDate The start date of the task
* @param cropId The id of the crop to which the task belongs
*/
public Task(String name, String description, LocalDate startDate, long cropId) {
this.name = name;
this.description = description;
@@ -43,6 +49,11 @@ public class Task {
/**
* Constructor for weather events
*
* @param name The name of the task
* @param description A description of the task
* @param startDate The start date of the task
* @param endDate The maximum date on which the task should be executed
*/
public Task(String name, String description, LocalDate startDate, LocalDate endDate) {
this.name = name;
@@ -51,6 +62,16 @@ public class Task {
this.endDate = endDate;
}
/**
* Full constructor (without id)
*
* @param name The name of the task
* @param description A description of the task
* @param startDate The start date of the task
* @param endDate The maximum date on which the task should be executed
* @param interval The number of days between executions
* @param cropId The id of the crop to which the task belongs
*/
public Task(String name, String description, LocalDate startDate, LocalDate endDate, int interval, long cropId) {
this.name = name;
this.description = description;
@@ -75,10 +96,20 @@ public class Task {
return this;
}
public boolean isInTimePeriode(LocalDate searchStartDate, LocalDate searchEndDate){
return endDate.isAfter(searchStartDate) && startDate.isBefore(searchEndDate);
/**
* Checks if the Task is within a specific date range.
*
* @param searchStartDate The minimum date
* @param searchEndDate The maximum date
* @return Whether the Task is within the given range
*/
public boolean isInTimePeriod(LocalDate searchStartDate, LocalDate searchEndDate) {
return endDate.isAfter(searchStartDate) && startDate.isBefore(searchEndDate) || (nextExecution != null && nextExecution.isBefore(searchEndDate) && nextExecution.isAfter(searchStartDate));
}
/**
* Marks a specific execution of a Task as done.
*/
public void done(){
if(interval != null && interval != 0 && !nextExecution.plusDays(interval).isAfter(endDate)){
nextExecution = nextExecution.plusDays(interval);
@@ -117,6 +148,12 @@ public class Task {
return Optional.ofNullable(endDate);
}
/**
* Updates the fields of this Task using the values of the given Task
*
* @param task The task whose fields to copy
* @return This task with the fields already updated
*/
public Task updateTask(Task task) {
this.name = task.getName();
this.description = task.getDescription();
@@ -41,6 +41,13 @@ public class TaskTemplate {
this.relativeStartDate = relativeStartDate;
}
/**
* Create a concrete {@link Task} given a concrete start date
*
* @param realStartDate The start date of the {@link GrowthPhase} to which the {@link #relativeStartDate} is relative.
* @param cropId The crop for which the task should be generated.
* @return The created {@link Task}
*/
public Task generateTask(LocalDate realStartDate, long cropId) {
LocalDate endDate = relativeEndDate != null ? realStartDate.plusDays(relativeEndDate) : realStartDate;
@@ -1,5 +1,12 @@
package ch.zhaw.gartenverwaltung.types;
/**
* Describes the cycle in which a {@link Plant} should be watered
*
* @param litersPerSqM How many litres of water per square metre of ground
* @param interval The interval (days)
* @param notes Notes on the cycle
*/
public record WateringCycle(
int litersPerSqM,
int interval,
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<?import javafx.geometry.Insets?>
<?import javafx.scene.control.Button?>
<?import javafx.scene.control.Label?>
<?import javafx.scene.control.ListView?>
<?import javafx.scene.layout.AnchorPane?>
@@ -19,11 +20,12 @@
</Label>
<HBox maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308" prefHeight="541.0" prefWidth="867.0" spacing="10.0" VBox.vgrow="ALWAYS">
<children>
<ListView fx:id="scheduledPlants_listview" maxWidth="1.7976931348623157E308" prefHeight="522.0" prefWidth="271.0" HBox.hgrow="NEVER">
<HBox.margin>
<Insets />
</HBox.margin>
</ListView>
<VBox prefHeight="497.0" prefWidth="237.0" spacing="10.0" HBox.hgrow="NEVER">
<children>
<ListView fx:id="scheduledPlants_listview" maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308" prefHeight="522.0" prefWidth="271.0" VBox.vgrow="ALWAYS" />
<Button maxWidth="1.7976931348623157E308" mnemonicParsing="false" onAction="#showAllTasks" styleClass="button-class" text="Show All Tasks" VBox.vgrow="NEVER" />
</children>
</VBox>
<VBox maxWidth="1.7976931348623157E308" prefHeight="537.0" prefWidth="650.0" spacing="10.0" HBox.hgrow="ALWAYS">
<children>
<ListView fx:id="week_listView" maxWidth="1.7976931348623157E308" prefHeight="200.0" prefWidth="200.0" VBox.vgrow="ALWAYS">
@@ -130,7 +130,7 @@ public class JsonTaskListTest {
}
@Test
void testSubscription() {
void testSubscription() throws IOException {
TaskList.TaskListObserver mockObs = Mockito.mock(TaskList.TaskListObserver.class);
testDatabase.subscribe(mockObs);
try {