[1493] | 1 | // Copyright 2012 Georg-August-Universität Göttingen, Germany |
---|
| 2 | // |
---|
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
---|
| 4 | // you may not use this file except in compliance with the License. |
---|
| 5 | // You may obtain a copy of the License at |
---|
| 6 | // |
---|
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
---|
| 8 | // |
---|
| 9 | // Unless required by applicable law or agreed to in writing, software |
---|
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
---|
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
| 12 | // See the License for the specific language governing permissions and |
---|
| 13 | // limitations under the License. |
---|
| 14 | |
---|
| 15 | package de.ugoe.cs.autoquest.usability; |
---|
| 16 | |
---|
| 17 | import java.util.HashMap; |
---|
| 18 | import java.util.List; |
---|
| 19 | import java.util.Map; |
---|
| 20 | |
---|
| 21 | import de.ugoe.cs.autoquest.eventcore.gui.Scroll; |
---|
| 22 | import de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask; |
---|
| 23 | import de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTaskInstance; |
---|
| 24 | import de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration; |
---|
| 25 | import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence; |
---|
| 26 | import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; |
---|
| 27 | import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo; |
---|
| 28 | import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; |
---|
| 29 | import de.ugoe.cs.autoquest.tasktrees.treeifc.TaskMetric; |
---|
| 30 | |
---|
| 31 | /** |
---|
| 32 | * TODO comment |
---|
| 33 | * |
---|
| 34 | * @version $Revision: $ $Date: 16.07.2012$ |
---|
| 35 | * @author 2012, last modified by $Author: pharms$ |
---|
| 36 | */ |
---|
| 37 | public class TaskCooccurrenceRule implements UsabilityEvaluationRule { |
---|
| 38 | |
---|
| 39 | /* |
---|
| 40 | * (non-Javadoc) |
---|
| 41 | * |
---|
| 42 | * @see de.ugoe.cs.usability.UsabilityEvaluationRule#evaluate(TaskTree) |
---|
| 43 | */ |
---|
| 44 | @Override |
---|
| 45 | public UsabilityEvaluationResult evaluate(ITaskModel taskModel) { |
---|
| 46 | UsabilityEvaluationResult results = new UsabilityEvaluationResult(taskModel); |
---|
| 47 | |
---|
| 48 | checkForCooccurrences(results, taskModel); |
---|
| 49 | |
---|
| 50 | return results; |
---|
| 51 | } |
---|
| 52 | |
---|
| 53 | /** |
---|
| 54 | * |
---|
| 55 | */ |
---|
| 56 | private void checkForCooccurrences(UsabilityEvaluationResult results, ITaskModel taskModel) { |
---|
| 57 | for (ITask task : taskModel.getTasks()) { |
---|
| 58 | // only sequences are important for task cooccurrences |
---|
| 59 | if (task instanceof ISequence) { |
---|
| 60 | ISequence sequence = (ISequence) task; |
---|
| 61 | int index1 = 0; |
---|
| 62 | int index2 = 1; |
---|
| 63 | List<ITask> children = sequence.getChildren(); |
---|
[1918] | 64 | ITaskInfo infoSequence = taskModel.getTaskInfo(sequence); |
---|
| 65 | int countSequence = infoSequence.getMeasureValue(TaskMetric.COUNT); |
---|
[1493] | 66 | |
---|
| 67 | while (index2 < children.size()) { |
---|
| 68 | ITask task1 = children.get(index1); |
---|
| 69 | ITask task2 = children.get(index2); |
---|
| 70 | ITaskInfo info1 = taskModel.getTaskInfo(task1); |
---|
| 71 | ITaskInfo info2 = taskModel.getTaskInfo(task2); |
---|
| 72 | |
---|
[1918] | 73 | int ratioTask1 = 1000 * countSequence / info1.getMeasureValue(TaskMetric.COUNT); |
---|
| 74 | int ratioTask2 = 1000 * countSequence / info2.getMeasureValue(TaskMetric.COUNT); |
---|
[1493] | 75 | |
---|
[1918] | 76 | createSucceededSmellIfRequired(ratioTask1, task1, task2, results, taskModel); |
---|
| 77 | createPrecededSmellIfRequired(ratioTask2, task1, task2, results, taskModel); |
---|
[1493] | 78 | |
---|
| 79 | index1 = index2; |
---|
| 80 | index2++; |
---|
| 81 | } |
---|
| 82 | } |
---|
| 83 | } |
---|
| 84 | } |
---|
| 85 | |
---|
| 86 | /** |
---|
| 87 | * |
---|
| 88 | */ |
---|
[1918] | 89 | private void createSucceededSmellIfRequired(int ratio, |
---|
| 90 | ITask task1, |
---|
| 91 | ITask task2, |
---|
| 92 | UsabilityEvaluationResult results, |
---|
| 93 | ITaskModel taskModel) |
---|
[1493] | 94 | { |
---|
| 95 | //TODO document magic numbers |
---|
[1918] | 96 | UsabilitySmellIntensity severity = |
---|
| 97 | UsabilitySmellIntensity.getIntensity(ratio, task1, taskModel); |
---|
[1493] | 98 | |
---|
| 99 | if (!isScroll(task1) && !isScroll(task2) && (severity != null)) { |
---|
| 100 | Map<String, Object> parameters = new HashMap<String, Object>(); |
---|
| 101 | parameters.put("task1", task1); |
---|
| 102 | parameters.put("task2", task2); |
---|
| 103 | parameters.put("ratio", (ratio / 10)); |
---|
| 104 | |
---|
[1918] | 105 | results.addSmell |
---|
| 106 | (task1, severity, UsabilitySmellDescription.COOCCURENCE_SUCCEED, parameters); |
---|
[1493] | 107 | } |
---|
| 108 | } |
---|
| 109 | |
---|
| 110 | /** |
---|
| 111 | * |
---|
| 112 | */ |
---|
[1918] | 113 | private void createPrecededSmellIfRequired(int ratio, |
---|
| 114 | ITask task1, |
---|
| 115 | ITask task2, |
---|
| 116 | UsabilityEvaluationResult results, |
---|
| 117 | ITaskModel taskModel) |
---|
[1493] | 118 | { |
---|
| 119 | //TODO document magic numbers |
---|
[1918] | 120 | UsabilitySmellIntensity severity = |
---|
| 121 | UsabilitySmellIntensity.getIntensity(ratio, task2, taskModel); |
---|
[1493] | 122 | |
---|
| 123 | if (!isScroll(task1) && !isScroll(task2) && (severity != null)) { |
---|
| 124 | Map<String, Object> parameters = new HashMap<String, Object>(); |
---|
| 125 | parameters.put("task1", task1); |
---|
| 126 | parameters.put("task2", task2); |
---|
| 127 | parameters.put("ratio", (ratio / 10)); |
---|
| 128 | |
---|
[1918] | 129 | results.addSmell |
---|
| 130 | (task1, severity, UsabilitySmellDescription.COOCCURENCE_PRECED, parameters); |
---|
[1493] | 131 | } |
---|
| 132 | } |
---|
| 133 | |
---|
| 134 | /** |
---|
| 135 | * <p> |
---|
| 136 | * TODO: comment |
---|
| 137 | * </p> |
---|
| 138 | * |
---|
| 139 | * @param task1 |
---|
| 140 | * @return |
---|
| 141 | */ |
---|
| 142 | private boolean isScroll(ITask task) { |
---|
| 143 | if (task instanceof IEventTask) { |
---|
[1918] | 144 | return ((IEventTaskInstance) ((IEventTask) task).getInstances().iterator().next()) |
---|
| 145 | .getEvent().getType() instanceof Scroll; |
---|
[1493] | 146 | } |
---|
| 147 | else if (task instanceof IIteration) { |
---|
| 148 | return isScroll(((IIteration) task).getMarkedTask()); |
---|
| 149 | } |
---|
| 150 | |
---|
| 151 | return false; |
---|
| 152 | } |
---|
| 153 | } |
---|