summaryrefslogtreecommitdiffstats
path: root/src/de/fhswf/in/inf/se/notepadMinusMinus/model
diff options
context:
space:
mode:
Diffstat (limited to 'src/de/fhswf/in/inf/se/notepadMinusMinus/model')
-rw-r--r--src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java74
-rw-r--r--src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java40
2 files changed, 63 insertions, 51 deletions
diff --git a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java
index 9758e6a..4c8a406 100644
--- a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java
+++ b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grade.java
@@ -12,6 +12,7 @@ import javax.xml.bind.annotation.XmlValue;
import javafx.beans.Observable;
import javafx.beans.property.IntegerProperty;
import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.Property;
import javafx.beans.property.SimpleIntegerProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.property.SimpleStringProperty;
@@ -21,10 +22,10 @@ import javafx.collections.ObservableList;
import javafx.util.Callback;
/**
- * TODO Add comment here
+ * A grade with module information.
*
- * @author $Author: $
- * @version $Revision: $, $Date: $ UTC
+ * @author Stefan Suhren
+ * @version 1.0
*/
@XmlRootElement(name = "grade")
public class Grade
@@ -44,9 +45,10 @@ public class Grade
private IntegerProperty attempt = new SimpleIntegerProperty(1);
/**
- * TODO Add method comment here
+ * Generates an extractor that fires when a property of a list value
+ * changes.
*
- * @return
+ * @return The extractor.
*/
public static Callback<Grade, Observable[]> extractor()
{
@@ -56,9 +58,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the semester {@link Property}.
*
- * @return
+ * @return The semester {@link Property}.
*/
public final IntegerProperty semesterProperty()
{
@@ -66,9 +68,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the semester.
*
- * @return
+ * @return The semester.
*/
@XmlAttribute(name = "semester")
public final int getSemester()
@@ -77,9 +79,10 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Set the semester.
*
* @param semester
+ * The new semester.
*/
public final void setSemester(final int semester)
{
@@ -87,9 +90,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the modulename {@link Property}.
*
- * @return
+ * @return The modulename {@link Property}.
*/
public final StringProperty modulenameProperty()
{
@@ -97,9 +100,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the modulename.
*
- * @return
+ * @return The modulename.
*/
@XmlAttribute(name = "modulename", required = true)
public final String getModulename()
@@ -108,19 +111,20 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Set the modulename.
*
* @param modulename
+ * The new modulename.
*/
- public final void setModulename(final java.lang.String modulename)
+ public final void setModulename(final String modulename)
{
this.modulenameProperty().set(modulename);
}
/**
- * TODO Add method comment here
+ * Get the ects {@link Property}.
*
- * @return
+ * @return The ects {@link Property}.
*/
public final IntegerProperty ectsProperty()
{
@@ -128,9 +132,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the ects.
*
- * @return
+ * @return The ects.
*/
@XmlAttribute(name = "ects")
public final int getEcts()
@@ -139,9 +143,10 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Set the ects.
*
* @param ects
+ * The new ects.
*/
public final void setEcts(final int ects)
{
@@ -149,9 +154,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the grade {@link Property}.
*
- * @return
+ * @return The grade {@link Property}.
*/
public final ObjectProperty<BigDecimal> gradeProperty()
{
@@ -159,9 +164,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the grade.
*
- * @return
+ * @return The grade.
*/
@XmlValue
public final BigDecimal getGrade()
@@ -170,9 +175,10 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Set the grade.
*
* @param grade
+ * The new grade.
*/
public final void setGrade(final BigDecimal grade)
{
@@ -180,9 +186,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the attempt {@link Property}.
*
- * @return
+ * @return The attempt {@link Property}.
*/
public final IntegerProperty attemptProperty()
{
@@ -190,9 +196,9 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Get the attempt.
*
- * @return
+ * @return The attempt.
*/
@XmlAttribute(name = "attempt")
public final int getAttempt()
@@ -201,9 +207,10 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Set the attempt.
*
* @param attempt
+ * The new attempt.
*/
public final void setAttempt(final int attempt)
{
@@ -211,9 +218,10 @@ public class Grade
}
/**
- * TODO Add method comment here
+ * Returns an unmodifiable {@link ObservableList} that contains all valid
+ * grades.
*
- * @return
+ * @return The unmodifiable {@link ObservableList}.
*/
public static final ObservableList<BigDecimal> gradeValuesProperty()
{
diff --git a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java
index aafc1e6..18622cd 100644
--- a/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java
+++ b/src/de/fhswf/in/inf/se/notepadMinusMinus/model/Grades.java
@@ -8,15 +8,16 @@ import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.Property;
import javafx.beans.property.SimpleObjectProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
/**
- * TODO Add comment here
+ * The wrapper for the gradeList.
*
- * @author $Author: $
- * @version $Revision: $, $Date: $ UTC
+ * @author Stefan Suhren
+ * @version 1.0
*/
@XmlRootElement(name = "grades")
public class Grades
@@ -31,9 +32,9 @@ public class Grades
new BigDecimal("0.0"));
/**
- * TODO Add method comment here
+ * Get the {@link Grades} as a {@link List}.
*
- * @return
+ * @return The {@link List} of {@link Grade}s.
*/
@XmlElement(name = "grade", required = true)
public List<Grade> getGrades()
@@ -42,9 +43,10 @@ public class Grades
}
/**
- * TODO Add method comment here
+ * Set the {@link Grades} as {@link List}.
*
* @param grades
+ * The {@link List} of {@link Grade}s to set.
*/
public void setGrades(List<Grade> grades)
{
@@ -53,9 +55,9 @@ public class Grades
}
/**
- * TODO Add method comment here
+ * Get the {@link ObservableList} of {@link Grade}s.
*
- * @return
+ * @return The {@link ObservableList}
*/
public ObservableList<Grade> gradesProperty()
{
@@ -63,9 +65,9 @@ public class Grades
}
/**
- * TODO Add method comment here
+ * Get the thesis grade {@link Property}.
*
- * @return
+ * @return The {@link Property} grade of the thesis.
*/
public final ObjectProperty<BigDecimal> thesisProperty()
{
@@ -73,9 +75,9 @@ public class Grades
}
/**
- * TODO Add method comment here
+ * Set the grade of the thesis.
*
- * @return
+ * @return The grade of the thesis.
*/
@XmlAttribute(name = "thesis")
public final BigDecimal getThesis()
@@ -84,9 +86,10 @@ public class Grades
}
/**
- * TODO Add method comment here
+ * Set the grade of the thesis.
*
* @param thesis
+ * The new grade of the thesis.
*/
public final void setThesis(final BigDecimal thesis)
{
@@ -94,9 +97,9 @@ public class Grades
}
/**
- * TODO Add method comment here
+ * Get the colloquium grade {@link Property}.
*
- * @return
+ * @return The colloquium grade {@link Property}.
*/
public final ObjectProperty<BigDecimal> colloquiumProperty()
{
@@ -104,9 +107,9 @@ public class Grades
}
/**
- * TODO Add method comment here
+ * Get the colloquium grade.
*
- * @return
+ * @return The colloquium grade.
*/
@XmlAttribute(name = "colloquium")
public final BigDecimal getColloquium()
@@ -115,9 +118,10 @@ public class Grades
}
/**
- * TODO Add method comment here
+ * Set the colloquium grade.
*
* @param colloquium
+ * The new colloquium grade.
*/
public final void setColloquium(final BigDecimal colloquium)
{