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

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

@@ -19 +19 @@
 import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel;
 import de.ugoe.cs.autoquest.usability.EvaluationMethodCaller;
-import de.ugoe.cs.autoquest.usability.result.UsabilityDefect;
+import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription;
 
 /**
  * <p>
- * TODO comment
+ * A {@code UsabilityRule} is a abstract class, representing a usability guideline, metric
+ * interaction pattern etc., which should be checked during a automatic usability evaluation.
  * </p>
  * 
@@ -29 +30 @@
  */
 public abstract class UsabilityRule {
-    
-    protected final ITaskModel taskModel;
-    
-    protected String name;
-    
-    protected UsabilityDefect defect;
-    
+
     /**
      * <p>
-     * TODO: comment
+     * {@link ITaskModel}, which is evaluated
      * </p>
-     *
+     */
+    protected final ITaskModel taskModel;
+
+    /**
+     * <p>
+     * Name of the usability rule
+     * </p>
+     */
+    protected String name;
+
+    /**
+     * <p>
+     * Corresponding defect description.
+     * </p>
+     */
+    protected UsabilityProblemDescription defect;
+
+    /**
+     * <p>
+     * Constructor. Creates a new {@code UsabilityRule} for a given task model
+     * </p>
+     * 
      */
     public UsabilityRule(ITaskModel taskModel) {
         this.taskModel = taskModel;
     }
-    
-    public abstract Optional<UsabilityDefect> callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller);
+
+    /**
+     * 
+     * <p>
+     * Calls the evaluation method of this {@code UsabilityRule}.
+     * </p>
+     * 
+     * @param evaluationMethodCaller
+     *            helper class, which calls the evaluation method based on the type of the
+     *            {@code UsabilityRule}
+     * @return {@link UsabilityProblemDescription}, iff violation against usability rule was detected
+     */
+    public abstract Optional<UsabilityProblemDescription> callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller);
 
 }