Changeset 1217 for trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityEvaluator.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/UsabilityEvaluator.java (modified) (4 diffs)

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

@@ -20 +20 @@
 
 import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel;
-import de.ugoe.cs.autoquest.usability.result.UsabilityDefect;
+import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription;
 import de.ugoe.cs.autoquest.usability.rules.UsabilityResult;
 import de.ugoe.cs.autoquest.usability.rules.UsabilityRule;
@@ -28 +28 @@
 /**
  * <p>
- * TODO comment
+ * The usability evaluator is responsible for performing a usability evaluation on a task model.
+ * Therefore he uses a {@link UsabilityRuleset}.
  * </p>
  * 
@@ -34 +35 @@
  */
 public class UsabilityEvaluator {
-    
+
+    /**
+     * <p>
+     * The task model, which should be evaluated.
+     * </p>
+     */
     private ITaskModel taskModel;
 
-    private UsabilityEvaluator(ITaskModel taskTree) {
-        this.taskModel = taskTree;
-    }
-    
-    /**
-     * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @param taskTree
-     * @return
-     */
-    public static UsabilityEvaluator evaluate(ITaskModel taskTree) {
-        return new UsabilityEvaluator(taskTree);
+    private UsabilityEvaluator(ITaskModel taskModel) {
+        this.taskModel = taskModel;
     }
 
     /**
      * <p>
-     * TODO: comment
+     * Creates and initializes a new instance.
      * </p>
-     *
-     * @param object
-     * @return
+     * 
+     * @param taskModel
+     *            task model, which is subject of usability evaluation
+     * @return instance of {@link UsabilityEvaluator}
+     */
+    public static UsabilityEvaluator evaluate(ITaskModel taskModel) {
+        return new UsabilityEvaluator(taskModel);
+    }
+
+    /**
+     * <p>
+     * Starts usability evaluation, using given {@link UsabilityRuleset}.
+     * </p>
+     * 
+     * @param ruleset
+     *            {@link UsabilityRuleset} used for usability evaluation
+     * @return result of usability evaluation as {@link UsabilityResult}
      */
     public UsabilityResult using(UsabilityRuleset ruleset) {
@@ -65 +73 @@
         EvaluationMethodCaller evaluationMethodCaller = new EvaluationMethodCaller();
         UsabilityResult result = new UsabilityResult();
-        for(UsabilityRule rule : ruleset.evaluationRules()) {
-            Optional<UsabilityDefect> defect = rule.callEvaluationMethod(evaluationMethodCaller);
-            if(defect.isPresent()) {
-                result.addDefect(defect.get());
+        for (UsabilityRule rule : ruleset.evaluationRules()) {
+            Optional<UsabilityProblemDescription> defect =
+                rule.callEvaluationMethod(evaluationMethodCaller);
+            if (defect.isPresent()) {
+                result.addProblem(defect.get());
             }
         }