diff options
Diffstat (limited to 'src/de/fhswf/in')
11 files changed, 398 insertions, 23 deletions
diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/Main.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/Main.java index 1c41dbf..9c93b5a 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/Main.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/Main.java @@ -81,7 +81,7 @@ public class Main extends Application } /** - * TODO Add method comment here + * Show the Studentenverwaltung stage with the corresponding FXML. * */ public void showStudentenverwaltung() @@ -114,7 +114,7 @@ public class Main extends Application } /** - * TODO Add method comment here + * Show the Ansprechpartnerverwaltung stage with the corresponding FXML. * */ public void showAnsprechpartnerverwaltungsStage() @@ -147,7 +147,7 @@ public class Main extends Application } /** - * TODO Add method comment here + * Show the Projekthinzufuegen stage with the corresponding FXML. * */ public Projekt showProjekthinzufuegenStage(Projekt projekt) @@ -194,9 +194,9 @@ public class Main extends Application } /** - * TODO Add method comment here + * Getter for the StudentenverwaltungsStage. * - * @return + * @return studentenverwaltungsStage */ public Stage getStudentenverwaltungsStage() { @@ -204,9 +204,9 @@ public class Main extends Application } /** - * TODO Add method comment here + * Getter for the AnsprechpartnerverwaltungsStage. * - * @return + * @return ansprechpartnerverwaltungsStage */ public Stage getAnsprechpartnerverwaltungsStage() { @@ -214,9 +214,9 @@ public class Main extends Application } /** - * TODO Add method comment here + * Getter for the ProjekthinzufuegenStage. * - * @return + * @return projekthinzufuegenStage */ public Stage getProjekthinzufuegenStage() { diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Ansprechpartner.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Ansprechpartner.java index 7b708f4..8024467 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Ansprechpartner.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Ansprechpartner.java @@ -11,6 +11,13 @@ import javafx.beans.property.SimpleStringProperty; import javafx.beans.property.StringProperty; import javafx.util.Callback; +/** + * + * Class Ansprechpartner to represents data. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class Ansprechpartner { private StringProperty vorname = new SimpleStringProperty(); @@ -47,7 +54,7 @@ public class Ansprechpartner } /** - * TODO Add constructor comment here + * Constructor of Ansprechpartner. * * @param organisation */ @@ -62,9 +69,9 @@ public class Ansprechpartner } /** - * TODO Add method comment here + * Getter for an unmodifiable list of projects. * - * @return + * @return Collection.unmodifiableList(projekt) */ public List<Projekt> getProjekte() { @@ -72,7 +79,7 @@ public class Ansprechpartner } /** - * TODO Add method comment here + * Add a project to Ansprechpartner. * * @param projekt */ @@ -82,7 +89,7 @@ public class Ansprechpartner } /** - * TODO Add method comment here + * Remove a project from Ansprechpartner. * * @param projekt */ diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Organisation.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Organisation.java index 4525045..b9a6da4 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Organisation.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Organisation.java @@ -9,6 +9,13 @@ import javafx.beans.property.SimpleStringProperty; import javafx.beans.property.StringProperty; import javafx.util.Callback; +/** + * + * Class Organisation to represents data. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class Organisation { private StringProperty name = new SimpleStringProperty(""); @@ -27,7 +34,7 @@ public class Organisation } /** - * Getter for proerty name. + * Getter for property name. * * @return Returns the name. */ @@ -83,7 +90,7 @@ public class Organisation } /** - * TODO Add method comment here + * Remove the Ansprechpartner. * * @param ansprechpartner */ diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Projekt.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Projekt.java index a2bd162..91fd89e 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Projekt.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Projekt.java @@ -11,6 +11,13 @@ import javafx.beans.property.SimpleStringProperty; import javafx.beans.property.StringProperty; import javafx.util.Callback; +/** + * + * Class Projekt to represents data. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class Projekt { private StringProperty projektthema = new SimpleStringProperty(""); @@ -41,6 +48,11 @@ public class Projekt return projekt -> new Observable[] { projekt.statusProperty() }; } + /** + * + * Create the different StatusTypes as enums. + * + */ public static enum StatusTypes { IN_BEARBEITUNG("In Bearbeitung"), EINGEREICHT( "Eingereicht"), IN_UEBERARBEITUNG("In Überarbeitung"), ANGENOMMEN( @@ -59,6 +71,19 @@ public class Projekt } } + /** + * + * Constructor of Project. + * + * @param student1 + * The first Student + * @param student2 + * The second Student + * @param student3 + * The third Student + * @param ansprechpartner + * The Ansprechpartner + */ public Projekt( Student student1, Student student2, @@ -100,101 +125,220 @@ public class Projekt this.ansprechpartner.addProjekt(this); } + /** + * + * Getter for the property projektthema. + * + * @return Returns the property projecthema + */ public final StringProperty projektthemaProperty() { return this.projektthema; } + /** + * + * Getter for Projektthema. + * + * @return Returns Projektthema + */ public final String getProjektthema() { return this.projektthemaProperty().get(); } + /** + * + * Setter for the projektthema + * + * @param projektthema + */ public final void setProjektthema(final String projektthema) { this.projektthemaProperty().set(projektthema); } + /** + * + * Getter for the property skizze. + * + * @return Returns the property skizze + */ public final StringProperty skizzeProperty() { return this.skizze; } + /** + * + * Getter for skizze. + * + * @return Returns the skizze + */ public final String getSkizze() { return this.skizzeProperty().get(); } + /** + * + * Setter for the skizze. + * + * @param skizze + */ public final void setSkizze(final String skizze) { this.skizzeProperty().set(skizze); } + /** + * + * Getter for the property projektbeschreibung. + * + * @return Returns the property projektbeschreibung + */ public final StringProperty projektbeschreibungProperty() { return this.projektbeschreibung; } + /** + * + * Getter for projektbeschreibung. + * + * @return Returns the projektbeschriebung + */ public final String getProjektbeschreibung() { return this.projektbeschreibungProperty().get(); } + /** + * + * Setter for projektbeschreibung. + * + * @param projektbeschreibung + */ public final void setProjektbeschreibung(final String projektbeschreibung) { this.projektbeschreibungProperty().set(projektbeschreibung); } + /** + * + * Getter for the property projektinhalte. + * + * @return Returns the property projektinhalte + */ public final StringProperty projekteinhalteProperty() { return this.projekteinhalte; } + /** + * + * Getter for projektinhalte. + * + * @return Returns the projektinhalte + */ public final String getProjekteinhalte() { return this.projekteinhalteProperty().get(); } + /** + * + * Setter for projektinhalte. + * + * @param projekteinhalte + */ public final void setProjekteinhalte(final String projekteinhalte) { this.projekteinhalteProperty().set(projekteinhalte); } + /** + * Getter for an unmodifiable list of students. + * + * @return Collection.unmodifiableList(student) + */ public List<Student> getStudents() { return Collections.unmodifiableList(student); } + /** + * + * Getter for Ansprechpartner of the Projekt. + * + * @return Returns the Ansprechpartner of the Projekt + */ public Ansprechpartner getAnsprechpartner() { return this.ansprechpartner; } + /** + * + * Getter for the property Status. + * + * @return Returns the property status + */ public final ObjectProperty<StatusTypes> statusProperty() { return this.status; } + /** + * + * Getter for status. + * + * @return Returns the status + */ public final StatusTypes getStatus() { return this.statusProperty().get(); } + /** + * + * Setter of status. + * + * @param status + */ public final void setStatus(final StatusTypes status) { this.statusProperty().set(status); } + /** + * + * Getter of the property dozentenkommentar. + * + * @return Returns the property dozentenkommentar + */ public final StringProperty dozentenkommentarProperty() { return this.dozentenkommentar; } + /** + * + * Getter of dozentenkommentar. + * + * @return Returns the dozentenkommentar + */ public final String getDozentenkommentar() { return this.dozentenkommentarProperty().get(); } + /** + * + * Setter for dozentenkommentar. + * + * @param dozentenkommentar + */ public final void setDozentenkommentar(final String dozentenkommentar) { this.dozentenkommentarProperty().set(dozentenkommentar); diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Student.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Student.java index ea5b285..6890714 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Student.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/model/Student.java @@ -5,6 +5,13 @@ import javafx.beans.property.SimpleIntegerProperty; import javafx.beans.property.SimpleStringProperty; import javafx.beans.property.StringProperty; +/** + * + * Class Student to represents data. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class Student { private StringProperty vorname = new SimpleStringProperty(""); @@ -15,56 +22,122 @@ public class Student private Projekt projekt; + /** + * + * Getter for the property vorname. + * + * @return Returns the property vorname + */ public final StringProperty vornameProperty() { return this.vorname; } + /** + * + * Getter for vorname. + * + * @return Returns the vorname + */ public final String getVorname() { return this.vornameProperty().get(); } + /** + * + * Setter for vorname. + * + * @param vorname + */ public final void setVorname(final String vorname) { this.vornameProperty().set(vorname); } + /** + * + * Getter for the property nachname. + * + * @return Returns the property nachname + */ public final StringProperty nachnameProperty() { return this.nachname; } + /** + * + * Getter for nachname. + * + * @return Returns the nachname + */ public final String getNachname() { return this.nachnameProperty().get(); } + /** + * + * Setter for nachname. + * + * @param nachname + */ public final void setNachname(final String nachname) { this.nachnameProperty().set(nachname); } + /** + * + * Getter for the property matrikelnummer. + * + * @return Returns the property matrikelnummer + */ public final IntegerProperty matrikelnummerProperty() { return this.matrikelnummer; } + /** + * + * Getter for matrikelnummer. + * + * @return Returns the matrikelnummer + */ public final int getMatrikelnummer() { return this.matrikelnummerProperty().get(); } + /** + * + * Setter for matrikelnummer. + * + * @param matrikelnummer + */ public final void setMatrikelnummer(final int matrikelnummer) { this.matrikelnummerProperty().set(matrikelnummer); } + /** + * + * Set the Projekt to Student. + * + * @param projekt + */ public void setProjekt(Projekt projekt) { this.projekt = projekt; } + /** + * + * Getter for Projekt. + * + * @return Returns the Projekt of the student + */ public Projekt getProjekt() { return this.projekt; diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerHinzufuegenController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerHinzufuegenController.java index fa2afd8..6730468 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerHinzufuegenController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerHinzufuegenController.java @@ -12,6 +12,12 @@ import javafx.scene.control.TextField; import javafx.scene.layout.AnchorPane; import javafx.util.Pair; +/** + * The controller for the FXML-View AnsprechpartnerHinzufuegen. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class AnsprechpartnerHinzufuegenController extends Dialog<Pair<String, String>> { diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerListeController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerListeController.java index 1c9c8d5..4aee813 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerListeController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerListeController.java @@ -60,7 +60,7 @@ public class AnsprechpartnerListeController private Main main; /** - * TODO Add method comment here + * After the FXML was loaded the controller call the initialize function. * */ @FXML @@ -151,7 +151,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Set a back reference to the Main. * * @param main */ @@ -167,7 +167,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Open a TextInputStage to add an new Organization. * */ @FXML @@ -193,7 +193,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Open a TextInputDialog to edit the Organization. * */ @FXML @@ -221,7 +221,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Delete the selected Organization. * */ @FXML @@ -262,7 +262,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Deletes the selected Ansprechpartner. * */ @FXML @@ -279,7 +279,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Open a Stage to add a new Ansprechpartner. * */ @FXML diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/KommentarHinzufuegenController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/KommentarHinzufuegenController.java index a88a6af..806fd8b 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/KommentarHinzufuegenController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/KommentarHinzufuegenController.java @@ -10,6 +10,12 @@ import javafx.scene.control.Dialog; import javafx.scene.control.TextArea; import javafx.scene.layout.AnchorPane; +/** + * The controller for the FXML-View Kommentarhinzufuegen. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class KommentarHinzufuegenController extends Dialog<String> { @FXML diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektHinzufuegenController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektHinzufuegenController.java index 0e21ecd..cd0c673 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektHinzufuegenController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektHinzufuegenController.java @@ -11,6 +11,12 @@ import javafx.scene.control.TextArea; import javafx.scene.control.TextField; import javafx.stage.Stage; +/** + * The controller for the FXML-View ProjektHinzufuegen. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class ProjektHinzufuegenController { @FXML @@ -49,6 +55,13 @@ public class ProjektHinzufuegenController private boolean wasAborted = true; + /** + * + * Set back reference of the Main. + * + * @param main + * @param projekt + */ public void setMain(Main main, Projekt projekt) { this.projekt = projekt; @@ -134,6 +147,12 @@ public class ProjektHinzufuegenController } } + /** + * + * Getter for the projekt. + * + * @return Returns the projekt + */ public Projekt getProjekt() { if (wasAborted) @@ -143,6 +162,12 @@ public class ProjektHinzufuegenController return projekt; } + /** + * + * Set the Text of the Fields from the stage into the TableView and close + * the projekthinzufuegen stage. + * + */ @FXML private void handleSave() { @@ -163,6 +188,11 @@ public class ProjektHinzufuegenController projekthinzufuegenStage.close(); } + /** + * + * Cancel the projekthinzufuegen stage. + * + */ @FXML private void handleCancel() { diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektthemenverwaltungsController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektthemenverwaltungsController.java index 764563b..e3b0b17 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektthemenverwaltungsController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektthemenverwaltungsController.java @@ -16,6 +16,12 @@ import javafx.scene.control.TableColumn; import javafx.scene.control.TableView; import javafx.scene.control.cell.ComboBoxTableCell; +/** + * The controller for the FXML-View Projektthemenverwaltung. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class ProjektthemenverwaltungsController { @FXML @@ -55,6 +61,10 @@ public class ProjektthemenverwaltungsController private FilteredList<Projekt> filterList; + /** + * After the FXML was loaded the controller call the initialize function. + * + */ @FXML private void initialize() { @@ -161,6 +171,12 @@ public class ProjektthemenverwaltungsController .bind(deleteProjektButton.disabledProperty()); } + /** + * + * Set back reference of the Main. + * + * @param main + */ public void setMain(Main main) { this.main = main; @@ -174,12 +190,22 @@ public class ProjektthemenverwaltungsController projektTableView.setItems(sortedList); } + /** + * + * The filter is off. Show all projects. + * + */ @FXML private void handleShowAll() { filterList.setPredicate(null); } + /** + * + * Filter projects according to status "IN_BEARBEITUNG". + * + */ @FXML private void handleShowInBearbeitung() { @@ -187,6 +213,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.IN_BEARBEITUNG)); } + /** + * + * Filter projects according to status "EINGEREICHT". + * + */ @FXML private void handleShowEingereicht() { @@ -194,6 +225,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.EINGEREICHT)); } + /** + * + * Filter projects according to status "IN_UEBERARBEITUNG". + * + */ @FXML private void handleShowInUeberabeitung() { @@ -201,6 +237,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.IN_UEBERARBEITUNG)); } + /** + * + * Filter projects according to status "ANGENOMMEN". + * + */ @FXML private void handleShowAngenommen() { @@ -208,6 +249,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.ANGENOMMEN)); } + /** + * + * Filter projects according to status "ABGELEHNT". + * + */ @FXML private void handleShowAbgelehnt() { @@ -215,6 +261,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.ABGELEHNT)); } + /** + * + * Open the ProjekthinzufuegenStage to add a new Projekt. + * + */ @FXML private void handleAddProjekt() { @@ -226,6 +277,11 @@ public class ProjektthemenverwaltungsController } } + /** + * + * Open the ProjekthinzufuegenStage to edit a Projekt. + * + */ @FXML private void handleEditProjekt() { @@ -239,6 +295,11 @@ public class ProjektthemenverwaltungsController } } + /** + * + * Delete the selected Projekt. + * + */ @FXML private void handleDeleteProjekt() { @@ -251,18 +312,33 @@ public class ProjektthemenverwaltungsController } } + /** + * + * Open Stage of Studentenverwaltung. + * + */ @FXML private void handleStudentenverwaltung() { main.showStudentenverwaltung(); } + /** + * + * Open Stage of Ansprechpartnerverwaltung. + * + */ @FXML private void handleAnsprechpartnerverwaltungs() { main.showAnsprechpartnerverwaltungsStage(); } + /** + * + * Cancel the Projekttehmenverwaltung stage. + * + */ @FXML private void handleClose() { diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/StudentenverwaltungsController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/StudentenverwaltungsController.java index b1d5dbf..5950b0a 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/StudentenverwaltungsController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/StudentenverwaltungsController.java @@ -14,6 +14,12 @@ import javafx.scene.control.TextInputDialog; import javafx.scene.control.cell.TextFieldTableCell; import javafx.util.converter.IntegerStringConverter; +/** + * The controller for the FXML-View Studentenverwaltung. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class StudentenverwaltungsController { @FXML @@ -33,6 +39,10 @@ public class StudentenverwaltungsController private Main main; + /** + * After the FXML was loaded the controller call the initialize function. + * + */ @FXML private void initialize() { @@ -69,12 +79,23 @@ public class StudentenverwaltungsController .getSelectionModel().selectedItemProperty().isNull()); } + /** + * + * Set back reference of the Main. + * + * @param main + */ public void setMain(Main main) { this.main = main; studentTableView.setItems(main.getStudenten()); } + /** + * + * Open the StudenthinzufuegenStage to add a new Student. + * + */ @FXML private void handleAddStudent() { @@ -111,6 +132,11 @@ public class StudentenverwaltungsController } } + /** + * + * Delete the selected Student. + * + */ @FXML private void handleDeleteStudent() { |