#23: Javadoc
Some checks failed
Quality Check / Linting Check (push) Failing after 15s
Quality Check / Linting Check (pull_request) Failing after 21s
Quality Check / Javadoc Check (push) Successful in 35s
Quality Check / Javadoc Check (pull_request) Successful in 33s

This commit is contained in:
Dominik Säume 2024-05-17 14:14:48 +02:00
parent c5237fed83
commit 8f31e85225
Signed by: SZUT-Dominik
GPG key ID: DACB4B96EB59ABA8
4 changed files with 49 additions and 1 deletions

View file

@ -24,6 +24,7 @@ import javafx.stage.Stage;
* The controller for viewing all {@link Medication}s. * The controller for viewing all {@link Medication}s.
* *
* @author Dominik Säume * @author Dominik Säume
* @author Ole Kück
*/ */
public class AllMedicationController { public class AllMedicationController {
@FXML @FXML
@ -90,6 +91,9 @@ public class AllMedicationController {
} }
} }
/**
* Method to create a new {@link Medication}.
*/
public void createMedication(Medication medication) { public void createMedication(Medication medication) {
dao = DaoFactory.getInstance().createMedicationDAO(); dao = DaoFactory.getInstance().createMedicationDAO();
try { try {

View file

@ -9,6 +9,12 @@ import javafx.scene.control.TextField;
import javafx.scene.layout.BorderPane; import javafx.scene.layout.BorderPane;
import javafx.scene.text.Text; import javafx.scene.text.Text;
/**
* A custom implementation of the {@link ListCell} for {@link Ingredient}s.
* This implementation contains an automatic resizing of the parent {@link ListView}.
*
* @author Dominik Säume
*/
public class IngredientListCell extends ListCell<Ingredient> { public class IngredientListCell extends ListCell<Ingredient> {
private final TextField textField; private final TextField textField;
private final Button deleteButton; private final Button deleteButton;
@ -65,6 +71,9 @@ public class IngredientListCell extends ListCell<Ingredient> {
} }
} }
/**
* A Callback for use as a Listener for the {@link IngredientListCell#textField}.
*/
private void onTextFieldUpdate(ObservableValue<? extends String> observable, String oldValue, String newValue) { private void onTextFieldUpdate(ObservableValue<? extends String> observable, String oldValue, String newValue) {
getItem().setName(textField.getText()); getItem().setName(textField.getText());
@ -81,6 +90,9 @@ public class IngredientListCell extends ListCell<Ingredient> {
getListView().setMinWidth(max + totalSpacing); getListView().setMinWidth(max + totalSpacing);
} }
/**
* Internal method to calculate the required width of the {@link IngredientListCell#textField}.
*/
private double getTextFieldRequiredWidth(TextField textField) { private double getTextFieldRequiredWidth(TextField textField) {
Text textNode = new Text(textField.getText()); Text textNode = new Text(textField.getText());
textNode.setFont(textField.getFont()); textNode.setFont(textField.getFont());

View file

@ -1,5 +1,6 @@
package de.hitec.nhplus.medication; package de.hitec.nhplus.medication;
import de.hitec.nhplus.treatment.Treatment;
import javafx.beans.value.ChangeListener; import javafx.beans.value.ChangeListener;
import javafx.collections.FXCollections; import javafx.collections.FXCollections;
import javafx.collections.ObservableList; import javafx.collections.ObservableList;
@ -16,6 +17,11 @@ import java.util.function.Predicate;
import static de.hitec.nhplus.utils.Validator.*; import static de.hitec.nhplus.utils.Validator.*;
/**
* The controller for creating and editing a specific {@link Medication}.
*
* @author Ole Kück
*/
public class MedicationModalController { public class MedicationModalController {
@FXML @FXML
@ -38,8 +44,15 @@ public class MedicationModalController {
private final ObservableList<Ingredient> ingredients = FXCollections.observableArrayList(); private final ObservableList<Ingredient> ingredients = FXCollections.observableArrayList();
private AllMedicationController controller; private AllMedicationController controller;
/**
* Initialization method that is called after the binding of all the fields.
*/
@FXML @FXML
public void initialize(Stage stage, AllMedicationController controller, Medication medication) { public void initialize(
Stage stage,
AllMedicationController controller,
Medication medication
) {
this.stage = stage; this.stage = stage;
this.controller=controller; this.controller=controller;
@ -76,6 +89,9 @@ public class MedicationModalController {
this.textFieldCurrentStock.textProperty().addListener(inputMedicationValidationListener); this.textFieldCurrentStock.textProperty().addListener(inputMedicationValidationListener);
} }
/**
* Internal method to show the data in the view.
*/
private void showData(){ private void showData(){
ingredients.setAll(medication.getIngredients()); ingredients.setAll(medication.getIngredients());
textFieldName.setText(medication.getName()); textFieldName.setText(medication.getName());

View file

@ -149,18 +149,34 @@ public class Validator {
return !text.isBlank(); return !text.isBlank();
} }
/**
* Validate that a {@link String} is a valid {@link de.hitec.nhplus.medication.Medication#name Medication name}.
* @param text The {@link String} to validate.
*/
public static boolean isValidMedicationName(String text) { public static boolean isValidMedicationName(String text) {
return !text.isBlank(); return !text.isBlank();
} }
/**
* Validate that a {@link String} is a valid {@link de.hitec.nhplus.medication.Medication#manufacturer Medication manufacturer}.
* @param text The {@link String} to validate.
*/
public static boolean isValidMedicationManufacturer(String text) { public static boolean isValidMedicationManufacturer(String text) {
return !text.isBlank(); return !text.isBlank();
} }
/**
* Validate that a {@link String} is a valid {@link de.hitec.nhplus.medication.Medication#administrationMethod Medication administration method}.
* @param text The {@link String} to validate.
*/
public static boolean isValidMedicationAdministrationMethod(String text) { public static boolean isValidMedicationAdministrationMethod(String text) {
return !text.isBlank(); return !text.isBlank();
} }
/**
* Validate that a {@link String} is a valid stock count.
* @param text The {@link String} to validate.
*/
public static boolean isValidStock(String text) { public static boolean isValidStock(String text) {
if (text.isBlank()) { if (text.isBlank()) {
return false; return false;