Ignore:
Timestamp:
09/12/12 10:57:15 (12 years ago)
Author:
pharms
Message:
  • added some java doc for the classes, which are expected to be quite final
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/quest-core-tasktrees/src/main/java/de/ugoe/cs/quest/tasktrees/temporalrelation/TemporalRelationshipRule.java

    r655 r809  
    66 
    77/** 
    8  * TODO comment 
     8 * <p> 
     9 * a temporal relation ship is able to detected temporal relationships between the child nodes 
     10 * of the parent node provided to the 
     11 * {@link #apply(ITaskTreeNode, ITaskTreeBuilder, ITaskTreeNodeFactory, boolean)} method. A rule 
     12 * created temporal relationships between the child nodes, i.e. substructures in the task tree, if 
     13 * it detects a temporal relationship and it can be sure that it is complete. Incomplete but 
     14 * detected temporal relationships may occur, if there can be more children expected to be added 
     15 * to the provided parent node. This could be the case during parsing a interaction log file of 
     16 * a GUI. 
     17 * </p> 
    918 *  
    10  * @version $Revision: $ $Date: 12.02.2012$ 
    11  * @author 2012, last modified by $Author: patrick$ 
     19 * @author Patrick Harms 
    1220 */ 
    13 public interface TemporalRelationshipRule { 
     21interface TemporalRelationshipRule { 
    1422 
    1523  /** 
    16    * applies the rule to the given situation and returns a rule application result, if this was 
    17    * successful 
     24   * <p> 
     25   * applies the rule to the given parent node. The provided builder and node factory are used 
     26   * to create substructures in the task tree for the identified temporal relationships. The 
     27   * finalize parameter is used to command the rule to finish rule applications, in the case it 
     28   * is known that no further data will be available.  
     29   * </p> 
     30   * <p> 
     31   * The returned rule application result is null, if the rule can not be applied, i.e. it does not 
     32   * detect a temporal relationship. It returns a rule application result with a status 
     33   * {@link RuleApplicationStatus#RULE_APPLICATION_FINISHED} if the rule was applied. The result 
     34   * contains all newly created parent nodes. It returns a rule application result with status 
     35   * {@link RuleApplicationStatus#RULE_APPLICATION_FEASIBLE} if the rule would be applicable if 
     36   * further children would be available in the parent node. This status MUST not be returned if  
     37   * the finalize parameter is true. In this case the rule must be applied or not.  
     38   * </p> 
     39   *  
     40   * @param parent      the parent node with the children to apply the rule on 
     41   * @param builder     the builder to be used for creating substructures for the identified 
     42   *                    temporal relationships 
     43   * @param nodeFactory the node factory to be used for creating substructures for the identified 
     44   *                    temporal relationships 
     45   * @param finalize    true, if the rule shall not expect further children to come and that it 
     46   *                    should therefore be applied in any case 
     47   *                     
     48   * @return the rule application result as described. 
    1849   */ 
    19   public RuleApplicationResult apply(ITaskTreeNode        parent, 
    20                                      ITaskTreeBuilder     builder, 
    21                                      ITaskTreeNodeFactory nodeFactory, 
    22                                      boolean              finalize); 
     50  RuleApplicationResult apply(ITaskTreeNode        parent, 
     51                              ITaskTreeBuilder     builder, 
     52                              ITaskTreeNodeFactory nodeFactory, 
     53                              boolean              finalize); 
    2354   
    2455} 
Note: See TracChangeset for help on using the changeset viewer.