Changeset 1217 for trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/EvaluationMethodCaller.java

Timestamp:

06/06/13 17:08:25 (11 years ago)

Author:

adeicke

Message:

• Added proper formating and JavaDoc?.
• Several renaming refactorings.

File:

• trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/EvaluationMethodCaller.java (modified) (2 diffs)

trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/EvaluationMethodCaller.java

@@ -17 +17 @@
 import com.google.common.base.Optional;
 
-import de.ugoe.cs.autoquest.usability.result.UsabilityDefect;
+import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription;
 import de.ugoe.cs.autoquest.usability.rules.UsabilityMetric;
-import de.ugoe.cs.autoquest.usability.rules.UsabilityUsageDefect;
+import de.ugoe.cs.autoquest.usability.rules.UsabilityUsageProblem;
 
 /**
  * <p>
- * TODO comment
+ * Helper class, which calls the evaluation method depending on the type of the usability rule.
  * </p>
  * 
@@ -29 +29 @@
  */
 public class EvaluationMethodCaller {
-    
-    public Optional<UsabilityDefect> check(UsabilityMetric metric) {
+
+    /**
+     * 
+     * <p>
+     * Calls evaluation method of a usability metric.
+     * </p>
+     * 
+     * @param metric
+     *            on which evaluation method should be called
+     * @return description of metric/defect, iff metric exceeds predefined threshold
+     */
+    public Optional<UsabilityProblemDescription> check(UsabilityMetric metric) {
         return metric.calculate();
     }
-    
-    public Optional<UsabilityDefect> check(UsabilityUsageDefect pattern) {
-        return pattern.check();
+
+    /**
+     * 
+     * <p>
+     * Calls evaluation method of a usability usage defect.
+     * </p>
+     * 
+     * @param usageDefect
+     *            on which evaluation method should be called
+     * @return description of usage defect, iff it was detected during the usability evaluation
+     */
+    public Optional<UsabilityProblemDescription> check(UsabilityUsageProblem usageDefect) {
+        return usageDefect.check();
     }
 }