- * TODO comment + * Utility class to transform a task tree to a plain text representation *
* Index: /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/MostSimilarTaskDeterminer.java =================================================================== --- /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/MostSimilarTaskDeterminer.java (revision 2257) +++ /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/MostSimilarTaskDeterminer.java (revision 2258) @@ -77,8 +77,8 @@ private Set- * TODO: comment + * static convenience method to compare two task traversals using a given comparator to compare + * the individual tasks in the traversals. *
- * - * @param traversal1 - * @param traversal2 - * @param comparator - * @return */ public static SimilarTasks compareTraversals(TaskTraversal traversal1, @@ -268,5 +264,6 @@ /** *- * TODO: comment + * returns true, if the differences between the traversals are between the beginning and the + * end of both traversals. *
* Index: /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTraversal.java =================================================================== --- /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTraversal.java (revision 2257) +++ /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTraversal.java (revision 2258) @@ -30,5 +30,14 @@ /** *- * TODO comment + * A task traversal represents a list of task paths through a task tree. Traversal may represent all + * possible task paths. In this case, all paths start with the root node and end with the leaf + * nodes. It is also possible to exclude the traversal of a certain parent node. In this case, the + * traversal does not contain paths to the children of this parent but only a single path to the + * parent itself. For selections, this is always the case. I.e., a traversal never contains paths + * were a selection is contained and where it is not the last element of the path. In addition, + * if the only child of a marking temporal relationship is an event task, then the marking + * temporal relationship is not added to the paths. The reason is, that from a task path point of + * view, this information is inherently present. Task traversals offer a good way to derive easily + * comparable task tree representations. This allows for efficient detection of similar tasks. *
* Index: /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTreeEncoder.java =================================================================== --- /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTreeEncoder.java (revision 2257) +++ /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTreeEncoder.java (revision 2258) @@ -43,5 +43,6 @@ /** - * TODO comment + * Convenience class to encode user sessions, task instance lists, task instances or tasks into + * a human readable textual representation. * * @version $Revision: $ $Date: 01.04.2012$ Index: /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTreeValidator.java =================================================================== --- /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTreeValidator.java (revision 2257) +++ /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/utils/TaskTreeValidator.java (revision 2258) @@ -38,5 +38,8 @@ /** *- * TODO comment + * Convenience class to validate if certain restrictions to task trees and task tree instances + * apply. Restrictions are, e.g., that for every task there need to be instances or that for every + * sequence instance the children match the corresponding sequence model. This class is vor test and + * evaluation purposes only. *
* @@ -300,8 +303,6 @@ /** *- * TODO: comment - *
- * - * @param string + * convenience method to log throw issues found during the evaluation + * */ private void fail(ITask task, String message) { @@ -315,9 +316,6 @@ /** *- * TODO: comment - *
- * - * @param string - * @param task + * convenience method to log throw issues found during the evaluation + * */ private void assertNotNull(ITask task, String message, Object object) { @@ -333,9 +331,6 @@ /** *- * TODO: comment - *
- * - * @param string - * @param found + * convenience method to log throw issues found during the evaluation + * */ private void assertTrue(ITask task, String message, boolean value) { @@ -351,9 +346,6 @@ /** *- * TODO: comment - *
- * - * @param string - * @param found + * convenience method to log throw issues found during the evaluation + * */ private void assertFalse(ITask task, String message, boolean value) { @@ -369,10 +361,6 @@ /** *- * TODO: comment - *
- * - * @param string - * @param childTask - * @param task + * convenience method to log throw issues found during the evaluation + * */ private void assertEquals(ITask task, String message, Object object1, Object object2) { @@ -388,10 +376,6 @@ /** *- * TODO: comment - *
- * - * @param string - * @param childTask - * @param task + * convenience method to log throw issues found during the evaluation + * */ private void assertSame(ITask task, String message, Object object1, Object object2) { Index: /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskPath.java =================================================================== --- /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskPath.java (revision 2257) +++ /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskPath.java (revision 2258) @@ -20,5 +20,12 @@ /** *- * TODO comment + * A task path is a path through a task tree. Conceptually, it is a list of task objects. But the + * plain information about the tasks is not enough for a task path. The reason is, that multiple + * paths through a task tree may be identical because the tasks in the paths are identical. This + * happens, e.g., if a sequence has three children, where the first and the last are the same. Then + * based on the plain task information, it would not be possible to define separate task paths for + * the first and the last child of the sequence. Hence, we also add for each path element the index + * of the element in the list of children of the parent. This index is also considered, when + * comparing task paths. *
* Index: /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskTreeUtils.java =================================================================== --- /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskTreeUtils.java (revision 2257) +++ /trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskTreeUtils.java (revision 2258) @@ -25,5 +25,5 @@ /** *- * TODO comment + * This class only contains convenience methods to gather information about task structures. *
* Index: /trunk/autoquest-test-utils/src/main/java/de/ugoe/cs/autoquest/tasktrees/TaskTreeChecker.java =================================================================== --- /trunk/autoquest-test-utils/src/main/java/de/ugoe/cs/autoquest/tasktrees/TaskTreeChecker.java (revision 2257) +++ /trunk/autoquest-test-utils/src/main/java/de/ugoe/cs/autoquest/tasktrees/TaskTreeChecker.java (revision 2258) @@ -41,5 +41,6 @@ /** - * TODO comment + * This is a convenience class for testing to evaluate if a certain task or task instance structure + * matches a given textual specification for the structure. * * @version $Revision: $ $Date: 01.04.2012$ @@ -306,6 +307,5 @@ /** - * @param task - * @param taskMapCopy + * */ private void assertUserSession(TaskSpec taskSpec, @@ -334,6 +334,5 @@ /** - * @param task - * @param taskMapCopy + * */ private void assertTaskInstance(TaskSpec taskSpec, @@ -497,10 +496,5 @@ /** - *- * TODO: comment - *
- * - * @param taskInstance - * @return + * */ private List- * TODO comment + * Convenience class to validate if certain restrictions to task trees and task tree instances + * apply. Restrictions are, e.g., that for every task there need to be instances or that for every + * sequence instance the children match the corresponding sequence model. This class is vor test and + * evaluation purposes only. *
*