Changeset 1186 for trunk/autoquest-core-usageprofiles/src/main/java/de/ugoe/cs/autoquest/usageprofiles/TrieProcessor.java

Timestamp:

04/29/13 13:56:31 (11 years ago)

Author:

pharms

Message:

• improved java doc

File:

• trunk/autoquest-core-usageprofiles/src/main/java/de/ugoe/cs/autoquest/usageprofiles/TrieProcessor.java (modified) (3 diffs)

trunk/autoquest-core-usageprofiles/src/main/java/de/ugoe/cs/autoquest/usageprofiles/TrieProcessor.java

@@ -19 +19 @@
 /**
  * <p>
- * TODO comment
+ * A trie processor can be used to recursively process a trie. It will be called for each path
+ * stored in the trie. The method called is the {@link #process(List, int)} method. It is provided
+ * with the symbol path and the number of its occurrences. The processor may decide for each
+ * call to the method using its return value, if the processing shall continue, if the path and all
+ * its subsequent symbols can be skipped, or if the whole processing shall be broken up.
  * </p>
  * 
@@ -27 +31 @@
     
     /**
-     * 
+     * <p>
+     * potential results for a call to the {@link TrieProcessor#process(List, int)} method. The
+     * processor may decide for each call to the method using its return value, if the processing
+     * shall continue, if the path and all its subsequent symbols can be skipped, or if the whole
+     * processing shall be broken up.
+     * </p>
      */
     public enum Result {
@@ -34 +43 @@
 
     /**
+     * <p>
+     * called for each path of symbols stored in the trie which is processed. The method is
+     * provided with the symbol path and the number of its occurrences. The processor may decide
+     * for each call to the method using its return value, if the processing shall continue, if
+     * the path and all its subsequent symbols can be skipped, or if the whole processing shall
+     * be broken up.
+     * </p>
      * 
+     * @param sequence the symbol path to be processed
+     * @param count    the number of occurrences of the provided symbol path in the trained
+     *                 sequence
+     *                 
+     * @return as described
      */
     public Result process(List<T> sequence, int count);