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

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

@@ -15 +15 @@
 package de.ugoe.cs.autoquest.usability.rules.metrics;
 
-import static de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter.TEXT_INPUT;
+import static de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter.TEXT_INPUT;
 import static de.ugoe.cs.autoquest.usability.util.TextInputUtil.aggregateEnteredTextFromTextInputs;
-import static de.ugoe.cs.autoquest.usability.util.TextInputUtil.characterIsLetterOrDigitPredicate;
+import static de.ugoe.cs.autoquest.usability.util.TextInputUtil.characterIsNoLetterOrDigitPredicate;
 
 import java.util.List;
@@ -28 +28 @@
 import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel;
 import de.ugoe.cs.autoquest.usability.EvaluationMethodCaller;
-import de.ugoe.cs.autoquest.usability.result.DefectDescriptionResolver;
-import de.ugoe.cs.autoquest.usability.result.UsabilityDefect;
+import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescriptionResolver;
+import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription;
 import de.ugoe.cs.autoquest.usability.rules.UsabilityMetric;
 import de.ugoe.cs.autoquest.usability.rules.UsabilityRule;
-import de.ugoe.cs.autoquest.usability.tasktree.FilterResult;
-import de.ugoe.cs.autoquest.usability.tasktree.IterativeDFSFilterStrategy;
-import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskModelFilter;
+import de.ugoe.cs.autoquest.usability.taskmodel.filter.FilterResult;
+import de.ugoe.cs.autoquest.usability.taskmodel.filter.IterativeDFSFilterStrategy;
+import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskModelFilter;
 
 /**
  * <p>
- * TODO comment
+ * Metric, which calculates the ratio ratio between non letter or digit characters and all entered
+ * characters.
  * </p>
  * 
@@ -47 +48 @@
     /**
      * <p>
-     * TODO: comment
+     * Constructor. Creates a new {@code NoLetterOrDigitRatioMetric} for a given task model.
      * </p>
-     *
-     * @param taskTree
+     * 
+     * @param taskModel
      */
     public NoLetterOrDigitRatioMetric(ITaskModel taskModel) {
         super(taskModel);
         this.name = "NoLetterOrDigitRatio";
-        this.defect = new DefectDescriptionResolver().descriptionFor(this.getClass().getSimpleName());
+        this.defect =
+            new UsabilityProblemDescriptionResolver().descriptionFor(this.getClass()
+                .getSimpleName());
     }
 
-    /* (non-Javadoc)
+    /*
+     * (non-Javadoc)
+     * 
      * @see de.ugoe.cs.autoquest.usability.rules.UsabilityRule#check()
      */
     @Override
-    public Optional<UsabilityDefect> calculate() {
+    public Optional<UsabilityProblemDescription> calculate() {
         FilterResult textInputEvents = extractNodesFromTaskTree();
         float evaluationMetric = calculateEvaluationMetric(textInputEvents.tasksMatchedFilter());
         return this.defect.isPresent(evaluationMetric);
     }
-    
+
+    /**
+     * 
+     * <p>
+     * Filters all text input events from task model.
+     * </p>
+     * 
+     * @return {@code FilterResult}
+     */
     private FilterResult extractNodesFromTaskTree() {
         return new TaskModelFilter(new IterativeDFSFilterStrategy()).filterByEventType(TEXT_INPUT)
             .from(this.taskModel);
     }
-    
+
+    /**
+     * 
+     * <p>
+     * Calculates the metric.
+     * </p>
+     * 
+     * @param textInputEvents
+     *            all text input events
+     * @return ratio between non letter or digit characters and all entered characters
+     */
     private float calculateEvaluationMetric(List<ITask> textInputEvents) {
-        Multiset<String> enteredTextFragments =
-            aggregateEnteredTextFromTextInputs(textInputEvents);
+        Multiset<String> enteredTextFragments = aggregateEnteredTextFromTextInputs(textInputEvents);
         int allCharactersCount = 0;
         int noLetterOrDigitCount = 0;
@@ -82 +104 @@
             allCharactersCount += CharMatcher.ANY.countIn(textFragment) * occurencesOfTextFragment;
             noLetterOrDigitCount +=
-                CharMatcher.forPredicate(characterIsLetterOrDigitPredicate()).countIn(textFragment) *
-                    occurencesOfTextFragment;
+                CharMatcher.forPredicate(characterIsNoLetterOrDigitPredicate())
+                    .countIn(textFragment) * occurencesOfTextFragment;
         }
         return allCharactersCount != 0 ? (float) noLetterOrDigitCount / (float) allCharactersCount
@@ -89 +111 @@
     }
 
-    /* (non-Javadoc)
-     * @see de.ugoe.cs.autoquest.usability.rules.UsabilityRule#callEvaluationMetho(de.ugoe.cs.autoquest.usability.EvaluationMethodCaller)
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * de.ugoe.cs.autoquest.usability.rules.UsabilityRule#callEvaluationMetho(de.ugoe.cs.autoquest
+     * .usability.EvaluationMethodCaller)
      */
     @Override
-    public Optional<UsabilityDefect> callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller)
+    public Optional<UsabilityProblemDescription> callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller)
     {
         return evaluationMethodCaller.check(this);