Merge pull request #45 from schrom01/feature_controllerPlantList_M2

Plant Controller Filter to hardiness zone and season

src/main/java/ch/zhaw/gartenverwaltung/MainFXMLController.java

@@ -10,10 +10,16 @@ import javafx.scene.layout.AnchorPane;
 
 import java.io.IOException;
 import java.net.URL;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Objects;
 import java.util.ResourceBundle;
 
 public class MainFXMLController implements Initializable {
+    /**
+     * Caching the panes
+     */
+    private final Map<String, AnchorPane> panes = new HashMap<>();
 
     @FXML
     private Button home_button;
@@ -62,15 +68,22 @@ public class MainFXMLController implements Initializable {
      * @throws IOException exception when file does not exist
      */
     public void loadPane(String fxmlFile) throws IOException {
-        //ToDo HGrow and VGrow of new node
+
-        Node node;
+        AnchorPane anchorPane = panes.get(fxmlFile);
+        if (anchorPane == null) {
             FXMLLoader loader = new FXMLLoader(Objects.requireNonNull(HelloApplication.class.getResource(fxmlFile)));
-        node = (Node)loader.load();
+            anchorPane = loader.load();
+            panes.put(fxmlFile, anchorPane);
+
             if(fxmlFile.equals("MyPlants.fxml")) {
                 MyPlantsController myPlantsController = loader.getController();
                 myPlantsController.getMainController(this);
             }
-        mainPane.getChildren().setAll(node);
+        }
+        mainPane.getChildren().setAll(anchorPane);
+        anchorPane.prefWidthProperty().bind(mainPane.widthProperty());
+        anchorPane.prefHeightProperty().bind(mainPane.heightProperty());
+
     }
 
     private void styleChangeButton(Button button) {

src/main/java/ch/zhaw/gartenverwaltung/PlantsController.java

@@ -4,19 +4,26 @@ import ch.zhaw.gartenverwaltung.io.HardinessZoneNotSetException;
 import ch.zhaw.gartenverwaltung.plantList.PlantListModel;
 import ch.zhaw.gartenverwaltung.types.HardinessZone;
 import ch.zhaw.gartenverwaltung.types.Plant;
+import ch.zhaw.gartenverwaltung.types.Seasons;
+import javafx.application.Platform;
+import javafx.beans.property.ListProperty;
+import javafx.beans.property.SimpleListProperty;
 import javafx.beans.value.ChangeListener;
 import javafx.beans.value.ObservableValue;
+import javafx.collections.FXCollections;
 import javafx.event.ActionEvent;
 import javafx.fxml.FXML;
 import javafx.fxml.Initializable;
+import javafx.geometry.Insets;
+import javafx.geometry.Bounds;
 import javafx.scene.control.*;
+import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
-import javafx.scene.input.InputMethodEvent;
+import javafx.scene.input.KeyEvent;
 import javafx.scene.layout.VBox;
 
 import java.io.IOException;
 import java.net.URL;
-import java.util.LinkedList;
 import java.util.List;
 import java.util.ResourceBundle;
 
@@ -25,8 +32,12 @@ public class PlantsController implements Initializable {
     private Plant selectedPlant = null;
     private final HardinessZone DEFAULT_HARDINESS_ZONE = HardinessZone.ZONE_8A;
 
+    // TODO: move to model
+
+    private final ListProperty<Plant> plantListProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
+
     @FXML
-    private CheckBox autum_filter;
+    private VBox seasons;
 
     @FXML
     private VBox climate_zones;
@@ -46,79 +57,45 @@ public class PlantsController implements Initializable {
     @FXML
     private TextField search_plants;
 
-    @FXML
+    /**
-    private CheckBox sommer_filter;
+     * saves the current selected plant in new JSON database
-
+     * @param event event
-    @FXML
+     */
-    private CheckBox spring_filter;
-
-    @FXML
-    private CheckBox winter_filter;
-
-    @FXML
-    void filterAutum(ActionEvent event) {
-        //ToDo
-
-    }
-
-    @FXML
-    void filterSommer(ActionEvent event) {
-        //ToDo
-
-    }
-
-    @FXML
-    void filterSpring(ActionEvent event) {
-        //ToDo
-
-    }
-
-    @FXML
-    void filterWinter(ActionEvent event) {
-        //ToDo
-
-    }
-
     @FXML
     void saveToMyPlant(ActionEvent event) {
         //ToDo model save selectedPlant to mySelectedPlant(IO)
     }
 
-    @FXML
-    void searchForPlant(InputMethodEvent event) {
-        viewFilteredListBySearch(search_plants.getText());
-    }
-
     /**
+     * fill list view with current hardiness zone
+     * set default values
+     * create filter of season and hardiness zone
+     * create event listener for selected list entry and search by query
      * {@inheritDoc}
      */
     @Override
     public void initialize(URL url, ResourceBundle resourceBundle) {
-        List<Plant> plantList = new LinkedList<>();
+        setListCellFactory();
-        try {
+        fillPlantListWithHardinessZone();
-            plantList = plantListModel.getPlantList(DEFAULT_HARDINESS_ZONE);
+        list_plants.itemsProperty().bind(plantListProperty);
-        } catch (HardinessZoneNotSetException | IOException e) {
-            e.printStackTrace();
-        }
-        fillListViewWithData(plantList);
 
         description_plant.setText("");
         saveToMyPlant_button.setDisable(true);
 
+        createFilterSeasons();
         createFilterHardinessZone();
         lookForSelectedListEntry();
+        try {
+            viewFilteredListBySearch();
+        } catch (HardinessZoneNotSetException | IOException e) {
+            e.printStackTrace();
+        }
     }
 
     /**
-     * update the ListView according to the plant list provided
+     *  set text of list view to plant name
-     * Entry in ListView is plant name
-     * @param list plantList which fill the ListView
      */
-    private void fillListViewWithData(List<Plant> list) {
+    private void setListCellFactory() {
-        clearListView();
-        for (Plant plant : list) {
-            list_plants.getItems().add(plant);
-        }
         list_plants.setCellFactory(param -> new ListCell<Plant>() {
             @Override
             protected void updateItem(Plant plant, boolean empty) {
@@ -133,44 +110,139 @@ public class PlantsController implements Initializable {
         });
     }
 
-    private void viewFilteredListByFilters() {
+    /**
-        boolean springValue = spring_filter.isSelected();
+     * get plant list according to param season and hardiness zone
-        boolean sommerValue = sommer_filter.isSelected();
+     * fill list view with plant list
-        boolean autumValue = autum_filter.isSelected();
+     * @param season enum of seasons
-        boolean winterValue = winter_filter.isSelected();
+     * @throws HardinessZoneNotSetException throws exception
-        //ToDo getFilteredPlantList with (plantListModel.getFilteredPlantList(DEFAULT_HARDINESS_ZONE, <predicate>))
+     * @throws IOException throws exception
-        //List<Plant> plantList = new LinkedList<>();
+     */
-        //fillListViewWithData(plantList);
+    private void viewFilteredListBySeason(Seasons season) throws HardinessZoneNotSetException, IOException {
-    }
+        clearListView();
-
+        plantListProperty.addAll(plantListModel.getFilteredPlantListBySaisonWithoutGrowthPhase(plantListModel.getCurrentZone(), season.getStartDate(), season.getEndDate()));
-    private void viewFilteredListBySearch(String query) {
-        //ToDo getFilteredPlantList with (plantListModel.getFilteredPlantList(DEFAULT_HARDINESS_ZONE, <predicate>))
-        //List<Plant> plantList = new LinkedList<>();
-        //fillListViewWithData(plantList);
-    }
-
-    private void createFilterHardinessZone() {
-        //ToDo create radioList of hardinessZone in VBox climate_zones
     }
 
     /**
-     * observes changes in the selectedProperty of ListView and updates the description label
+     * get plant list filtered by search plant entry and hardiness zone
+     * fill list view with plant list
+     * @throws HardinessZoneNotSetException throws exception when no hardiness zone is defined
+     * @throws IOException throws exception
+     */
+    private void viewFilteredListBySearch() throws HardinessZoneNotSetException, IOException {
+        search_plants.textProperty().addListener((observable, oldValue, newValue) -> {
+            if (newValue.isEmpty()) {
+                fillPlantListWithHardinessZone();
+            }else {
+                try {
+                    List<Plant> filteredPlants = plantListModel.getFilteredPlantListByString(DEFAULT_HARDINESS_ZONE, newValue);
+                    clearListView();
+                    plantListProperty.addAll(filteredPlants);
+                } catch (HardinessZoneNotSetException | IOException e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
+    /**
+     * get plant list of current hardiness zone
+     * fill list view with plant list
+     */
+    private void fillPlantListWithHardinessZone() {
+        try {
+            clearListView();
+            plantListProperty.addAll(plantListModel.getPlantList(plantListModel.getCurrentZone()));
+        } catch (HardinessZoneNotSetException | IOException e) {
+            e.printStackTrace();
+        }
+    }
+
+    /**
+     * creates radio buttons for the hardiness zones defined in enum HardinessZone
+     * defines default value as selected
+     * when selected filter viewList according to hardiness zone
+     */
+    private void createFilterHardinessZone() {
+        ToggleGroup hardinessGroup = new ToggleGroup();
+        for (HardinessZone zone : HardinessZone.values()) {
+            RadioButton radioButton = new RadioButton(zone.name());
+            radioButton.setToggleGroup(hardinessGroup);
+            radioButton.setPadding(new Insets(0,0,10,0));
+            if (zone.equals(DEFAULT_HARDINESS_ZONE)) {
+                radioButton.setSelected(true);
+            }
+            radioButton.selectedProperty().addListener(new ChangeListener<Boolean>() {
+                @Override
+                public void changed(ObservableValue<? extends Boolean> observable, Boolean oldValue, Boolean newValue) {
+                    plantListModel.setCurrentZone(zone);
+                    fillPlantListWithHardinessZone();
+                }
+            });
+            climate_zones.getChildren().add(radioButton);
+        }
+    }
+
+    /**
+     * creates radio buttons for the seasons defined in enum Seasons
+     * defines default value as selected
+     * when selected filter viewList according to seasons
+     */
+    private void createFilterSeasons() {
+        ToggleGroup seasonGroup = new ToggleGroup();
+        for (Seasons season : Seasons.values()) {
+            RadioButton radioButton = new RadioButton(season.name());
+            radioButton.setToggleGroup(seasonGroup);
+            radioButton.setPadding(new Insets(0,0,10,0));
+            if (season.equals(Seasons.AllSEASONS)) {
+                radioButton.setSelected(true);
+            }
+            radioButton.selectedProperty().addListener(new ChangeListener<Boolean>() {
+                @Override
+                public void changed(ObservableValue<? extends Boolean> observable, Boolean oldValue, Boolean newValue) {
+                    if (season.equals(Seasons.AllSEASONS)) {
+                        fillPlantListWithHardinessZone();
+                    } else {
+                        try {
+                            viewFilteredListBySeason(season);
+                        } catch (HardinessZoneNotSetException | IOException e) {
+                            e.printStackTrace();
+                        }
+                    }
+
+                }
+            });
+            seasons.getChildren().add(radioButton);
+        }
+    }
+
+    /**
+     * observes changes in the selectedProperty of ListView and updates:
+     * the description label
+     * image of the plant
      */
     private void lookForSelectedListEntry() {
         list_plants.getSelectionModel().selectedItemProperty().addListener(new ChangeListener<Plant>() {
             @Override
             public void changed(ObservableValue<? extends Plant> observable, Plant oldValue, Plant newValue) {
-                //ToDo
                 if(newValue != null) {
                     selectedPlant = newValue;
                     description_plant.setText(selectedPlant.description());
                     saveToMyPlant_button.setDisable(false);
-                    //update img plant
+                    Image img;
+                    if(selectedPlant.image() != null) {
+                        img = selectedPlant.image();
+                    } else {
+                        img = new Image(String.valueOf(PlantsController.class.getResource("placeholder.png")));
+                    }
+                    img_plant.setImage(img);
+
+
                 } else {
                     selectedPlant = null;
                     description_plant.setText("");
                     saveToMyPlant_button.setDisable(true);
-                    //update img when null placeholder PNG
+                    Image img = new Image(String.valueOf(PlantsController.class.getResource("placeholder.png")));
+                    img_plant.setImage(img);
                 }
             }
         });
@@ -181,6 +253,6 @@ public class PlantsController implements Initializable {
      * clears the ListView of entries
      */
     private void clearListView() {
-        list_plants.getItems().clear();
+        plantListProperty.clear();
     }
 }

src/main/java/ch/zhaw/gartenverwaltung/json/PlantImageDeserializer.java

@@ -6,9 +6,11 @@ import com.fasterxml.jackson.databind.DeserializationContext;
 import com.fasterxml.jackson.databind.JsonDeserializer;
 import javafx.scene.image.Image;
 
+import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.net.URISyntaxException;
 import java.net.URL;
 
 public class PlantImageDeserializer extends JsonDeserializer<Image> {
@@ -18,9 +20,9 @@ public class PlantImageDeserializer extends JsonDeserializer<Image> {
         Image result = null;
         URL imageUrl = PlantDatabase.class.getResource(String.format("images/%s", parser.getText()));
         if (imageUrl != null) {
-            try (InputStream is = new FileInputStream(imageUrl.getFile())) {
+            try (InputStream is = new FileInputStream(new File(imageUrl.toURI()))) {
                 result = new Image(is);
-            } catch (IllegalArgumentException e) {
+            } catch (IllegalArgumentException | URISyntaxException e) {
                 // TODO: Log
                 e.printStackTrace();
                 System.err.printf("Cannot find Image \"%s\"\n", imageUrl.getFile());

src/main/java/ch/zhaw/gartenverwaltung/plantList/PlantListModel.java

@@ -52,6 +52,7 @@ public class PlantListModel {
 
     /**
      * Method to get actual Plant List in alphabetic Order
+     *
      * @return actual Plant List in alphabetic Order
      */
     public List<Plant> getPlantList(HardinessZone zone) throws HardinessZoneNotSetException, IOException {
@@ -62,6 +63,7 @@ public class PlantListModel {
 
     /**
      * Method to get the actual Plant list in custom Order
+     *
      * @param zone       selected hardiness zone
      * @param comparator comparator to sort the list
      * @return sorted list with plants in the given hardiness zone
@@ -75,6 +77,7 @@ public class PlantListModel {
 
     /**
      * Method to get Filtered plant list
+     *
      * @param predicate predicate to filter the list
      * @param zone      selected hardiness zone
      * @return filterd list with plants in the hardinness zone
@@ -88,6 +91,7 @@ public class PlantListModel {
 
     /**
      * Method to get Filtered plant list by id by exact match
+     *
      * @param zone selected hardiness zone
      * @param id   id of plant
      * @return if id doesn't exist: empty List, else list with 1 plant entry.
@@ -102,7 +106,6 @@ public class PlantListModel {
     }
 
     /**
-     *
      * @param zone         selected hardiness zone
      * @param searchString the string to search plant List, set '#' as first char the search by id.
      * @return List of plants found in Plant List which contain the search String in the name or description
@@ -119,12 +122,16 @@ public class PlantListModel {
                 return new ArrayList<>();
             }
         } else {
-            return getFilteredPlantList(zone, plant -> plant.name().contains(searchString) || plant.description().contains(searchString));
+            String caseInsensitiveSearchString = searchString.toLowerCase();
+            return getFilteredPlantList(zone, plant ->
+                            plant.name().toLowerCase().contains(caseInsensitiveSearchString) ||
+                                    plant.description().toLowerCase().contains(caseInsensitiveSearchString)
+            );
         }
     }
 
+
     /**
-     *
      * @param type GrowPhaseType to filter
      * @param zone selected hardiness zone
      * @param from the earliest date to for the filter
@@ -138,7 +145,6 @@ public class PlantListModel {
     }
 
     /**
-     *
      * @param zone selected hardiness zone
      * @param from the earliest date to for the filter
      * @param to   the lastest date for the filter
@@ -151,7 +157,6 @@ public class PlantListModel {
     }
 
     /**
-     *
      * @param zone selected hardiness zone
      * @param from the earliest date to for the filter
      * @param to   the lastest date for the filter
@@ -162,4 +167,17 @@ public class PlantListModel {
     public List<Plant> getFilteredPlantListByHarvestSaison(HardinessZone zone, MonthDay from, MonthDay to) throws HardinessZoneNotSetException, IOException {
         return getFilteredPlantListBySaison(GrowthPhaseType.HARVEST, zone, from, to);
     }
+
+    /**
+     *
+     * @param zone selected hardiness zone
+     * @param from the earliest date to for the filter
+     * @param to the lastest date for the filter
+     * @return List of Plants with selected saison
+     * @throws HardinessZoneNotSetException If no {@link HardinessZone} was specified
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<Plant> getFilteredPlantListBySaisonWithoutGrowthPhase(HardinessZone zone, MonthDay from, MonthDay to) throws HardinessZoneNotSetException, IOException {
+        return getFilteredPlantList(zone, plant -> plant.lifecycle().stream().anyMatch(growthPhase -> growthPhase.startDate().compareTo(from) >= 0 && (growthPhase.startDate().compareTo(to) <= 0)));
+    }
 }

src/main/java/ch/zhaw/gartenverwaltung/types/Seasons.java

@@ -0,0 +1,26 @@
+package ch.zhaw.gartenverwaltung.types;
+
+import java.time.MonthDay;
+
+public enum Seasons {
+    AllSEASONS("--01-01", "--12-31"),
+    SPRING("--03-01", "--05-30"),
+    SOMMER("--06-01", "--08-30"),
+    AUTUM("--09-01", "--11-30"),
+    WINTER("--12-01", "--02-28");
+
+    public final String startDate;
+    public final String endDate;
+
+    Seasons(String startDate, String endDate) {
+        this.startDate = startDate;
+        this.endDate = endDate;
+    }
+
+    public MonthDay getStartDate() {
+        return MonthDay.parse(this.startDate);
+    }
+    public MonthDay getEndDate() {
+        return MonthDay.parse(this.endDate);
+    }
+}

src/main/resources/ch/zhaw/gartenverwaltung/Plants.fxml

@@ -3,7 +3,6 @@
 <?import javafx.geometry.Insets?>
 <?import javafx.geometry.Rectangle2D?>
 <?import javafx.scene.control.Button?>
-<?import javafx.scene.control.CheckBox?>
 <?import javafx.scene.control.Label?>
 <?import javafx.scene.control.ListView?>
 <?import javafx.scene.control.SplitPane?>
@@ -16,8 +15,9 @@
 <?import javafx.scene.layout.VBox?>
 <?import javafx.scene.text.Font?>
 
-<AnchorPane maxHeight="-Infinity" maxWidth="1.7976931348623157E308" minHeight="-Infinity" minWidth="1000.0" prefHeight="853.0" prefWidth="1219.0"
+<AnchorPane maxHeight="-Infinity" maxWidth="1.7976931348623157E308" minHeight="-Infinity" minWidth="1000.0" prefHeight="853.0"
-            xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1" fx:controller="ch.zhaw.gartenverwaltung.PlantsController">
+            prefWidth="1219.0" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1"
+            fx:controller="ch.zhaw.gartenverwaltung.PlantsController">
    <children>
       <SplitPane dividerPositions="0.7377363661277062" layoutX="539.0" layoutY="266.0" prefHeight="853.0" prefWidth="1219.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
         <items>
@@ -30,7 +30,7 @@
                               <Font name="System Bold" size="30.0" />
                            </font>
                         </Label>
-                        <TextField fx:id="search_plants" onInputMethodTextChanged="#searchForPlant" promptText="Search for Plant Name" />
+                        <TextField fx:id="search_plants" promptText="Search for Plant Name" />
                         <HBox alignment="CENTER_LEFT" prefHeight="480.0" prefWidth="881.0" VBox.vgrow="ALWAYS">
                            <children>
                               <ListView fx:id="list_plants" maxWidth="1.7976931348623157E308" prefHeight="497.0" prefWidth="580.0" HBox.hgrow="ALWAYS" />
@@ -75,30 +75,7 @@
                           <content>
                             <AnchorPane minHeight="0.0" minWidth="0.0" prefHeight="180.0" prefWidth="200.0">
                                  <children>
-                                    <VBox layoutX="37.0" layoutY="-19.0" prefHeight="180.66666666666666" prefWidth="310.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
+                                    <VBox fx:id="seasons" layoutX="37.0" layoutY="-19.0" prefHeight="180.66666666666666" prefWidth="310.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0" />
-                                       <children>
-                                          <CheckBox fx:id="spring_filter" mnemonicParsing="false" onAction="#filterSpring" text="Spring">
-                                             <padding>
-                                                <Insets top="10.0" />
-                                             </padding>
-                                          </CheckBox>
-                                          <CheckBox fx:id="sommer_filter" mnemonicParsing="false" onAction="#filterSommer" text="Sommer">
-                                             <padding>
-                                                <Insets top="10.0" />
-                                             </padding>
-                                          </CheckBox>
-                                          <CheckBox fx:id="autum_filter" mnemonicParsing="false" onAction="#filterAutum" text="Autum">
-                                             <padding>
-                                                <Insets top="10.0" />
-                                             </padding>
-                                          </CheckBox>
-                                          <CheckBox fx:id="winter_filter" mnemonicParsing="false" onAction="#filterWinter" text="Winter">
-                                             <padding>
-                                                <Insets top="10.0" />
-                                             </padding>
-                                          </CheckBox>
-                                       </children>
-                                    </VBox>
                                  </children>
                               </AnchorPane>
                           </content>