Changeset 1040 for trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/evaluation/rule/evaluator/TextInputEntryRepetitionsEvaluator.java

Timestamp:

01/16/13 17:51:51 (11 years ago)

Author:

adeicke

Message:

• Removed lombok related annotations and util class
• Added comments and formating due to match project defaults

File:

• trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/evaluation/rule/evaluator/TextInputEntryRepetitionsEvaluator.java (modified) (4 diffs)

trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/evaluation/rule/evaluator/TextInputEntryRepetitionsEvaluator.java

@@ +1 @@
+//   Copyright 2012 Georg-August-Universität Göttingen, Germany
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
 package de.ugoe.cs.autoquest.usability.evaluation.rule.evaluator;
 
 import static de.ugoe.cs.autoquest.usability.tasktree.filter.EventTypeFilter.TEXT_INPUT;
 import static de.ugoe.cs.autoquest.usability.util.TextInputUtil.aggregateEnteredTextFromTextInputs;
+import static java.lang.String.format;
 
 import com.google.common.base.Optional;
@@ -16 +31 @@
 import de.ugoe.cs.autoquest.usability.tasktree.filter.TaskTreeFilter;
 
+/**
+ * <p>
+ * TODO comment
+ * </p>
+ * 
+ * @author Alexander Deicke
+ */
 public class TextInputEntryRepetitionsEvaluator extends RuleEvaluator {
 
-    public TextInputEntryRepetitionsEvaluator(UsabilityRule evaluatedUsabilityRule, ITaskTree taskTree) {
+    public TextInputEntryRepetitionsEvaluator(UsabilityRule evaluatedUsabilityRule,
+                                              ITaskTree taskTree)
+    {
         super(evaluatedUsabilityRule, taskTree);
     }
@@ -25 +49 @@
     protected FilterStatistic nodesUnderEvaluation(ITaskTree taskTree) {
         Optional<FilterStatistic> cachedNodes = loadFromCache(TEXT_INPUT);
-        return cachedNodes.isPresent() ? cachedNodes.get() : cacheAndReturnNodes(taskTree, TEXT_INPUT);
+        return cachedNodes.isPresent() ? cachedNodes.get() : cacheAndReturnNodes(taskTree,
+                                                                                 TEXT_INPUT);
     }
-    
+
     @Override
     protected FilterStatistic extractNodesFromTaskTree(ITaskTree taskTree) {
-        return new TaskTreeFilter(new IterativeDFSFilterStrategy())
-            .filterByEventType(TEXT_INPUT).from(taskTree);
+        return new TaskTreeFilter(new IterativeDFSFilterStrategy()).filterByEventType(TEXT_INPUT)
+            .from(taskTree);
     }
 
     @Override
     protected float calculateEvaluationMetric() {
-        Multiset<String> enteredTextFragments = aggregateEnteredTextFromTextInputs(this.filteredNodes.nodesMatchedFilter());
-        Multiset<String> orderedTextFragmentsWithMultipleOccurences = onlyTextFragmentsWithMultipleOccurences(enteredTextFragments);
-        if(orderedTextFragmentsWithMultipleOccurences.isEmpty()) return 0;
-        String wordWithHighestRepetitionInTextFragments = orderedTextFragmentsWithMultipleOccurences.iterator().next();
+        Multiset<String> enteredTextFragments =
+            aggregateEnteredTextFromTextInputs(this.filteredNodes.nodesMatchedFilter());
+        Multiset<String> orderedTextFragmentsWithMultipleOccurences =
+            onlyTextFragmentsWithMultipleOccurences(enteredTextFragments);
+        if (orderedTextFragmentsWithMultipleOccurences.isEmpty())
+            return 0;
+        String wordWithHighestRepetitionInTextFragments =
+            orderedTextFragmentsWithMultipleOccurences.iterator().next();
         int numberOfRepeatedWords = orderedTextFragmentsWithMultipleOccurences.entrySet().size();
-        int maxRepetitions = orderedTextFragmentsWithMultipleOccurences.count(wordWithHighestRepetitionInTextFragments);
+        int maxRepetitions =
+            orderedTextFragmentsWithMultipleOccurences
+                .count(wordWithHighestRepetitionInTextFragments);
+        storeEvaluationMetricForDefectDescription("textRepetitionRatio",
+                                                  format("textRepetitionRatio %s repeated tokens, up to %s repetitions per token",
+                                                         numberOfRepeatedWords, maxRepetitions));
         return Math.max(numberOfRepeatedWords, maxRepetitions);
     }
-    
-    private Multiset<String> onlyTextFragmentsWithMultipleOccurences(final Multiset<String> allTextInputs) {
-        return Multisets.copyHighestCountFirst(Multisets.filter(allTextInputs, new Predicate<String>() {
-            
-            @Override
-            public boolean apply(String word) {
-                return allTextInputs.count(word) > 1;
-            }
-            
-        }));
+
+    private Multiset<String> onlyTextFragmentsWithMultipleOccurences(final Multiset<String> allTextInputs)
+    {
+        return Multisets.copyHighestCountFirst(Multisets.filter(allTextInputs,
+                                                                new Predicate<String>() {
+
+                                                                    @Override
+                                                                    public boolean apply(String word)
+                                                                    {
+                                                                        return allTextInputs
+                                                                            .count(word) > 1;
+                                                                    }
+
+                                                                }));
     }
 
     @Override
-    protected Optional<UsabilityDefectSeverityLevel> determineSeverityLevel(float evaluationMetric) {
+    protected Optional<UsabilityDefectSeverityLevel> determineSeverityLevel(float evaluationMetric)
+    {
         Optional<UsabilityDefectSeverityLevel> recommendationSeverityLevel = Optional.absent();
         if (evaluationMetric > 10) {
@@ -73 +112 @@
         return recommendationSeverityLevel;
     }
-    
+
 }