Changeset 1186 for trunk

Timestamp:

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

Author:

pharms

Message:

• improved java doc

Location:

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

Files:

• DefaultSymbolComparator.java (modified) (1 diff)
• Trie.java (modified) (2 diffs)
• TrieProcessor.java (modified) (3 diffs)

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

@@ -26 +26 @@
 public class DefaultSymbolComparator<T> implements SymbolComparator<T> {
 
+    /**  */
+    private static final long serialVersionUID = 1L;
+
     /* (non-Javadoc)
      * @see de.ugoe.cs.autoquest.tasktrees.temporalrelation.SymbolComparator#equals(java.lang.Object, java.lang.Object)

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

@@ -324 +324 @@
     
     /**
-     * 
+     * <p>
+     * used to recursively process the trie. The provided processor will be called for any path
+     * through the tree. The processor may abort the processing through returns values of its
+     * {@link TrieProcessor#process(List, int)} method.
+     * </p>
+     * 
+     * @param processor the processor to process the tree
      */
     public void process(TrieProcessor<T> processor) {
@@ -338 +344 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     * @param context 
-     *
-     * @param child
-     * @param processor
+     * processes a specific path by calling the provided processor. Furthermore, the method
+     * calls itself recursively for further subpaths.
+     * </p>
+     * 
+     * @param context   the context of the currently processed trie node, i.e. the preceeding
+     *                  symbols
+     * @param child     the processed trie node
+     * @param processor the processor used for processing the trie
+     * 
+     * @return true, if processing shall continue, false else
      */
     private boolean process(LinkedList<T>    context,

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);