Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/CMDperformUsabilityEvaluation.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/CMDperformUsabilityEvaluation.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/CMDperformUsabilityEvaluation.java (revision 1217) @@ -21,5 +21,5 @@ import de.ugoe.cs.autoquest.CommandHelpers; import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; -import de.ugoe.cs.autoquest.usability.rules.EmptyRuleset; +import de.ugoe.cs.autoquest.usability.rules.PatternRuleset; import de.ugoe.cs.autoquest.usability.rules.UsabilityResult; import de.ugoe.cs.autoquest.usability.rules.UsabilityRuleset; @@ -29,5 +29,5 @@ /** *

- * TODO comment + * Command to perform a automatic usability evaluation for a given task model. *

* @@ -36,13 +36,29 @@ public class CMDperformUsabilityEvaluation implements Command { + /** + *

+ * index for name of task model under which it could be retrieved from + * {@link GlobalDataContainer} + *

+ */ private final int taskModelParamaterIndex = 0; - + + /** + *

+ * index for name under which evaluation result should be stored in {@link GlobalDataContainer} + *

+ */ private final int evaluationResultParameterIndex = 1; - + + /** + *

+ * default name for evaluation result, which is used to store it in {@link GlobalDataContainer} + *

+ */ private final String defaultEvaluationResultParameterName = "usabilityEvaluationResult"; - - private final UsabilityRuleset defaultUsabilityRuleset = new EmptyRuleset(); - - /* (non-Javadoc) + + /* + * (non-Javadoc) + * * @see de.ugoe.cs.util.console.Command#run(java.util.List) */ @@ -52,24 +68,25 @@ Optional taskModel = getTaskModelFromDataContainer(nameOfTaskModel); if (taskModel.isPresent()) { - UsabilityRuleset ruleset = getUsabilityRuleset(); + UsabilityRuleset ruleset = new PatternRuleset(taskModel.get()); UsabilityResult result = UsabilityEvaluator.evaluate(taskModel.get()).using(ruleset); String evaluationResultParameterName = getEvaluationResultParameter(parameters); storeUsabilityResultInDataContainer(evaluationResultParameterName, result); } - return; } /** *

- * TODO: comment + * Gets name of task model from list of parameters. *

- * + * * @param parameters - * @return + * parameters for the command + * @return name of task model */ private String getTaskModelParameter(List parameters) { try { return (String) parameters.get(taskModelParamaterIndex); - } catch (Exception e) { + } + catch (Exception e) { throw new IllegalArgumentException("must provide a task model name"); } @@ -78,32 +95,37 @@ /** *

- * TODO: comment + * Gets name under which evaluation result should be stored in {@link GlobalDataContainer} from + * list of parameters. If not present, the default value {@code usabilityEvaluationResult} is + * used! *

- * + * * @param parameters - * @return + * parameters for the command + * @return name under which evaluation result should be stored */ private String getEvaluationResultParameter(List parameters) { - if(parameters.size() == 2) { + if (parameters.size() == 2) { return (String) parameters.get(evaluationResultParameterIndex); } return defaultEvaluationResultParameterName; } - + /** *

- * TODO: comment + * Retrieves task model from {@link GlobalDataContainer}. *

- * + * * @param nameOfTaskModel - * @return + * name of task model, under which it is stored in {@link GlobalDataContainer} + * @return if present, task model */ private Optional getTaskModelFromDataContainer(String nameOfTaskModel) { Object dataObject = GlobalDataContainer.getInstance().getData(nameOfTaskModel); - if(dataObject != null) { - if(dataObject instanceof ITaskModel) { + if (dataObject != null) { + if (dataObject instanceof ITaskModel) { ITaskModel taskModel = (ITaskModel) dataObject; return Optional.of(taskModel); - } else { + } + else { CommandHelpers.objectNotType(nameOfTaskModel, "ITaskModel"); return Optional.absent(); @@ -113,32 +135,25 @@ return Optional.absent(); } - + /** *

- * TODO: comment + * Stores usability evaluation in {@link GlobalDataContainer}. *

- * - * @return + * + * @param evaluationResultParameterName + * name under which usability result should be stored in {@link GlobalDataContainer} + * */ - private UsabilityRuleset getUsabilityRuleset() { - // TODO Auto-generated method stub - System.out.println("TODO: implement CMDperformUsabilityEvaluation.getUsabilityRuleset "); - return this.defaultUsabilityRuleset; - } - - /** - *

- * TODO: comment - *

- * @param evaluationResultParameterName - * - */ - private void storeUsabilityResultInDataContainer(String evaluationResultParameterName, UsabilityResult result) { + private void storeUsabilityResultInDataContainer(String evaluationResultParameterName, + UsabilityResult result) + { if (GlobalDataContainer.getInstance().addData(evaluationResultParameterName, result)) { CommandHelpers.dataOverwritten(evaluationResultParameterName); - } + } } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see de.ugoe.cs.util.console.Command#help() */ Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/EvaluationMethodCaller.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/EvaluationMethodCaller.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/EvaluationMethodCaller.java (revision 1217) @@ -17,11 +17,11 @@ import com.google.common.base.Optional; -import de.ugoe.cs.autoquest.usability.result.UsabilityDefect; +import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription; import de.ugoe.cs.autoquest.usability.rules.UsabilityMetric; -import de.ugoe.cs.autoquest.usability.rules.UsabilityUsageDefect; +import de.ugoe.cs.autoquest.usability.rules.UsabilityUsageProblem; /** *

- * TODO comment + * Helper class, which calls the evaluation method depending on the type of the usability rule. *

* @@ -29,11 +29,31 @@ */ public class EvaluationMethodCaller { - - public Optional check(UsabilityMetric metric) { + + /** + * + *

+ * Calls evaluation method of a usability metric. + *

+ * + * @param metric + * on which evaluation method should be called + * @return description of metric/defect, iff metric exceeds predefined threshold + */ + public Optional check(UsabilityMetric metric) { return metric.calculate(); } - - public Optional check(UsabilityUsageDefect pattern) { - return pattern.check(); + + /** + * + *

+ * Calls evaluation method of a usability usage defect. + *

+ * + * @param usageDefect + * on which evaluation method should be called + * @return description of usage defect, iff it was detected during the usability evaluation + */ + public Optional check(UsabilityUsageProblem usageDefect) { + return usageDefect.check(); } } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityEvaluator.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityEvaluator.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityEvaluator.java (revision 1217) @@ -20,5 +20,5 @@ 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,5 +28,6 @@ /** *

- * TODO comment + * The usability evaluator is responsible for performing a usability evaluation on a task model. + * Therefore he uses a {@link UsabilityRuleset}. *

* @@ -34,30 +35,37 @@ */ public class UsabilityEvaluator { - + + /** + *

+ * The task model, which should be evaluated. + *

+ */ private ITaskModel taskModel; - private UsabilityEvaluator(ITaskModel taskTree) { - this.taskModel = taskTree; - } - - /** - *

- * TODO: comment - *

- * - * @param taskTree - * @return - */ - public static UsabilityEvaluator evaluate(ITaskModel taskTree) { - return new UsabilityEvaluator(taskTree); + private UsabilityEvaluator(ITaskModel taskModel) { + this.taskModel = taskModel; } /** *

- * TODO: comment + * Creates and initializes a new instance. *

- * - * @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); + } + + /** + *

+ * Starts usability evaluation, using given {@link UsabilityRuleset}. + *

+ * + * @param ruleset + * {@link UsabilityRuleset} used for usability evaluation + * @return result of usability evaluation as {@link UsabilityResult} */ public UsabilityResult using(UsabilityRuleset ruleset) { @@ -65,8 +73,9 @@ EvaluationMethodCaller evaluationMethodCaller = new EvaluationMethodCaller(); UsabilityResult result = new UsabilityResult(); - for(UsabilityRule rule : ruleset.evaluationRules()) { - Optional defect = rule.callEvaluationMethod(evaluationMethodCaller); - if(defect.isPresent()) { - result.addDefect(defect.get()); + for (UsabilityRule rule : ruleset.evaluationRules()) { + Optional defect = + rule.callEvaluationMethod(evaluationMethodCaller); + if (defect.isPresent()) { + result.addProblem(defect.get()); } } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/DefectDescriptionResolver.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/DefectDescriptionResolver.java (revision 1213) +++ (revision ) @@ -1,208 +1,0 @@ -// 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.result; - -import java.io.File; -import java.io.IOException; -import java.net.URISyntaxException; -import java.util.EnumMap; -import java.util.Map; -import java.util.Map.Entry; - -import jodd.props.Props; - -import com.google.common.base.Optional; -import com.google.common.base.Predicate; -import com.google.common.collect.Iterables; -import com.google.common.collect.Maps; - -import de.ugoe.cs.util.console.Console; - -/** - *

- * TODO comment - *

- * - * @author Alexander Deicke - */ -public class DefectDescriptionResolver { - - private final String defectDescriptionFile = "defects.props"; - - /** - *

- * TODO: comment - *

- * - * @param name - * @return - */ - public UsabilityDefect descriptionFor(String usabilityRuleName) { - Props allProperties = initProperties(); - Map usabilityRuleProperties = - allUsabilityRuleProperties(allProperties, usabilityRuleName); - return createUsabilityDefect(usabilityRuleProperties); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - private Props initProperties() { - Optional defectDescriptionFile = getDefectDescriptionFile(); - Props props = new Props(); - props.setEscapeNewLineValue("\n"); - props.setValueTrimLeft(true); - if (defectDescriptionFile.isPresent()) { - loadProperties(defectDescriptionFile, props); - } - return props; - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - private Optional getDefectDescriptionFile() { - try { - return Optional.fromNullable(new File(ClassLoader - .getSystemResource(defectDescriptionFile).toURI())); - } - catch (URISyntaxException e) { - Console.printerr("Error while loading defect description file."); - Console.logException(e); - return Optional.absent(); - } - } - - private void loadProperties(Optional defectDescriptionFile, Props props) { - try { - props.load(defectDescriptionFile.get()); - } - catch (IOException e) { - Console.logException(e); - } - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - private Map allUsabilityRuleProperties(Props allProperties, - String usabilityRuleName) - { - Map usabilityRuleProperties = Maps.newHashMap(); - allProperties.extractSubProps(usabilityRuleProperties, usabilityRuleName + ".*"); - return usabilityRuleProperties; - } - - /** - *

- * TODO: comment - *

- * - * @param usabilityRuleProperties - * @return - */ - private UsabilityDefect createUsabilityDefect(Map usabilityRuleProperties) { - String description = - Iterables.getOnlyElement(Maps.filterKeys(usabilityRuleProperties, descriptionProperty()).values()); - EnumMap severity = - getSeverityMap(usabilityRuleProperties); - return new UsabilityDefect(description, severity); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - private Predicate descriptionProperty() { - return new Predicate() { - - public boolean apply(String key) { - return key.endsWith("description"); - } - - }; - } - - /** - *

- * TODO: comment - *

- * - * @param usabilityRuleProperties - * @return - */ - private EnumMap getSeverityMap(Map usabilityRuleProperties) - { - EnumMap severityMap = - Maps.newEnumMap(UsabilityDefectSeverityLevel.class); - Map allSeverityProperties = - Maps.filterEntries(usabilityRuleProperties, allSeverityProperties()); - for (Entry severityProperty : allSeverityProperties.entrySet()) { - UsabilityDefectSeverityLevel severityLevel = - getSeverityLevel(severityProperty.getKey()); - Double rule = Double.valueOf(severityProperty.getValue()); - severityMap.put(severityLevel, rule); - } - return severityMap; - } - - /** - *

- * TODO: comment - *

- * - * @param key - * @return - */ - private UsabilityDefectSeverityLevel getSeverityLevel(String severityProperty) { - int startSeverityLevel = severityProperty.lastIndexOf(".") + 1; - String severitLevelIdentifier = - severityProperty.substring(startSeverityLevel).toUpperCase(); - return UsabilityDefectSeverityLevel.valueOf(severitLevelIdentifier); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - private Predicate> allSeverityProperties() { - return new Predicate>() { - - public boolean apply(Map.Entry entry) { - return entry.getKey().contains("severity"); - } - - }; - } - -} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityDefect.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityDefect.java (revision 1213) +++ (revision ) @@ -1,121 +1,0 @@ -// 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.result; - -import java.util.Collections; -import java.util.EnumMap; -import java.util.Map; - -import com.google.common.base.Optional; -import com.google.common.base.Predicate; -import com.google.common.collect.BiMap; -import com.google.common.collect.HashBiMap; -import com.google.common.collect.Maps; - - -/** - *

- * TODO comment - *

- * - * @author Alexander Deicke - */ -public class UsabilityDefect { - - private UsabilityDefectSeverityLevel severityLevel = UsabilityDefectSeverityLevel.NONE; - - private String description; - - private final EnumMap severity; - - /** - *

- * TODO: comment - *

- * - * @param description - * @param severity - */ - public UsabilityDefect(String description, - EnumMap severity) - { - this.description = description; - this.severity = severity; - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - public UsabilityDefectSeverityLevel getSeverityLevel() { - return this.severityLevel; - } - - /** - *

- * TODO: comment - *

- * - * @param evaluationMetric - * @return - */ - public Optional isPresent(float evaluationMetric) { - Optional defect = Optional.absent(); - Map matchingSeverityLevels = Maps.filterValues(this.severity, severityForMetric(evaluationMetric)); - if(matchingSeverityLevels.isEmpty()) { - return defect; - } - setDefectAttributes(matchingSeverityLevels, evaluationMetric); - return Optional.of(this); - } - - /** - *

- * TODO: comment - *

- * - * @param matchingSeverityLevels - * @param evaluationMetric - */ - private void setDefectAttributes(Map matchingSeverityLevels, - float evaluationMetric) - { - BiMap inverse = HashBiMap.create(matchingSeverityLevels).inverse(); - this.severityLevel = inverse.get(Collections.max(inverse.keySet())); - this.description = String.format(this.description, evaluationMetric); - } - - /** - *

- * TODO: comment - *

- * @param evaluationMetric - * - * @return - */ - private Predicate< Double> severityForMetric(final float evaluationMetric) { - return new Predicate() { - - public boolean apply(Double severityThreshold) { - return evaluationMetric == severityThreshold || evaluationMetric > severityThreshold; - } - - }; - } - -} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityDefectSeverityLevel.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityDefectSeverityLevel.java (revision 1213) +++ (revision ) @@ -1,28 +1,0 @@ -// 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.result; - -/** - *

- * TODO comment - *

- * - * @author Alexander Deicke - */ -public enum UsabilityDefectSeverityLevel { - - NONE, INFO, LOW, MEDIUM, HIGH; - -} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemDescription.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemDescription.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemDescription.java (revision 1217) @@ -0,0 +1,149 @@ +// 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.result; + +import java.util.Collections; +import java.util.EnumMap; +import java.util.Map; + +import com.google.common.base.Optional; +import com.google.common.base.Predicate; +import com.google.common.collect.BiMap; +import com.google.common.collect.HashBiMap; +import com.google.common.collect.Maps; + +/** + *

+ * Description for a usability problem. + *

+ * + * @author Alexander Deicke + */ +public class UsabilityProblemDescription { + /** + *

+ * The severity of the defect. + *

+ */ + + private UsabilityProblemSeverityLevel severityLevel = UsabilityProblemSeverityLevel.NONE; + + /** + *

+ * A detailed description of the defect. + *

+ */ + private String description; + + /** + *

+ * Assignment of all possible severity values to a certain threshold. This is used, to determine + * the severity level during the usability evaluation. + *

+ */ + private final EnumMap severity; + + /** + *

+ * Constructor. Creates a new UsabilityDefectDescription for given description and all possible + * severity level. + *

+ * + * @param description + * description of the defect + * @param severity + * all possible severity level and their threshold + */ + public UsabilityProblemDescription(String description, + EnumMap severity) + { + this.description = description; + this.severity = severity; + } + + /** + *

+ * Gets the severity level of this defect. + *

+ * + * @return severity level of this defect + */ + public UsabilityProblemSeverityLevel getSeverityLevel() { + return this.severityLevel; + } + + /** + *

+ * Checks, if a defect is present. Therefore it uses a value, which is used to determine the + * severity level. + *

+ * + * @param evaluationMetric + * value, which determines the severity level of a defect + * @return iff defect is present, a {@linkplain UsabilityProblemDescription} of the defect + */ + public Optional isPresent(float evaluationMetric) { + Optional defect = Optional.absent(); + Map matchingSeverityLevels = + Maps.filterValues(this.severity, severityForMetric(evaluationMetric)); + if (matchingSeverityLevels.isEmpty()) { + return defect; + } + setDefectAttributes(matchingSeverityLevels, evaluationMetric); + return Optional.of(this); + } + + /** + *

+ * Initializes the properties of a {@linkplain UsabilityProblemDescription}. + *

+ * + * @param matchingSeverityLevels + * all severity level, where {@linkplain evaluationMetric} exceeds the threshold + * @param evaluationMetric + * measure for the defect + */ + private void setDefectAttributes(Map matchingSeverityLevels, + float evaluationMetric) + { + BiMap inverse = + HashBiMap.create(matchingSeverityLevels).inverse(); + this.severityLevel = inverse.get(Collections.max(inverse.keySet())); + this.description = String.format(this.description, evaluationMetric); + } + + /** + *

+ * Gets severity level depending on a measurement for the defect. + *

+ * + * @param evaluationMetric + * measure for the defect + * + * @return severity level, if measurement is equal or bigger as the threshold of the severity + * level + */ + private Predicate severityForMetric(final float evaluationMetric) { + return new Predicate() { + + public boolean apply(Double severityThreshold) { + return evaluationMetric == severityThreshold || + evaluationMetric > severityThreshold; + } + + }; + } + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemDescriptionResolver.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemDescriptionResolver.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemDescriptionResolver.java (revision 1217) @@ -0,0 +1,235 @@ +// 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.result; + +import java.io.File; +import java.io.IOException; +import java.net.URISyntaxException; +import java.util.EnumMap; +import java.util.Map; +import java.util.Map.Entry; + +import jodd.props.Props; + +import com.google.common.base.Optional; +import com.google.common.base.Predicate; +import com.google.common.collect.Iterables; +import com.google.common.collect.Maps; + +import de.ugoe.cs.util.console.Console; + +/** + *

+ * Helper class, which creates a {@link UsabilityProblemDescription} for a usability rule. + *

+ * + * @author Alexander Deicke + */ +public class UsabilityProblemDescriptionResolver { + + /** + *

+ * .properties file, which contains all details concerning a usability defect. + *

+ */ + private final String defectDescriptionFile = "defects.props"; + + /** + *

+ * Creates a defect description for a {@link UsabilityRule}. + *

+ * + * @param name + * of usability rule + * @return defect description for usability rule + */ + public UsabilityProblemDescription descriptionFor(String usabilityRuleName) { + Props allProperties = initProperties(); + Map usabilityRuleProperties = + allUsabilityRuleProperties(allProperties, usabilityRuleName); + return createUsabilityDefect(usabilityRuleProperties); + } + + /** + *

+ * Initializes the properties, which are used to create the defect description. + *

+ * + * @return properties needed to create defect description + */ + private Props initProperties() { + Optional defectDescriptionFile = getDefectDescriptionFile(); + Props props = new Props(); + props.setEscapeNewLineValue("\n"); + props.setValueTrimLeft(true); + if (defectDescriptionFile.isPresent()) { + loadProperties(defectDescriptionFile, props); + } + return props; + } + + /** + *

+ * Loads the .properties file from the system. + *

+ * + * @return iff present, {@link File} object of the .properties file + */ + private Optional getDefectDescriptionFile() { + try { + return Optional.fromNullable(new File(ClassLoader + .getSystemResource(defectDescriptionFile).toURI())); + } + catch (URISyntaxException e) { + Console.printerr("Error while loading defect description file."); + Console.logException(e); + return Optional.absent(); + } + } + + /** + * + *

+ * Loads the values from the .properties. + *

+ * + * @param defectDescriptionFile + * .properties file + * @param props + * object, which stores the loaded values + */ + private void loadProperties(Optional defectDescriptionFile, Props props) { + try { + props.load(defectDescriptionFile.get()); + } + catch (IOException e) { + Console.logException(e); + } + } + + /** + *

+ * Returns all existing properties for a given usability rule. + *

+ * + * @param allProperties + * all properties available + * @param usabilityRuleName + * name of usability rule + * @return all properties of certain usability rule + */ + private Map allUsabilityRuleProperties(Props allProperties, + String usabilityRuleName) + { + Map usabilityRuleProperties = Maps.newHashMap(); + allProperties.extractSubProps(usabilityRuleProperties, usabilityRuleName + ".*"); + return usabilityRuleProperties; + } + + /** + *

+ * Creates the usability defect. + *

+ * + * @param usabilityRuleProperties + * all properties needed for creation. + * @return defect description for a usability rule + */ + private UsabilityProblemDescription createUsabilityDefect(Map usabilityRuleProperties) + { + String description = + Iterables.getOnlyElement(Maps + .filterKeys(usabilityRuleProperties, descriptionProperty()).values()); + EnumMap severity = + getSeverityMap(usabilityRuleProperties); + return new UsabilityProblemDescription(description, severity); + } + + /** + *

+ * Gets the description property. + *

+ * + * @return description property + */ + private Predicate descriptionProperty() { + return new Predicate() { + + public boolean apply(String key) { + return key.endsWith("description"); + } + + }; + } + + /** + *

+ * Creates severity level map for defect description, by matching all entried from .properties + * file to corresponding {@link UsabilityProblemSeverityLevel}. + *

+ * + * @param usabilityRuleProperties + * all properties of certain usability rule + * @return assignment of {@link UsabilityProblemSeverityLevel} and corresponding threshold + */ + private EnumMap getSeverityMap(Map usabilityRuleProperties) + { + EnumMap severityMap = + Maps.newEnumMap(UsabilityProblemSeverityLevel.class); + Map allSeverityProperties = + Maps.filterEntries(usabilityRuleProperties, allSeverityProperties()); + for (Entry severityProperty : allSeverityProperties.entrySet()) { + UsabilityProblemSeverityLevel severityLevel = + getSeverityLevel(severityProperty.getKey()); + Double rule = Double.valueOf(severityProperty.getValue()); + severityMap.put(severityLevel, rule); + } + return severityMap; + } + + /** + *

+ * Matches severity level from .properties file against {@link UsabilityProblemSeverityLevel}. + *

+ * + * @param severityProperty + * severity level from .properties file + * @return matching {@link UsabilityProblemSeverityLevel} + */ + private UsabilityProblemSeverityLevel getSeverityLevel(String severityProperty) { + int startSeverityLevel = severityProperty.lastIndexOf(".") + 1; + String severityLevelIdentifier = + severityProperty.substring(startSeverityLevel).toUpperCase(); + return UsabilityProblemSeverityLevel.valueOf(severityLevelIdentifier); + } + + /** + *

+ * Gets the severity level properties. + *

+ * + * @return severity level + */ + private Predicate> allSeverityProperties() { + return new Predicate>() { + + public boolean apply(Map.Entry entry) { + return entry.getKey().contains("severity"); + } + + }; + } + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemSeverityLevel.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemSeverityLevel.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/result/UsabilityProblemSeverityLevel.java (revision 1217) @@ -0,0 +1,28 @@ +// 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.result; + +/** + *

+ * All possible severity level for usability defects. + *

+ * + * @author Alexander Deicke + */ +public enum UsabilityProblemSeverityLevel { + + NONE, INFO, LOW, MEDIUM, HIGH; + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/EmptyRuleset.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/EmptyRuleset.java (revision 1213) +++ (revision ) @@ -1,38 +1,0 @@ -// 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.rules; - -import java.util.Collections; -import java.util.List; - - -/** - *

- * TODO comment - *

- * - * @author Alexander Deicke - */ -public class EmptyRuleset implements UsabilityRuleset { - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usability.UsabilityRuleset#evaluationRules() - */ - @Override - public List evaluationRules() { - return Collections.emptyList(); - } - -} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/PatternRuleset.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/PatternRuleset.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/PatternRuleset.java (revision 1217) @@ -0,0 +1,51 @@ + +package de.ugoe.cs.autoquest.usability.rules; + +import java.util.List; + +import com.google.common.collect.Lists; + +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; +import de.ugoe.cs.autoquest.usability.rules.patterns.LongFormUsageProblem; + +/** + * + *

+ * A ruleset containing interaction patterns, which might be indicators for potential usability + * problems. + *

+ * + * @author Alexander Deicke + */ +public class PatternRuleset implements UsabilityRuleset { + + /** + * + */ + private final ITaskModel taskModel; + + /** + * + *

+ * Constructor. Creates new {@code PatternRuleset} for a given task model. + *

+ * + * @param taskModel + */ + public PatternRuleset(ITaskModel taskModel) { + this.taskModel = taskModel; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usability.rules.UsabilityRuleset#evaluationRules() + */ + @Override + public List evaluationRules() { + List rules = Lists.newArrayList(); + rules.add(new LongFormUsageProblem(this.taskModel)); + return rules; + } + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityMetric.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityMetric.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityMetric.java (revision 1217) @@ -17,9 +17,10 @@ import com.google.common.base.Optional; -import de.ugoe.cs.autoquest.usability.result.UsabilityDefect; +import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription; /** *

- * TODO comment + * Interface for usability metrics. A metric is a way of measuring or evaluating a particular + * phenomenon or thing, in this case usability. *

* @@ -27,6 +28,15 @@ */ public interface UsabilityMetric { - - public Optional calculate(); + + /** + * + *

+ * Calculates the metric. + *

+ * + * @return Detailed description of the usability problem, if calculated metric exceeds defined + * threshold. + */ + public Optional calculate(); } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityMetricsRuleset.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityMetricsRuleset.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityMetricsRuleset.java (revision 1217) @@ -26,5 +26,6 @@ /** *

- * TODO comment + * A ruleset containing usability metrics, which might be indicators for potential usability + * problems. *

* @@ -34,10 +35,10 @@ private List metrics; - + /** *

- * TODO: comment + * Constructor. Creates new {@code UsabilityMetricsRuleset} for a given task model. *

- * + * */ private UsabilityMetricsRuleset(ITaskModel taskModel) { @@ -48,5 +49,7 @@ } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see de.ugoe.cs.autoquest.usability.UsabilityRuleset#evaluationRules() */ Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityResult.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityResult.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityResult.java (revision 1217) @@ -18,11 +18,10 @@ import com.google.common.collect.Multimap; -import de.ugoe.cs.autoquest.usability.result.UsabilityDefect; -import de.ugoe.cs.autoquest.usability.result.UsabilityDefectSeverityLevel; - +import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription; +import de.ugoe.cs.autoquest.usability.result.UsabilityProblemSeverityLevel; /** *

- * TODO comment + * The result of the usability evaluation, which contains all detected problems. *

* @@ -30,24 +29,45 @@ */ public class UsabilityResult { - - private Multimap detectedDefects; - + + /** + *

+ * All detected problems and their appropriate severity level. + *

+ */ + private Multimap detectedProblems; + + /** + * + *

+ * Constructor. Creates a new result. + *

+ * + */ public UsabilityResult() { - this.detectedDefects = ArrayListMultimap.create(); + this.detectedProblems = ArrayListMultimap.create(); } /** *

- * TODO: comment + * Adds a usability problem to the result. *

- * - * @param usabilityDefect + * + * @param usabilityProblem + * the problem, which should be added. */ - public void addDefect(UsabilityDefect usabilityDefect) { - this.detectedDefects.put(usabilityDefect.getSeverityLevel(), usabilityDefect); + public void addProblem(UsabilityProblemDescription usabilityProblem) { + this.detectedProblems.put(usabilityProblem.getSeverityLevel(), usabilityProblem); } - - public boolean hasDefects() { - return !this.detectedDefects.isEmpty(); + + /** + * + *

+ * Checks, if problems were found during the usability evaluation. + *

+ * + * @return true, iff problems were found + */ + public boolean hasDetectedProblems() { + return !this.detectedProblems.isEmpty(); } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityRule.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityRule.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityRule.java (revision 1217) @@ -19,9 +19,10 @@ 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; /** *

- * 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. *

* @@ -29,22 +30,48 @@ */ public abstract class UsabilityRule { - - protected final ITaskModel taskModel; - - protected String name; - - protected UsabilityDefect defect; - + /** *

- * TODO: comment + * {@link ITaskModel}, which is evaluated *

- * + */ + protected final ITaskModel taskModel; + + /** + *

+ * Name of the usability rule + *

+ */ + protected String name; + + /** + *

+ * Corresponding defect description. + *

+ */ + protected UsabilityProblemDescription defect; + + /** + *

+ * Constructor. Creates a new {@code UsabilityRule} for a given task model + *

+ * */ public UsabilityRule(ITaskModel taskModel) { this.taskModel = taskModel; } - - public abstract Optional callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller); + + /** + * + *

+ * Calls the evaluation method of this {@code UsabilityRule}. + *

+ * + * @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 callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller); } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityRuleset.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityRuleset.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityRuleset.java (revision 1217) @@ -19,5 +19,5 @@ /** *

- * TODO comment + * A {@code UsabilityRuleset} is a container for {@link UsabilityRule}s. *

* @@ -28,8 +28,8 @@ /** *

- * TODO: comment + * Gets all {@link UsabilityRule}s contained in the {@code UsabilityRuleset}. *

- * - * @return + * + * @return all contained {@link UsabilityRule}s */ public List evaluationRules(); Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageDefect.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageDefect.java (revision 1213) +++ (revision ) @@ -1,32 +1,0 @@ -// 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.rules; - -import com.google.common.base.Optional; - -import de.ugoe.cs.autoquest.usability.result.UsabilityDefect; - -/** - *

- * TODO comment - *

- * - * @author Alexander Deicke - */ -public interface UsabilityUsageDefect { - - public Optional check(); - -} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageProblem.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageProblem.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageProblem.java (revision 1217) @@ -0,0 +1,41 @@ +// 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.rules; + +import com.google.common.base.Optional; + +import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription; + +/** + *

+ * Common interface for usability problems. Simple speaking, a usability problem is a specific + * problem that negatively affects the usage of a application. + *

+ * + * @author Alexander Deicke + */ +public interface UsabilityUsageProblem { + + /** + * + *

+ * Checks, if usability problem is present. + *

+ * + * @return Detailed description of the usability problem, if it was detected. + */ + public Optional check(); + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/NoLetterOrDigitRatioMetric.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/NoLetterOrDigitRatioMetric.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/NoLetterOrDigitRatioMetric.java (revision 1217) @@ -15,7 +15,7 @@ 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,15 +28,16 @@ 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; /** *

- * TODO comment + * Metric, which calculates the ratio ratio between non letter or digit characters and all entered + * characters. *

* @@ -47,33 +48,54 @@ /** *

- * TODO: comment + * Constructor. Creates a new {@code NoLetterOrDigitRatioMetric} for a given task model. *

- * - * @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 calculate() { + public Optional calculate() { FilterResult textInputEvents = extractNodesFromTaskTree(); float evaluationMetric = calculateEvaluationMetric(textInputEvents.tasksMatchedFilter()); return this.defect.isPresent(evaluationMetric); } - + + /** + * + *

+ * Filters all text input events from task model. + *

+ * + * @return {@code FilterResult} + */ private FilterResult extractNodesFromTaskTree() { return new TaskModelFilter(new IterativeDFSFilterStrategy()).filterByEventType(TEXT_INPUT) .from(this.taskModel); } - + + /** + * + *

+ * Calculates the metric. + *

+ * + * @param textInputEvents + * all text input events + * @return ratio between non letter or digit characters and all entered characters + */ private float calculateEvaluationMetric(List textInputEvents) { - Multiset enteredTextFragments = - aggregateEnteredTextFromTextInputs(textInputEvents); + Multiset enteredTextFragments = aggregateEnteredTextFromTextInputs(textInputEvents); int allCharactersCount = 0; int noLetterOrDigitCount = 0; @@ -82,6 +104,6 @@ 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,9 +111,13 @@ } - /* (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 callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller) + public Optional callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller) { return evaluationMethodCaller.check(this); Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/TextInputEntryRepetitionsMetric.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/TextInputEntryRepetitionsMetric.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/TextInputEntryRepetitionsMetric.java (revision 1217) @@ -15,5 +15,5 @@ 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; @@ -28,15 +28,16 @@ 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; /** *

- * TODO comment + * Metric, which measures either the repetition of entered words or the maximum repetition of a + * single word. *

* @@ -47,33 +48,54 @@ /** *

- * TODO: comment + * Constructor. Creates a new {@link TextInputEntryRepetitionsMetric} for a given task model. *

- * - * @param taskTree + * + * @param taskModel */ public TextInputEntryRepetitionsMetric(ITaskModel taskModel) { super(taskModel); this.name = "TextInputEntryRepetitions"; - 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 calculate() { + public Optional calculate() { FilterResult textInputEvents = extractNodesFromTaskTree(); float evaluationMetric = calculateEvaluationMetric(textInputEvents.tasksMatchedFilter()); return this.defect.isPresent(evaluationMetric); } - + + /** + * + *

+ * Filters all text input events from task model. + *

+ * + * @return {@code FilterResult} + */ private FilterResult extractNodesFromTaskTree() { return new TaskModelFilter(new IterativeDFSFilterStrategy()).filterByEventType(TEXT_INPUT) .from(this.taskModel); } - + + /** + * + *

+ * Calculates the metric. + *

+ * + * @param textInputEvents + * all text input events + * @return either number of repeated words or the number of repetitions of the most entered word + */ private float calculateEvaluationMetric(List textInputEvents) { - Multiset enteredTextFragments = - aggregateEnteredTextFromTextInputs(textInputEvents); + Multiset enteredTextFragments = aggregateEnteredTextFromTextInputs(textInputEvents); Multiset orderedTextFragmentsWithMultipleOccurences = onlyTextFragmentsWithMultipleOccurences(enteredTextFragments); @@ -86,7 +108,17 @@ orderedTextFragmentsWithMultipleOccurences .count(wordWithHighestRepetitionInTextFragments); - return Math.max(numberOfRepeatedWords, maxRepetitions-1); + return Math.max(numberOfRepeatedWords, maxRepetitions - 1); } - + + /** + * + *

+ * Return only words, which at least entered twice. + *

+ * + * @param allTextInputs + * all text input events + * @return all word, which used min. twice + */ private Multiset onlyTextFragmentsWithMultipleOccurences(final Multiset allTextInputs) { @@ -104,12 +136,16 @@ } - /* (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 callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller) + public Optional callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller) { return evaluationMethodCaller.check(this); } - + } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/TextInputRatioMetric.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/TextInputRatioMetric.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/metrics/TextInputRatioMetric.java (revision 1217) @@ -15,5 +15,5 @@ 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 java.util.List; @@ -27,15 +27,15 @@ 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; /** *

- * TODO comment + * Metric, which measures the ratio between the text input and the non text input events. *

* @@ -46,7 +46,7 @@ /** *

- * TODO: comment + * Constructor. Creates a new {@code TextInputRatioMetric} for a given task model. *

- * + * * @param taskTree */ @@ -54,23 +54,51 @@ super(taskModel); this.name = "TextInputRatio"; - 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 calculate() { + public Optional calculate() { FilterResult textInputEvents = extractNodesFromTaskTree(); - float evaluationMetric = calculateEvaluationMetric(textInputEvents.tasksMatchedFilter(), textInputEvents.tasksNotMatchedFilter()); + float evaluationMetric = + calculateEvaluationMetric(textInputEvents.tasksMatchedFilter(), + textInputEvents.tasksNotMatchedFilter()); return this.defect.isPresent(evaluationMetric); } - + + /** + * + *

+ * Filters all text input events from task model. + *

+ * + * @return {@code FilterResult} + */ private FilterResult extractNodesFromTaskTree() { return new TaskModelFilter(new IterativeDFSFilterStrategy()).filterByEventType(TEXT_INPUT) .from(this.taskModel); } - - private float calculateEvaluationMetric(List textInputEvents, List nonTextInputEvents) { + + /** + * + *

+ * Calculates the metric. + *

+ * + * @param textInputEvents + * all text input events + * @param nonTextInputEvents + * all non text input events + * @return ratio between text input and non text input events + */ + private float calculateEvaluationMetric(List textInputEvents, + List nonTextInputEvents) + { float numberOfTextInputEvents = textInputEvents.size(); float numberOfNonTextInputEvents = nrOfEventTasksNotMatchedFilter(nonTextInputEvents); @@ -78,20 +106,33 @@ } + /** + * + *

+ * Filters all {@link IEventTask}s from non text input event. + *

+ * + * @param nonTextInputEvents + * all non text input events + * @return number of {@link IEventTask}s + */ private int nrOfEventTasksNotMatchedFilter(List nonTextInputEvents) { - return Iterables.size(Iterables.filter(nonTextInputEvents, - new Predicate() { + return Iterables.size(Iterables.filter(nonTextInputEvents, new Predicate() { - @Override - public boolean apply(ITask task) { - return task instanceof IEventTask; - } - })); + @Override + public boolean apply(ITask task) { + return task instanceof IEventTask; + } + })); } - /* (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 callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller) + public Optional callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller) { return evaluationMethodCaller.check(this); Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPattern.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPattern.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPattern.java (revision 1217) @@ -15,5 +15,4 @@ package de.ugoe.cs.autoquest.usability.rules.patterns; -import java.util.Arrays; import java.util.List; @@ -24,11 +23,11 @@ import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; -import de.ugoe.cs.autoquest.usability.tasktree.IterativeDFSFilterStrategy; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskModelFilter; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.IterativeDFSFilterStrategy; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskModelFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; /** *

- * TODO comment + * A interaction pattern is a simple approach to describe the structure of usage behaviour. *

* @@ -36,110 +35,191 @@ */ public class InteractionPattern { - + + /** + *

+ * {@link TaskModelFilter}, which is used to filter a task model after different {@link ITask}s + *

+ */ private TaskModelFilter taskTreeFilter = new TaskModelFilter(new IterativeDFSFilterStrategy()); - - private TaskTypeFilter concernedTask; - + + /** + *

+ * Type of root task. Determines the order in which sub task appear. + *

+ */ + private TaskTypeFilter rootTask; + + /** + *

+ * Helper objects, which decide whether or not a defined pattern condition holds. + *

+ */ private List patternVisitors; - + + /** + *

+ * Flag, which indicates if the interaction pattern was found within a given task model. + *

+ */ private boolean present = false; - - /** - *

- * TODO: comment - *

- * - * @param concernedNode - * @param eventType - */ - public InteractionPattern(TaskTypeFilter concernedNode, - InteractionPatternVisitor... patternVisitor) + + /** + *

+ * Constructor. Creates a new interaction pattern for a given root task and a collection of + * {@link InteractionPatternVisitor}s. + *

+ * + * @param rootTask + * Type of root task, which determines the order in which sub task appear. + * @param patternVisitors + * {@link InteractionPatternVisitor}s, which decide whether or not a defined pattern + * condition holds + */ + public InteractionPattern(TaskTypeFilter rootTask, + List patternVisitors) { - this.patternVisitors = Arrays.asList(patternVisitor); - this.concernedTask = concernedNode; - } - + this.patternVisitors = patternVisitors; + this.rootTask = rootTask; + } + + /** + * + *

+ * Checks if a interaction pattern is contained in a given task model. + *

+ * + * @param taskModel + * {@link ITaskModel}, which might contain the interaction pattern + * @return true, iff interaction pattern is contained + */ public boolean containedIn(ITaskModel taskModel) { List allConcernedTasks = filterAllConcernedTasksFrom(taskModel); - for(ITask concernedTask : allConcernedTasks) { - checkTask(concernedTask); - if(this.present) break; + for (ITask concernedTask : allConcernedTasks) { + checkTask(concernedTask); + if (this.present) + break; } return this.present; } - private void checkTask(ITask concernedTask) { - applyAllVisitors(concernedTask); - if(allVisitorsArePresent()) { + /** + * + *

+ * Checks a single {@link ITask} for the interaction pattern. + *

+ * + * @param task + * task, which might contain the interaction pattern + */ + private void checkTask(ITask task) { + applyAllVisitors(task); + if (allVisitorsArePresent()) { this.present = true; - } else { + } + else { resetAllVisitors(); } } - + + /** + * + *

+ * Checks if a interaction pattern is contained in a given task. + *

+ * + * @param task + * task, which might contain the interaction pattern + * @return true, iff interaction pattern is contained + */ public boolean containedIn(ITask task) { checkTask(task); - return this.present; - } - - private void applyAllVisitors(ITask concernedTask) { + return this.present; + } + + /** + * + *

+ * Method applys all {@link InteractionPatternVisitor}s, to check single interaction pattern + * conditions. + *

+ * + * @param task + * task, which might contain the interaction pattern + */ + private void applyAllVisitors(ITask task) { Optional previousVisitor = Optional.absent(); - for(InteractionPatternVisitor visitor : patternVisitors) { - if (appliedOnSelectionNode(previousVisitor)) { - for (ITask selection : previousVisitor.get().getRetainedSelectionNodes()) { - selection.accept(visitor); - } - } else { - previousVisitor = Optional.of(visitor); - concernedTask.accept(visitor); - } - } - } - - private boolean appliedOnSelectionNode(Optional previousVisitor) { - return previousVisitor.isPresent() && previousVisitor.get().hasExcludedSelectionNodes(); - } - - /** - *

- * TODO: comment - *

- * - * @param taskTree - * @return + for (InteractionPatternVisitor visitor : patternVisitors) { + if (appliedOnSelectionNode(previousVisitor)) { + for (ITask selection : previousVisitor.get().getRetainedSelectionNodes()) { + selection.accept(visitor); + } + } + else { + previousVisitor = Optional.of(visitor); + task.accept(visitor); + } + } + } + + /** + * + *

+ * Checks, if a {@link InteractionPatternVisitor} was applied on a {@link ISelection} task. + *

+ * + * @param interactionPatternVisitor + * {@link InteractionPatternVisitor} + * @return true, iff {@link InteractionPatternVisitor} was applied on {@link ISelection} task + */ + private boolean appliedOnSelectionNode(Optional interactionPatternVisitor) + { + return interactionPatternVisitor.isPresent() && + interactionPatternVisitor.get().hasExcludedSelectionNodes(); + } + + /** + *

+ * Filters given task model after root task of interaction pattern. + *

+ * + * @param taskModel + * {@link ITaskModel} + * @return all tasks of task model, which matches root task of interaction pattern */ private List filterAllConcernedTasksFrom(ITaskModel taskModel) { - return this.taskTreeFilter.filterByNodeType(this.concernedTask).from(taskModel).tasksMatchedFilter(); - } - - /** - *

- * TODO: comment - *

- * - * @return + return this.taskTreeFilter.filterByNodeType(this.rootTask).from(taskModel) + .tasksMatchedFilter(); + } + + /** + *

+ * Checks, if all interaction pattern condition are evaluated to true. + *

+ * + * @return true, iff all interaction pattern condition are true */ private boolean allVisitorsArePresent() { - Iterable allPresent = Iterables.filter(this.patternVisitors, new Predicate() { - - public boolean apply(InteractionPatternVisitor visitor) { - return visitor.isPresent(); - } - - }); + Iterable allPresent = + Iterables.filter(this.patternVisitors, new Predicate() { + + public boolean apply(InteractionPatternVisitor visitor) { + return visitor.isPresent(); + } + + }); return Iterables.size(allPresent) == this.patternVisitors.size(); } - - /** - *

- * TODO: comment - *

- * + + /** + *

+ * Resets all interaction pattern condition. + *

+ * */ private void resetAllVisitors() { - for(InteractionPatternVisitor visitor : this.patternVisitors) { + for (InteractionPatternVisitor visitor : this.patternVisitors) { visitor.reset(); } - + } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPatternBuilder.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPatternBuilder.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPatternBuilder.java (revision 1217) @@ -15,4 +15,8 @@ package de.ugoe.cs.autoquest.usability.rules.patterns; +import java.util.List; + +import com.google.common.collect.Lists; + import de.ugoe.cs.autoquest.usability.rules.patterns.visitors.ContainsEventVisitor; import de.ugoe.cs.autoquest.usability.rules.patterns.visitors.ContainsInteractionPatternVisitor; @@ -21,10 +25,10 @@ import de.ugoe.cs.autoquest.usability.rules.patterns.visitors.StartsWithEventVisitor; import de.ugoe.cs.autoquest.usability.rules.patterns.visitors.StartsWithInteractionPatternVisitor; -import de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; /** *

- * TODO comment + * Helper class, which allows to create {@link InteractionPattern}s. *

* @@ -33,677 +37,192 @@ public class InteractionPatternBuilder { - protected TaskTypeFilter concernedNode; - + /** + *

+ * Type of root task. Determines the order in which sub task appear. + *

+ */ + protected TaskTypeFilter rootTask; + + /** + *

+ * Interaction pattern starts with event. + *

+ */ protected EventTypeFilter startsWithEvent; - + + /** + *

+ * Interaction pattern starts with interaction pattern. + *

+ */ protected InteractionPattern startsWithPattern; - + + /** + *

+ * Interaction pattern ends with event. + *

+ */ protected EventTypeFilter endsWithEvent; - + + /** + *

+ * Interaction pattern ends with interaction pattern. + *

+ */ protected InteractionPattern endsWithPattern; - + + /** + *

+ * Interaction pattern contains certain event. + *

+ */ protected EventTypeFilter containsEvent; - + + /** + *

+ * Interaction pattern contains certain interaction pattern. + *

+ */ protected InteractionPattern containsPattern; - - /** - *

- * TODO: comment - *

- * - * @param sequence - * @return - */ - public SpecifyPatternStep concernedNode(TaskTypeFilter concernedNode) { - this.concernedNode = concernedNode; - return new SpecifyPatternStep(); - } - - public class SpecifyPatternStep { - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildStartsWithEventStep startsWith(EventTypeFilter startsWithType) { - InteractionPatternBuilder.this.startsWithEvent = startsWithType; - return new BuildStartsWithEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param startsWithPattern - * @return - */ - public BuildStartsWithPatternStep startsWith(InteractionPattern startsWithPattern) { - InteractionPatternBuilder.this.startsWithPattern = startsWithPattern; - return new BuildStartsWithPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildEndsWithEventStep endsWith(EventTypeFilter endsWithType) { - InteractionPatternBuilder.this.endsWithEvent = endsWithType; - return new BuildEndsWithEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param endsWithPattern - * @return - */ - public BuildEndsWithPatternStep endsWith(InteractionPattern endsWithPattern) { - InteractionPatternBuilder.this.endsWithPattern = endsWithPattern; - return new BuildEndsWithPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildContainsEventStep contains(EventTypeFilter containsType) { - InteractionPatternBuilder.this.containsEvent = containsType; - return new BuildContainsEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param containsPattern - * @return - */ - public BuildContainsPatternStep contains(InteractionPattern containsPattern) { - InteractionPatternBuilder.this.containsPattern = containsPattern; - return new BuildContainsPatternStep(); - } - - } - - public class BuildStartsWithEventStep { - - /** - *

- * TODO: comment - *

- * - * @param endsWithType - * @return - */ - public BuildStartsAndEndsWithEventStep endsWith(EventTypeFilter endsWithType) { - InteractionPatternBuilder.this.endsWithEvent = endsWithType; - return new BuildStartsAndEndsWithEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param endsWithPattern - * @return - */ - public BuildStartsWithEventAndEndsWithPattern endsWith(InteractionPattern endsWithPattern) { - InteractionPatternBuilder.this.endsWithPattern = endsWithPattern; - return new BuildStartsWithEventAndEndsWithPattern(); - } - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildStartsWithEventAndContainsEventStep contains(EventTypeFilter containsType) { - InteractionPatternBuilder.this.containsEvent = containsType; - return new BuildStartsWithEventAndContainsEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param containedPattern - * @return - */ - public BuildStartsWithEventAndContainsPatternStep contains(InteractionPattern containsPattern) { - InteractionPatternBuilder.this.containsPattern = containsPattern; - return new BuildStartsWithEventAndContainsPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ + + /** + * + *

+ * Starts creation of new interaction pattern. + *

+ * + * @return steps to create interaction pattern + */ + public static SetConcernedTaskModelComponentStep newPattern() { + return new Steps(); + } + + public static interface SetConcernedTaskModelComponentStep { + + public BuildPatternStep rootTask(TaskTypeFilter concernedNode); + + } + + public static interface BuildPatternStep { + + public StartsWithStep startsWithEvent(EventTypeFilter startsWithEventType); + + public StartsWithStep startsWithPattern(InteractionPattern endsWithPattern); + + public ContainsStep containsEvent(EventTypeFilter containsEventType); + + public ContainsStep containsPattern(InteractionPattern containsPattern); + + public EndsWithStep endsWithEvent(EventTypeFilter endsWithEventType); + + public EndsWithStep endsWithPattern(InteractionPattern endsPattern); + + public BuildStep patternFinished(); + + } + + public static interface StartsWithStep { + + public ContainsStep containsEvent(EventTypeFilter containsEventType); + + public ContainsStep containsPattern(InteractionPattern containsPattern); + + public EndsWithStep endsWithEvent(EventTypeFilter endsWithEventType); + + public EndsWithStep endsWithPattern(InteractionPattern endsPattern); + + public BuildStep patternFinished(); + + } + + public static interface ContainsStep { + + public ContainsStep containsEvent(EventTypeFilter containsEventType); + + public ContainsStep containsPattern(InteractionPattern containsPattern); + + public EndsWithStep endsWithEvent(EventTypeFilter endsWithEventType); + + public EndsWithStep endsWithPattern(InteractionPattern endsPattern); + + public BuildStep patternFinished(); + } + + public static interface EndsWithStep { + + public BuildStep patternFinished(); + + } + + public static interface BuildStep { + + public InteractionPattern build(); + + } + + private static class Steps implements SetConcernedTaskModelComponentStep, BuildPatternStep, + StartsWithStep, ContainsStep, EndsWithStep, BuildStep + { + + private List visitors = Lists.newArrayList(); + + private TaskTypeFilter concernedNode; + + @Override + public BuildPatternStep rootTask(TaskTypeFilter concernedNode) { + this.concernedNode = concernedNode; + return this; + } + + @Override + public StartsWithStep startsWithEvent(EventTypeFilter startsWithEventType) { + this.visitors.add(new StartsWithEventVisitor(startsWithEventType, concernedNode)); + return this; + } + + @Override + public StartsWithStep startsWithPattern(InteractionPattern startsWithPattern) { + this.visitors.add(new StartsWithInteractionPatternVisitor(startsWithPattern, + concernedNode)); + return this; + } + + @Override + public ContainsStep containsEvent(EventTypeFilter containsEventType) { + this.visitors.add(new ContainsEventVisitor(containsEventType, concernedNode)); + return this; + } + + @Override + public ContainsStep containsPattern(InteractionPattern containsPattern) { + this.visitors + .add(new ContainsInteractionPatternVisitor(containsPattern, concernedNode)); + return this; + } + + @Override + public EndsWithStep endsWithEvent(EventTypeFilter endsWithEventType) { + this.visitors.add(new EndsWithEventVisitor(endsWithEventType, concernedNode)); + return this; + } + + @Override + public EndsWithStep endsWithPattern(InteractionPattern endsWithPattern) { + this.visitors + .add(new EndsWithInteractionPatternVisitor(endsWithPattern, concernedNode)); + return this; + + } + + @Override + public BuildStep patternFinished() { + return this; + } + + @Override public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode)); - } - - } - - public class BuildStartsWithPatternStep { - - /** - *

- * TODO: comment - *

- * - * @param containsEvent - * @return - */ - public BuildStartsWithPatternAndContainsEventStep contains(EventTypeFilter containsEvent) { - InteractionPatternBuilder.this.containsEvent = containsEvent; - return new BuildStartsWithPatternAndContainsEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param containedPattern - * @return - */ - public BuildStartsWithPatternAndContainsPatternStep contains(InteractionPattern containsPattern) { - InteractionPatternBuilder.this.containsPattern = containsPattern; - return new BuildStartsWithPatternAndContainsPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildStartsWithPatternAndEndsWithEventStep endsWith(EventTypeFilter endsWithEvent) { - InteractionPatternBuilder.this.endsWithEvent = endsWithEvent; - return new BuildStartsWithPatternAndEndsWithEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param endsWithPattern - * @return - */ - public BuildStartsAndEndsWithPatternStep endsWith(InteractionPattern endsWithPattern) { - InteractionPatternBuilder.this.endsWithPattern = endsWithPattern; - return new BuildStartsAndEndsWithPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode)); - } - - } - - public class BuildEndsWithEventStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new EndsWithEventVisitor(endsWithEvent, concernedNode)); - } - - } - - public class BuildEndsWithPatternStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new EndsWithInteractionPatternVisitor(endsWithPattern, concernedNode)); - } - - } - - public class BuildContainsEventStep { - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildContainsAndEndsWithEventStep endsWith(EventTypeFilter endsWithType) { - InteractionPatternBuilder.this.endsWithEvent = endsWithType; - return new BuildContainsAndEndsWithEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new ContainsEventVisitor(containsEvent, concernedNode)); - } - - } - - public class BuildContainsPatternStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new ContainsInteractionPatternVisitor(containsPattern, concernedNode)); - } - - } - - public class BuildStartsAndEndsWithEventStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode), new EndsWithEventVisitor(endsWithEvent, concernedNode)); - } - - } - - public class BuildStartsWithEventAndEndsWithPattern { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode), new EndsWithInteractionPatternVisitor(endsWithPattern, concernedNode)); - } - - } - - public class BuildStartsWithPatternAndEndsWithEventStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode), new EndsWithEventVisitor(endsWithEvent, concernedNode)); - } - - } - - public class BuildStartsAndEndsWithPatternStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode), new EndsWithInteractionPatternVisitor(endsWithPattern, concernedNode)); - } - - } - - public class BuildStartsWithEventAndContainsEventStep { - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildStartsAndEndsWithEventAndContainsEventStep endsWith(EventTypeFilter endsWithEvent) { - InteractionPatternBuilder.this.endsWithEvent = endsWithEvent; - return new BuildStartsAndEndsWithEventAndContainsEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param endsWithPattern - * @return - */ - public BuildStartsWithEventContainsEventAndEndsWithPatternStep endsWith(InteractionPattern endsWithPattern) { - InteractionPatternBuilder.this.endsWithPattern = endsWithPattern; - return new BuildStartsWithEventContainsEventAndEndsWithPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode), new ContainsEventVisitor(containsEvent, concernedNode)); - } - - } - - public class BuildStartsWithPatternAndContainsPatternStep { - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildStartsContainsPatternAndEndsWithEventStep endsWith(EventTypeFilter endsWithEvent) { - InteractionPatternBuilder.this.endsWithEvent = endsWithEvent; - return new BuildStartsContainsPatternAndEndsWithEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param endsWithPattern - * @return - */ - public BuildStartsAndEndsWithPatternAndContainsPatternStep endsWith(InteractionPattern endsWithPattern) { - InteractionPatternBuilder.this.endsWithPattern = endsWithPattern; - return new BuildStartsAndEndsWithPatternAndContainsPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode), new ContainsInteractionPatternVisitor(containsPattern, concernedNode)); - } - - } - - public class BuildStartsWithEventAndContainsPatternStep { - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildStartsWithEventContainsPatternAndEndsWithEventStep endsWith(EventTypeFilter endsWithEvent) { - InteractionPatternBuilder.this.endsWithEvent = endsWithEvent; - return new BuildStartsWithEventContainsPatternAndEndsWithEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param endsWithPattern - * @return - */ - public BuildStartsWithEventContainsPatternAndEndsWithPatternStep endsWith(InteractionPattern endsWithPattern) { - InteractionPatternBuilder.this.endsWithPattern = endsWithPattern; - return new BuildStartsWithEventContainsPatternAndEndsWithPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode), new ContainsInteractionPatternVisitor(containsPattern, concernedNode)); - } - - } - - public class BuildStartsWithPatternAndContainsEventStep { - - /** - *

- * TODO: comment - *

- * - * @param textInput - * @return - */ - public BuildStartsWithPatternContainsEventAndEndsWithEventStep endsWith(EventTypeFilter endsWithEvent) { - InteractionPatternBuilder.this.endsWithEvent = endsWithEvent; - return new BuildStartsWithPatternContainsEventAndEndsWithEventStep(); - } - - /** - *

- * TODO: comment - *

- * - * @param endsWithPattern - * @return - */ - public BuildStartsWithPatternContainsEventAndEndsWithPatternStep endsWith(InteractionPattern endsWithPattern) { - InteractionPatternBuilder.this.endsWithPattern = endsWithPattern; - return new BuildStartsWithPatternContainsEventAndEndsWithPatternStep(); - } - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode), new ContainsEventVisitor(containsEvent, concernedNode)); - } - - } - - public class BuildStartsAndEndsWithEventAndContainsEventStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode), new EndsWithEventVisitor(endsWithEvent, concernedNode), new ContainsEventVisitor(containsEvent, concernedNode)); - } - - } - - public class BuildStartsContainsPatternAndEndsWithEventStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode), new ContainsInteractionPatternVisitor(containsPattern, concernedNode), new EndsWithEventVisitor(endsWithEvent, concernedNode)); - } - - } - - public class BuildStartsAndEndsWithPatternAndContainsPatternStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode), new EndsWithInteractionPatternVisitor(endsWithPattern, concernedNode), new ContainsInteractionPatternVisitor(containsPattern, concernedNode)); - } - - } - - public class BuildStartsWithEventContainsEventAndEndsWithPatternStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode), new ContainsEventVisitor(containsEvent, concernedNode), new EndsWithInteractionPatternVisitor(endsWithPattern, concernedNode)); - } - - } - - public class BuildStartsWithEventContainsPatternAndEndsWithEventStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode), new ContainsInteractionPatternVisitor(containsPattern, concernedNode), new EndsWithEventVisitor(endsWithEvent, concernedNode)); - } - - } - - public class BuildStartsWithEventContainsPatternAndEndsWithPatternStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithEventVisitor(startsWithEvent, concernedNode), new ContainsInteractionPatternVisitor(containsPattern, concernedNode), new EndsWithInteractionPatternVisitor(endsWithPattern, concernedNode)); - } - - } - - public class BuildStartsWithPatternContainsEventAndEndsWithEventStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode), new ContainsEventVisitor(containsEvent, concernedNode), new EndsWithEventVisitor(endsWithEvent, concernedNode)); - } - - } - - public class BuildStartsWithPatternContainsEventAndEndsWithPatternStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new StartsWithInteractionPatternVisitor(startsWithPattern, concernedNode), new ContainsEventVisitor(containsEvent, concernedNode), new EndsWithInteractionPatternVisitor(endsWithPattern, concernedNode)); - } - - } - - public class BuildContainsAndEndsWithEventStep { - - /** - *

- * TODO: comment - *

- * - * @return - */ - public InteractionPattern build() { - return new InteractionPattern(concernedNode, new ContainsEventVisitor(containsEvent, concernedNode), new EndsWithEventVisitor(endsWithEvent, concernedNode)); - } - + return new InteractionPattern(concernedNode, this.visitors); + } + } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPatternVisitor.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPatternVisitor.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/InteractionPatternVisitor.java (revision 1217) @@ -25,9 +25,12 @@ import de.ugoe.cs.autoquest.eventcore.StringEventType; import de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask; +import de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration; +import de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional; import de.ugoe.cs.autoquest.tasktrees.treeifc.ISelection; +import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence; import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor; -import de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; /** @@ -39,37 +42,42 @@ */ public abstract class InteractionPatternVisitor implements ITaskVisitor { - - protected TaskTypeFilter taskType; - + + protected TaskTypeFilter taskType; + protected EventTypeFilter eventType; - + protected InteractionPattern containedPattern; - + protected boolean present = false; - + protected List retainedSelectionTasks = Lists.newArrayList(); - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask) + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IEventTask) */ public void visit(IEventTask event) { - if(!this.present && isEventVisitor()) { + if (!this.present && isEventVisitor()) { IEventType eventType = event.getEventType(); - if(eventType instanceof StringEventType) { + if (eventType instanceof StringEventType) { this.present = eventType.toString().equals(nameOfEventType()); - } else { + } + else { this.present = eventType.getClass().equals(this.eventType.clazz()); } } } - + public boolean isEventVisitor() { return this.eventType != null && this.containedPattern == null; } - + protected String nameOfEventType() { String ret = StringUtils.EMPTY; Iterable splitted = Splitter.on("_").split(this.eventType.name()); - for(String str : splitted) { + for (String str : splitted) { str = str.toLowerCase(); ret += Character.toString(str.charAt(0)).toUpperCase() + str.substring(1); @@ -77,49 +85,68 @@ return ret; } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.ITask) + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#accept(de.ugoe.cs.autoquest.tasktrees. + * treeifc.ITask) */ @Override public void visit(ITask task) { - task.accept(this); - + if (task instanceof ISequence) { + this.visit((ISequence) task); + } + else if (task instanceof IIteration) { + this.visit((IIteration) task); + } + else if (task instanceof ISelection) { + this.visit((ISelection) task); + } + else { + this.visit((IOptional) task); + } } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.ISelection) + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .ISelection) */ public void visit(ISelection selection) { - if(isEventVisitor()) { + if (isEventVisitor()) { retainNodesWherePatternIsPresent(selection); this.present = patternIsPresent(); - } else { - this.present = containedPattern.containedIn(selection); + } + else { + this.present = containedPattern.containedIn(selection); } } @SuppressWarnings("unchecked") - protected void retainNodesWherePatternIsPresent(ISelection selection) { - for(ITask task : selection.getChildren()) { + protected void retainNodesWherePatternIsPresent(ISelection selection) { + for (ITask task : selection.getChildren()) { this.present = false; task.accept(this); - if(this.present && this.taskType.filterPredicate().apply(selection)) { + if (this.present && this.taskType.filterPredicate().apply(selection)) { this.retainedSelectionTasks.add(selection); } - if(this.present) { - break; + if (this.present) { + break; } } } - + private boolean patternIsPresent() { return !this.retainedSelectionTasks.isEmpty(); } - + /** *

* TODO: comment *

- * + * * @return */ @@ -132,5 +159,5 @@ * TODO: comment *

- * + * */ public void reset() { @@ -143,5 +170,5 @@ * TODO: comment *

- * + * * @return */ @@ -154,5 +181,5 @@ * TODO: comment *

- * + * * @return */ @@ -160,4 +187,4 @@ return this.retainedSelectionTasks; } - + } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/LongFormUsageDefect.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/LongFormUsageDefect.java (revision 1213) +++ (revision ) @@ -1,89 +1,0 @@ -// 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.rules.patterns; - -import static de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter.MOUSE_CLICK; -import static de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter.SCROLL; -import static de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter.TEXT_INPUT; -import static de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter.ITERATION; -import static de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter.SEQUENCE; - -import com.google.common.base.Optional; - -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.rules.UsabilityRule; -import de.ugoe.cs.autoquest.usability.rules.UsabilityUsageDefect; - -/** - *

- * TODO comment - *

- * - * @author Alexander Deicke - */ -public class LongFormUsageDefect extends UsabilityRule implements UsabilityUsageDefect { - - private InteractionPattern longFormUsagePattern; - - /** - *

- * TODO: comment - *

- * - * @param taskTree - */ - public LongFormUsageDefect(ITaskModel taskModel) { - super(taskModel); - this.name = "LongFormUsagePattern"; - this.defect = new DefectDescriptionResolver().descriptionFor(this.getClass().getSimpleName()); - initUsagePattern(); - } - - /** - *

- * TODO: comment - *

- * - */ - private void initUsagePattern() { - InteractionPatternBuilder builder = new InteractionPatternBuilder(); - InteractionPattern fillFormPattern = builder.concernedNode(ITERATION).startsWith(TEXT_INPUT).endsWith(SCROLL).build(); - this.longFormUsagePattern = builder.concernedNode(SEQUENCE).startsWith(MOUSE_CLICK).contains(fillFormPattern).endsWith(MOUSE_CLICK).build(); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usability.rules.UsabilityRule#check() - */ - @Override - public Optional check() { - Optional present = Optional.absent(); - if(this.longFormUsagePattern.containedIn(taskModel)) { - present = Optional.of(this.defect); - } - return present; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usability.rules.UsabilityRule#callEvaluationMetho(de.ugoe.cs.autoquest.usability.EvaluationMethodCaller) - */ - @Override - public Optional callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller) - { - return evaluationMethodCaller.check(this); - } -} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/LongFormUsageProblem.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/LongFormUsageProblem.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/LongFormUsageProblem.java (revision 1217) @@ -0,0 +1,101 @@ +// 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.rules.patterns; + +import static de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter.MOUSE_CLICK; +import static de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter.SCROLL; +import static de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter.TEXT_INPUT; +import static de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter.ITERATION; +import static de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter.SEQUENCE; + +import com.google.common.base.Optional; + +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; +import de.ugoe.cs.autoquest.usability.EvaluationMethodCaller; +import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescriptionResolver; +import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription; +import de.ugoe.cs.autoquest.usability.rules.UsabilityRule; +import de.ugoe.cs.autoquest.usability.rules.UsabilityUsageProblem; + +/** + *

+ * TODO comment + *

+ * + * @author Alexander Deicke + */ +public class LongFormUsageProblem extends UsabilityRule implements UsabilityUsageProblem { + + private InteractionPattern longFormUsagePattern; + + /** + *

+ * TODO: comment + *

+ * + * @param taskTree + */ + public LongFormUsageProblem(ITaskModel taskModel) { + super(taskModel); + this.name = "LongFormUsagePattern"; + this.defect = + new UsabilityProblemDescriptionResolver().descriptionFor(this.getClass() + .getSimpleName()); + initUsagePattern(); + } + + /** + *

+ * TODO: comment + *

+ * + */ + private void initUsagePattern() { + InteractionPattern fillFormPattern = + InteractionPatternBuilder.newPattern().rootTask(ITERATION).startsWithEvent(TEXT_INPUT) + .endsWithEvent(SCROLL).patternFinished().build(); + this.longFormUsagePattern = + InteractionPatternBuilder.newPattern().rootTask(SEQUENCE).startsWithEvent(MOUSE_CLICK) + .containsPattern(fillFormPattern).endsWithEvent(MOUSE_CLICK).patternFinished() + .build(); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usability.rules.UsabilityRule#check() + */ + @Override + public Optional check() { + Optional present = Optional.absent(); + if (this.longFormUsagePattern.containedIn(taskModel)) { + present = Optional.of(this.defect); + } + return present; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usability.rules.UsabilityRule#callEvaluationMetho(de.ugoe.cs.autoquest + * .usability.EvaluationMethodCaller) + */ + @Override + public Optional callEvaluationMethod(EvaluationMethodCaller evaluationMethodCaller) + { + return evaluationMethodCaller.check(this); + } +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/ContainsEventVisitor.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/ContainsEventVisitor.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/ContainsEventVisitor.java (revision 1217) @@ -22,6 +22,6 @@ import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPatternVisitor; -import de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; /** @@ -38,5 +38,5 @@ * TODO: comment *

- * + * * @param containsType */ @@ -46,6 +46,10 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IIteration) */ public void visit(IIteration iteration) { @@ -53,6 +57,10 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IOptional) */ public void visit(IOptional optional) { @@ -60,11 +68,15 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .ISequence) */ public void visit(ISequence sequence) { checkAllChildrenAndReturnIfPatternIsPresent(sequence.getChildren()); } - + private void checkAllChildrenAndReturnIfPatternIsPresent(List children) { for (ITask task : children) { Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/ContainsInteractionPatternVisitor.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/ContainsInteractionPatternVisitor.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/ContainsInteractionPatternVisitor.java (revision 1217) @@ -22,5 +22,5 @@ import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPattern; import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPatternVisitor; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; /** @@ -37,14 +37,20 @@ * TODO: comment *

- * + * * @param containsPattern */ - public ContainsInteractionPatternVisitor(InteractionPattern containsPattern, TaskTypeFilter taskType) { + public ContainsInteractionPatternVisitor(InteractionPattern containsPattern, + TaskTypeFilter taskType) + { this.containedPattern = containsPattern; this.taskType = taskType; } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IIteration) */ public void visit(IIteration iteration) { @@ -52,6 +58,10 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IOptional) */ public void visit(IOptional optional) { @@ -59,14 +69,18 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .ISequence) */ public void visit(ISequence sequence) { checkAllChildrenAndReturnIfPatternIsPresent(sequence); } - + private void checkAllChildrenAndReturnIfPatternIsPresent(ISequence sequence) { for (ITask child : sequence.getChildren()) { - if(checkTaskAndReturnIfPatternIsPresent(child)) { + if (checkTaskAndReturnIfPatternIsPresent(child)) { this.present = true; break; @@ -74,10 +88,11 @@ } } - + private boolean checkTaskAndReturnIfPatternIsPresent(ITask task) { - if(isEvent(task)) return false; + if (isEvent(task)) + return false; return this.containedPattern.containedIn(task); } - + private boolean isEvent(ITask task) { return task instanceof IEventTask; Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/EndsWithEventVisitor.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/EndsWithEventVisitor.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/EndsWithEventVisitor.java (revision 1217) @@ -19,6 +19,6 @@ import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence; import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPatternVisitor; -import de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; import de.ugoe.cs.autoquest.usability.util.PatternsVisitorUtil; @@ -36,5 +36,5 @@ * TODO: comment *

- * + * * @param eventType */ @@ -44,6 +44,10 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IIteration) */ public void visit(IIteration iteration) { @@ -51,6 +55,10 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IOptional) */ public void visit(IOptional optional) { @@ -58,10 +66,14 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .ISequence) */ public void visit(ISequence sequence) { - PatternsVisitorUtil.lastNodeOf(sequence.getChildren()).accept(this); + PatternsVisitorUtil.lastSubTaskOf(sequence.getChildren()).accept(this); } - + } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/EndsWithInteractionPatternVisitor.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/EndsWithInteractionPatternVisitor.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/EndsWithInteractionPatternVisitor.java (revision 1217) @@ -22,5 +22,5 @@ import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPattern; import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPatternVisitor; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; import de.ugoe.cs.autoquest.usability.util.PatternsVisitorUtil; @@ -38,36 +38,51 @@ * TODO: comment *

- * + * * @param endsWithPattern */ - public EndsWithInteractionPatternVisitor(InteractionPattern endsWithPattern, TaskTypeFilter taskType) { + public EndsWithInteractionPatternVisitor(InteractionPattern endsWithPattern, + TaskTypeFilter taskType) + { this.containedPattern = endsWithPattern; this.taskType = taskType; } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IIteration) */ public void visit(IIteration iteration) { - this.present = containedPattern.containedIn(iteration); + this.present = containedPattern.containedIn(iteration); } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IOptional) */ public void visit(IOptional optional) { - this.present = containedPattern.containedIn(optional); + this.present = containedPattern.containedIn(optional); } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .ISequence) */ public void visit(ISequence sequence) { - ITask lastTask = PatternsVisitorUtil.lastNodeOf(sequence.getChildren()); - if(isEvent(lastTask)) { + ITask lastTask = PatternsVisitorUtil.lastSubTaskOf(sequence.getChildren()); + if (isEvent(lastTask)) { this.present = containedPattern.containedIn(sequence); - } else { + } + else { this.present = containedPattern.containedIn(lastTask); - } + } } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/StartsWithEventVisitor.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/StartsWithEventVisitor.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/StartsWithEventVisitor.java (revision 1217) @@ -19,6 +19,6 @@ import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence; import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPatternVisitor; -import de.ugoe.cs.autoquest.usability.tasktree.filters.EventTypeFilter; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; import de.ugoe.cs.autoquest.usability.util.PatternsVisitorUtil; @@ -36,5 +36,5 @@ * TODO: comment *

- * + * * @param eventType */ @@ -44,13 +44,21 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IIteration) */ public void visit(IIteration iteration) { iteration.getMarkedTask().accept(this); } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional) + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IOptional) */ public void visit(IOptional optional) { @@ -58,10 +66,14 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .ISequence) */ public void visit(ISequence sequence) { - PatternsVisitorUtil.firstNodeOf(sequence.getChildren()).accept(this); + PatternsVisitorUtil.firstSubtaskOf(sequence.getChildren()).accept(this); } - + } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/StartsWithInteractionPatternVisitor.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/StartsWithInteractionPatternVisitor.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/patterns/visitors/StartsWithInteractionPatternVisitor.java (revision 1217) @@ -22,5 +22,5 @@ import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPattern; import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPatternVisitor; -import de.ugoe.cs.autoquest.usability.tasktree.filters.TaskTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; import de.ugoe.cs.autoquest.usability.util.PatternsVisitorUtil; @@ -38,36 +38,51 @@ * TODO: comment *

- * + * * @param startsWithPattern */ - public StartsWithInteractionPatternVisitor(InteractionPattern startsWithPattern, TaskTypeFilter taskType) { + public StartsWithInteractionPatternVisitor(InteractionPattern startsWithPattern, + TaskTypeFilter taskType) + { this.containedPattern = startsWithPattern; this.taskType = taskType; } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IIteration) */ public void visit(IIteration iteration) { - this.present = containedPattern.containedIn(iteration); + this.present = containedPattern.containedIn(iteration); } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .IOptional) */ public void visit(IOptional optional) { - this.present = containedPattern.containedIn(optional); + this.present = containedPattern.containedIn(optional); } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor#visit(de.ugoe.cs.autoquest.tasktrees.treeifc + * .ISequence) */ public void visit(ISequence sequence) { - ITask firstTask = PatternsVisitorUtil.firstNodeOf(sequence.getChildren()); - if(isEvent(firstTask)) { + ITask firstTask = PatternsVisitorUtil.firstSubtaskOf(sequence.getChildren()); + if (isEvent(firstTask)) { this.present = containedPattern.containedIn(sequence); - } else { + } + else { this.present = containedPattern.containedIn(firstTask); - } + } } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/FilterResult.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/FilterResult.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/FilterResult.java (revision 1217) @@ -0,0 +1,75 @@ +// 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.taskmodel.filter; + +import java.util.List; + +import com.google.common.base.Predicate; +import com.google.common.collect.Lists; + +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; + +/** + *

+ * TODO comment + *

+ * + * @author Alexander Deicke + */ +public class FilterResult { + + @SuppressWarnings("rawtypes") + private final Predicate filterPredicate; + + private List filteredTasks = Lists.newArrayList(); + + private List tasksNotMatchedFilter = Lists.newArrayList(); + + @SuppressWarnings("rawtypes") + public FilterResult(Predicate filterPredicate) { + this.filterPredicate = filterPredicate; + } + + @SuppressWarnings("unchecked") + public void addTask(ITask task) { + boolean notFilteredYet = + !filteredTasks.contains(task) && !tasksNotMatchedFilter.contains(task); + if (notFilteredYet) { + if (filterPredicate.apply(task)) { + filteredTasks.add(task); + } + else { + tasksNotMatchedFilter.add(task); + } + } + } + + public List tasksMatchedFilter() { + return this.filteredTasks; + } + + public int nrOfTasksMatchedFilter() { + return this.filteredTasks.size(); + } + + public List tasksNotMatchedFilter() { + return this.tasksNotMatchedFilter; + } + + public int nrOfTasksNotMatchedFilter() { + return this.tasksNotMatchedFilter.size(); + } + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/IterativeDFSFilterStrategy.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/IterativeDFSFilterStrategy.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/IterativeDFSFilterStrategy.java (revision 1217) @@ -0,0 +1,99 @@ +// 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.taskmodel.filter; + +import java.util.LinkedList; +import java.util.Queue; + +import com.google.common.base.Predicate; + +import de.ugoe.cs.autoquest.eventcore.IEventTarget; +import de.ugoe.cs.autoquest.eventcore.IEventType; +import de.ugoe.cs.autoquest.tasktrees.treeifc.IMarkingTemporalRelationship; +import de.ugoe.cs.autoquest.tasktrees.treeifc.IStructuringTemporalRelationship; +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTargetFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; + +/** + *

+ * TODO comment + *

+ * + * @author Alexander Deicke + */ +public class IterativeDFSFilterStrategy implements TaskModelFilterStrategy { + + private FilterResult filterStatistic; + + @SuppressWarnings("unchecked") + @Override + public FilterResult filter(ITaskModel taskModel, EventTargetFilter eventTarget) { + Predicate filterPredicate = eventTarget.filterPredicate(); + this.filterStatistic = new FilterResult(filterPredicate); + traverse(taskModel); + return this.filterStatistic; + } + + @SuppressWarnings("unchecked") + @Override + public FilterResult filter(ITaskModel taskModel, EventTypeFilter eventType) { + Predicate filterPredicate = eventType.filterPredicate(); + this.filterStatistic = new FilterResult(filterPredicate); + traverse(taskModel); + return this.filterStatistic; + } + + @SuppressWarnings("unchecked") + @Override + public FilterResult filter(ITaskModel taskModel, TaskTypeFilter nodeType) { + Predicate filterPredicate = nodeType.filterPredicate(); + this.filterStatistic = new FilterResult(filterPredicate); + traverse(taskModel); + return this.filterStatistic; + } + + private void traverse(ITaskModel taskModel) { + Queue unvisitedTasks = new LinkedList(); + unvisitedTasks.addAll(taskModel.getTasks()); + while (stillUnvisitedTasks(unvisitedTasks)) { + ITask task = unvisitedTasks.poll(); + processCurrentTask(task); + processChildrenOfCurrentTask(unvisitedTasks, task); + } + } + + private boolean stillUnvisitedTasks(Queue unvisitedTasks) { + return !unvisitedTasks.isEmpty(); + } + + private void processCurrentTask(ITask task) { + this.filterStatistic.addTask(task); + } + + private void processChildrenOfCurrentTask(Queue unvisitedTasks, ITask task) { + if (task instanceof IStructuringTemporalRelationship) { + for (ITask child : ((IStructuringTemporalRelationship) task).getChildren()) { + unvisitedTasks.add(child); + } + } + else if (task instanceof IMarkingTemporalRelationship) { + unvisitedTasks.add(((IMarkingTemporalRelationship) task).getMarkedTask()); + } + } + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/TaskModelFilterStrategy.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/TaskModelFilterStrategy.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/TaskModelFilterStrategy.java (revision 1217) @@ -0,0 +1,37 @@ +// 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.taskmodel.filter; + +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTargetFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.EventTypeFilter; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.types.TaskTypeFilter; + +/** + *

+ * TODO comment + *

+ * + * @author Alexander Deicke + */ +public interface TaskModelFilterStrategy { + + public FilterResult filter(ITaskModel taskModel, EventTargetFilter eventTarget); + + public FilterResult filter(ITaskModel taskModel, EventTypeFilter eventType); + + public FilterResult filter(ITaskModel taskModel, TaskTypeFilter nodeType); + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/EventTargetFilter.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/EventTargetFilter.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/EventTargetFilter.java (revision 1217) @@ -0,0 +1,89 @@ +// 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.taskmodel.filter.types; + +import com.google.common.base.Function; +import com.google.common.base.Predicate; +import com.google.common.base.Predicates; + +import de.ugoe.cs.autoquest.eventcore.IEventTarget; +import de.ugoe.cs.autoquest.eventcore.guimodel.ITextArea; +import de.ugoe.cs.autoquest.eventcore.guimodel.ITextField; +import de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask; +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; + +/** + *

+ * Event target filter for {@link EventTask}s. + *

+ * + * @author Alexander Deicke + */ +public enum EventTargetFilter implements TaskFilter { + + TEXT_FIELD(ITextField.class), + + TEXT_AREA(ITextArea.class); + + private Class eventTargetClazz; + + private EventTargetFilter(Class eventTargetClazz) { + this.eventTargetClazz = eventTargetClazz; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usability.tasktree.filters.TaskFilter#getId() + */ + @SuppressWarnings("unchecked") + @Override + public Class clazz() { + return (Class) eventTargetClazz; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usability.tasktree.filters.TaskFilter#getId() + */ + @SuppressWarnings("rawtypes") + @Override + public Predicate filterPredicate() { + Predicate instanceOfIEventTaskPredicate = Predicates.instanceOf(IEventTask.class); + Predicate taskHoldsInstanceOfFilterArgument = + Predicates.compose(Predicates.instanceOf(eventTargetClazz), taskExtractionFunction()); + return Predicates.and(instanceOfIEventTaskPredicate, taskHoldsInstanceOfFilterArgument); + } + + /** + * + *

+ * Gets the event target of a {@link ITask}. + *

+ * + * @return event target + */ + private Function taskExtractionFunction() { + return new Function() { + + @Override + public IEventTarget apply(ITask task) { + return ((IEventTask) task).getEventTarget(); + } + }; + } + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/EventTypeFilter.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/EventTypeFilter.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/EventTypeFilter.java (revision 1217) @@ -0,0 +1,100 @@ +// 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.taskmodel.filter.types; + +import com.google.common.base.Function; +import com.google.common.base.Predicate; +import com.google.common.base.Predicates; + +import de.ugoe.cs.autoquest.eventcore.IEventType; +import de.ugoe.cs.autoquest.eventcore.gui.IInteraction; +import de.ugoe.cs.autoquest.eventcore.gui.MouseButtonInteraction; +import de.ugoe.cs.autoquest.eventcore.gui.MouseClick; +import de.ugoe.cs.autoquest.eventcore.gui.MouseInteraction; +import de.ugoe.cs.autoquest.eventcore.gui.Scroll; +import de.ugoe.cs.autoquest.eventcore.gui.TextInput; +import de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask; +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; + +/** + *

+ * Event type filter for {@link EventTask}s. + *

+ * + * @author Alexander Deicke + */ +public enum EventTypeFilter implements TaskFilter { + + MOUSE_BUTTON_INTERACTION(MouseButtonInteraction.class), + + MOUSE_CLICK(MouseClick.class), + + MOUSE_INTERACTION(MouseInteraction.class), + + TEXT_INPUT(TextInput.class), + + SCROLL(Scroll.class), + + USER_INTERACTION(IInteraction.class); + + private Class eventTypeClazz; + + private EventTypeFilter(Class eventTypeClazz) { + this.eventTypeClazz = eventTypeClazz; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usability.tasktree.filters.TaskFilter#getId() + */ + @SuppressWarnings("unchecked") + @Override + public Class clazz() { + return (Class) eventTypeClazz; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usability.tasktree.filters.TaskFilter#getId() + */ + @SuppressWarnings("rawtypes") + @Override + public Predicate filterPredicate() { + Predicate instanceOfIEventTaskPredicate = Predicates.instanceOf(IEventTask.class); + Predicate taskHoldsInstanceOfFilterArgument = + Predicates.compose(Predicates.instanceOf(eventTypeClazz), taskExtractionFunction()); + return Predicates.and(instanceOfIEventTaskPredicate, taskHoldsInstanceOfFilterArgument); + } + + /** + * + *

+ * Gets the event type of a {@link ITask}. + *

+ * + * @return event type + */ + private Function taskExtractionFunction() { + return new Function() { + + @Override + public IEventType apply(ITask task) { + return ((IEventTask) task).getEventType(); + } + }; + } +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskFilter.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskFilter.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskFilter.java (revision 1217) @@ -0,0 +1,49 @@ +// 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.taskmodel.filter.types; + +import com.google.common.base.Predicate; + +/** + *

+ * A task filter allows to filter a collection of tasks, considering a provided predicate. + *

+ * + * @author Alexander Deicke + */ +public interface TaskFilter { + + /** + * + *

+ * {@link Class} of type or property, which is used to filter tasks. + *

+ * + * @return + */ + public Class clazz(); + + /** + * + *

+ * Provides predicate to filter tasks. + *

+ * + * @return + */ + @SuppressWarnings("rawtypes") + public Predicate filterPredicate(); + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskModelFilter.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskModelFilter.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskModelFilter.java (revision 1217) @@ -0,0 +1,92 @@ +// 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.taskmodel.filter.types; + +import com.google.common.base.Preconditions; + +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.FilterResult; +import de.ugoe.cs.autoquest.usability.taskmodel.filter.TaskModelFilterStrategy; + +/** + *

+ * TODO comment + *

+ * + * @author Alexander Deicke + */ +public class TaskModelFilter { + + private final TaskModelFilterStrategy taskModelFilterStrategy; + + public TaskModelFilter(TaskModelFilterStrategy treeTraversalStrategy) { + Preconditions.checkNotNull(treeTraversalStrategy); + this.taskModelFilterStrategy = treeTraversalStrategy; + } + + public FilterEventTargetStep filterByEventTarget(EventTargetFilter eventTarget) { + return new FilterEventTargetStep(eventTarget); + } + + public FilterEventTypeStep filterByEventType(EventTypeFilter eventType) { + return new FilterEventTypeStep(eventType); + } + + public FilterNodeTypeStep filterByNodeType(TaskTypeFilter nodeType) { + return new FilterNodeTypeStep(nodeType); + } + + public class FilterEventTargetStep { + + private final EventTargetFilter eventTarget; + + public FilterEventTargetStep(EventTargetFilter eventTarget) { + this.eventTarget = eventTarget; + } + + public FilterResult from(ITaskModel taskModel) { + return taskModelFilterStrategy.filter(taskModel, eventTarget); + } + + } + + public class FilterEventTypeStep { + + private final EventTypeFilter eventType; + + public FilterEventTypeStep(EventTypeFilter eventType) { + this.eventType = eventType; + } + + public FilterResult from(ITaskModel taskModel) { + return taskModelFilterStrategy.filter(taskModel, eventType); + } + + } + + public class FilterNodeTypeStep { + + private final TaskTypeFilter nodeType; + + public FilterNodeTypeStep(TaskTypeFilter nodeType) { + this.nodeType = nodeType; + } + + public FilterResult from(ITaskModel taskModel) { + return taskModelFilterStrategy.filter(taskModel, nodeType); + } + + } +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskTypeFilter.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskTypeFilter.java (revision 1217) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/taskmodel/filter/types/TaskTypeFilter.java (revision 1217) @@ -0,0 +1,71 @@ +// 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.taskmodel.filter.types; + +import com.google.common.base.Predicate; +import com.google.common.base.Predicates; + +import de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask; +import de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration; +import de.ugoe.cs.autoquest.tasktrees.treeifc.ISelection; +import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence; +import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; + +/** + *

+ * Task type filter for {@link ITask}s. + *

+ * + * @author Alexander Deicke + */ +public enum TaskTypeFilter implements TaskFilter { + + EVENT_TASK_NODE(IEventTask.class), + + ITERATION(IIteration.class), + + SEQUENCE(ISequence.class), + + SELECTION(ISelection.class); + + private Class taskTypeClazz; + + private TaskTypeFilter(Class taskTypeClazz) { + this.taskTypeClazz = taskTypeClazz; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usability.tasktree.filters.TaskFilter#getId() + */ + @SuppressWarnings("unchecked") + @Override + public Class clazz() { + return (Class) this.taskTypeClazz; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usability.tasktree.filters.TaskFilter#getId() + */ + @SuppressWarnings("rawtypes") + @Override + public Predicate filterPredicate() { + return Predicates.instanceOf(taskTypeClazz); + } + +} Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/NullNode.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/NullNode.java (revision 1213) +++ (revision ) @@ -1,79 +1,0 @@ -// 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.util; - -import org.apache.commons.lang.StringUtils; - -import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; -import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor; - -/** - *

- * TODO comment - *

- * - * @author Alexander Deicke - */ -public class NullNode implements ITask { - - - /** - * - */ - private static final long serialVersionUID = -3325477932754494485L; - - @Override - public int getId() { - return 0; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#getName() - */ - public String getName() { - return StringUtils.EMPTY; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#getDescription() - */ - public String getDescription() { - return StringUtils.EMPTY; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#equals(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode) - */ - public boolean equals(ITask task) { - return false; - } - - /* (non-Javadoc) - * @see java.lang.Object#clone() - */ - @Override - public NullNode clone() { - return (NullNode) this; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor) - */ - public void accept(ITaskVisitor visitor) { - - } - -} - Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/NullTask.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/NullTask.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/NullTask.java (revision 1217) @@ -22,5 +22,5 @@ /** *

- * TODO comment + * Implementation of Null Object pattern {@link http://en.wikipedia.org/wiki/Null_Object_pattern}. *

* @@ -29,8 +29,9 @@ public class NullTask implements ITask { - /** */ private static final long serialVersionUID = 1236779392413787860L; - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getId() */ @@ -39,6 +40,8 @@ return -1; } - - /* (non-Javadoc) + + /* + * (non-Javadoc) + * * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#getName() */ @@ -47,5 +50,7 @@ } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#getDescription() */ @@ -54,12 +59,18 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#equals(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#equals(de.ugoe.cs.autoquest.tasktrees + * .treeifc.ITaskTreeNode) */ public boolean equals(ITask task) { return false; } - - /* (non-Javadoc) + + /* + * (non-Javadoc) + * * @see java.lang.Object#clone() */ @@ -69,11 +80,14 @@ } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskTreeNode#accept(de.ugoe.cs.autoquest.tasktrees + * .treeifc.NodeVisitor) */ public void accept(ITaskVisitor visitor) { // do nothing } - + } - Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/PatternsVisitorUtil.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/PatternsVisitorUtil.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/PatternsVisitorUtil.java (revision 1217) @@ -15,16 +15,14 @@ package de.ugoe.cs.autoquest.usability.util; -import java.util.List; +import java.util.Collection; import com.google.common.collect.Iterables; import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; -import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel; -import de.ugoe.cs.autoquest.tasktrees.treeifc.IUserSession; -import de.ugoe.cs.autoquest.tasktrees.treeimpl.TaskFactory; +import de.ugoe.cs.autoquest.usability.rules.patterns.InteractionPatternVisitor; /** *

- * TODO comment + * Util class for {@link InteractionPatternVisitor}. *

* @@ -36,26 +34,15 @@ // no instantiation } - + /** *

- * TODO: comment + * Gets the first sub task. *

- * - * @param taskTreeNode - * @return + * + * @param tasks + * collection of tasks + * @return first sub task */ - public static ITaskModel createTaskModelFromUserSessions(List userSessions) { - return new TaskFactory().createTaskModel(userSessions); - } - - /** - *

- * TODO: comment - *

- * - * @param taskTreeNodes - * @return - */ - public static ITask firstNodeOf(List tasks) { + public static ITask firstSubtaskOf(Collection tasks) { return Iterables.getFirst(tasks, new NullTask()); } @@ -63,13 +50,14 @@ /** *

- * TODO: comment + * Gets the last sub task. *

- * - * @param taskTreeNodes - * @return + * + * @param tasks + * collection of tasks + * @return last sub task */ - public static ITask lastNodeOf(List tasks) { + public static ITask lastSubTaskOf(Collection tasks) { return Iterables.getLast(tasks, new NullTask()); } - + } Index: trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/TextInputUtil.java =================================================================== --- trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/TextInputUtil.java (revision 1213) +++ trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/util/TextInputUtil.java (revision 1217) @@ -31,5 +31,5 @@ /** *

- * TODO comment + * Util class to handle text input events/tasks. *

* @@ -42,4 +42,14 @@ } + /** + * + *

+ * Returns all entered words and signs of text input events. + *

+ * + * @param tasksWithTextInputEvents + * tasks with event type {@link TextInput} + * @return set of all entered word and signs with unique entries + */ public static Multiset aggregateEnteredTextFromTextInputs(List tasksWithTextInputEvents) { @@ -52,11 +62,20 @@ } + /** + * + *

+ * Splits entered text into words and signs. + *

+ * + * @param enteredText + * entered text (e.g. from text input event) + * @return collection of words and signs + */ public static Iterable splitTextIntoWordsAndSigns(String enteredText) { CharMatcher onlyWords = - CharMatcher.WHITESPACE.or(CharMatcher - .forPredicate(characterIsJavaIdentifierPartPredicate())); + CharMatcher.WHITESPACE.or(CharMatcher.forPredicate(characterIsNoJavaIdentifierPart())); CharMatcher onlySigns = - CharMatcher.WHITESPACE.or(CharMatcher - .forPredicate(characterIsJavaIdentifierPartPredicate()).negate()); + CharMatcher.WHITESPACE.or(CharMatcher.forPredicate(characterIsNoJavaIdentifierPart()) + .negate()); Iterable words = Splitter.on(onlyWords).omitEmptyStrings().trimResults().split(enteredText); @@ -66,5 +85,13 @@ } - public static Predicate characterIsJavaIdentifierPartPredicate() { + /** + * + *

+ * Determines, if a character is not part of a Java identifier. + *

+ * + * @return true, iff no part of Java identifier + */ + public static Predicate characterIsNoJavaIdentifierPart() { return new Predicate() { @@ -77,5 +104,13 @@ } - public static Predicate characterIsLetterOrDigitPredicate() { + /** + * + *

+ * Determines if the specified character is not a letter or digit. + *

+ * + * @return + */ + public static Predicate characterIsNoLetterOrDigitPredicate() { return new Predicate() {