Changeset 1401 for trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskHandlingStrategy.java

Timestamp:

02/26/14 17:12:53 (10 years ago)

Author:

pharms

Message:

• added some JavaDoc? comments

File:

• trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskHandlingStrategy.java (modified) (6 diffs)

trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskHandlingStrategy.java

@@ -17 +17 @@
 import de.ugoe.cs.autoquest.tasktrees.taskequality.TaskEquality;
 import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance;
-import de.ugoe.cs.autoquest.usageprofiles.DefaultSymbolMap;
 import de.ugoe.cs.autoquest.usageprofiles.SymbolComparator;
 import de.ugoe.cs.autoquest.usageprofiles.SymbolMap;
@@ -24 +23 @@
 /**
  * <p>
- * TODO comment
+ * concrete implementation of a symbol strategy required in the creation of a
+ * {@link de.ugoe.cs.autoquest.usageprofiles.Trie}. The strategy can be parameterized with a
+ * considered task equality. It uses task instance comparators to perform task comparison.
+ * It creates task specific symbol maps, which are {@link TaskSymbolIdentityMap} and
+ * {@link TaskSymbolBucketedMap} depending on the level of considered task equality.
  * </p>
  * 
@@ -35 +38 @@
 
     /**
-     * 
+     * <p>
+     * the level of task equality considered in this task handling strategy
+     * </p>
      */
     private TaskEquality consideredEquality;
 
     /**
-     * 
+     * <p>
+     * the comparator used for task comparisons
+     * </p>
      */
     private TaskInstanceComparator comparator;
@@ -46 +53 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes this strategy with a task equality to be considered for task comparisons
      * </p>
      *
-     * @param consideredEquality
+     * @param consideredEquality the task equality to be considered for task comparisons
      */
     public TaskHandlingStrategy(TaskEquality consideredEquality) {
@@ -72 +79 @@
     /**
      * <p>
-     * TODO: comment
+     * convenience method to have a correctly typed return value as alternative to
+     * {@link #getSymbolComparator()};
      * </p>
-     *
-     * @return
      */
     public TaskInstanceComparator getTaskComparator() {
@@ -95 +101 @@
 
     /* (non-Javadoc)
-     * @see de.ugoe.cs.autoquest.usageprofiles.SymbolStrategy#copySymbolMap(de.ugoe.cs.autoquest.usageprofiles.SymbolMap)
+     * @see de.ugoe.cs.autoquest.usageprofiles.SymbolStrategy#copySymbolMap(SymbolMap)
      */
     @Override
     public <V> SymbolMap<ITaskInstance, V> copySymbolMap(SymbolMap<ITaskInstance, V> other) {
         if (consideredEquality == TaskEquality.IDENTICAL) {
-            return new DefaultSymbolMap<ITaskInstance, V>(other);
+            return new TaskSymbolIdentityMap<V>(other);
         }
         else {