Ignore:
Timestamp:
04/19/13 17:02:50 (11 years ago)
Author:
pharms
Message:
  • improved java doc
Location:
trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/manager
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/manager/ComponentManager.java

    r1146 r1154  
    2323 
    2424/** 
    25  * TODO comment 
     25 * <p> 
     26 * The component manager is the central reference for the distinct submodules required for 
     27 * task tree generation. Such include the temporal relationship rule manager, the task equality 
     28 * rule manager, the default task builder, as well as the default task factory. 
     29 * </p> 
    2630 *  
    27  * @version $Revision: $ $Date: 12.02.2012$ 
    28  * @author 2012, last modified by $Author: patrick$ 
     31 * @version 1.0 
     32 * @author pharms 
    2933 */ 
    3034public class ComponentManager { 
    3135     
    32     /** */ 
     36    /** 
     37     * <p> 
     38     * singleton instance of this class 
     39     * </p> 
     40     */ 
    3341    private static ComponentManager instance; 
    3442 
    35     /** */ 
     43    /** 
     44     * <p> 
     45     * the default temporal relationship rule manager 
     46     * </p> 
     47     */ 
    3648    private TemporalRelationshipRuleManager temporalRelationshipRuleManager; 
    3749 
    38     /** */ 
     50    /** 
     51     * <p> 
     52     * the default task equality rule manager 
     53     * </p> 
     54     */ 
    3955    private TaskEqualityRuleManager taskEqualityRuleManager; 
    4056 
    41     /** */ 
     57    /** 
     58     * <p> 
     59     * the default task builder 
     60     * </p> 
     61     */ 
    4262    private ITaskBuilder taskBuilder; 
    4363 
    44     /** */ 
     64    /** 
     65     * <p> 
     66     * the default task factory 
     67     * </p> 
     68     */ 
    4569    private ITaskFactory taskFactory; 
    4670 
    4771    /** 
    48      * 
     72     * <p> 
     73     * returns the default temporal relationship rule manager 
     74     * </p> 
     75     *  
     76     * @return as described 
    4977     */ 
    5078    public static TemporalRelationshipRuleManager getTemporalRelationshipRuleManager() { 
    … …  
    5381 
    5482    /** 
    55      * 
     83     * <p> 
     84     * returns the default task equality rule manager 
     85     * </p> 
     86     *  
     87     * @return as described 
    5688     */ 
    5789    public static TaskEqualityRuleManager getTaskEqualityRuleManager() { 
    … …  
    6092 
    6193    /** 
    62      * 
     94     * <p> 
     95     * returns the default task builder 
     96     * </p> 
     97     *  
     98     * @return as described 
    6399     */ 
    64100    public static ITaskBuilder getDefaultTaskBuilder() { 
    … …  
    67103 
    68104    /** 
    69      * 
     105     * <p> 
     106     * returns the default task factory 
     107     * </p> 
     108     *  
     109     * @return as described 
    70110     */ 
    71111    public static ITaskFactory getDefaultTaskFactory() { 
    … …  
    74114 
    75115    /** 
    76      *  
     116     * <p> 
     117     * clears the singleton instance. Needed for test purposes to ensure statelessness between 
     118     * tests. 
     119     * </p> 
    77120     */ 
    78121    public static synchronized void clearInstance() { 
    … …  
    81124 
    82125    /** 
    83      * 
     126     * <p> 
     127     * returns the singleton instance of this class 
     128     * </p> 
     129     *  
     130     * @return as described 
    84131     */ 
    85132    private static synchronized ComponentManager getInstance() { 
    … …  
    92139 
    93140    /** 
    94      *  
     141     * <p> 
     142     * initialized the component manager with all it default components which are the temporal 
     143     * relationship rule manager, the task equality rule manager, the default task builder, as 
     144     * well as the default task factory.  
     145     * </p> 
    95146     */ 
    96147    private void init() { 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/manager/TaskTreeManager.java

    r1146 r1154  
    2929 
    3030/** 
    31  * TODO comment 
     31 * <p> 
     32 * The task tree manager is responsible for transforming one or more user sessions into a task 
     33 * model. It can be called by providing a collection of user sessions where the result 
     34 * will be a task model. Furthermore, it can be used by providing single events in their respective 
     35 * order including notifications about where a user session ends. The result is a task model, 
     36 * as well.  
     37 * </p> 
    3238 *  
    33  * @version $Revision: $ $Date: $ 
    34  * @author 2011, last modified by $Author: $ 
     39 * @version 1.0 
     40 * @author pharms 
    3541 */ 
    3642public class TaskTreeManager { 
    3743     
    38     /** */ 
     44    /** 
     45     * <p> 
     46     * the internally used task builder 
     47     * </p> 
     48     */ 
    3949    private ITaskBuilder taskBuilder = ComponentManager.getDefaultTaskBuilder(); 
    4050 
    41     /** */ 
     51    /** 
     52     * <p> 
     53     * the internally used task factory 
     54     * </p> 
     55     */ 
    4256    private ITaskFactory taskFactory = ComponentManager.getDefaultTaskFactory(); 
    4357 
    44     /** */ 
     58    /** 
     59     * <p> 
     60     * if single events are provided, the user sessions collected so far 
     61     * </p> 
     62     */ 
    4563    private List<IUserSession> sessions = null; 
    4664 
    47     /** */ 
     65    /** 
     66     * <p> 
     67     * if single events are provided, the currently collected user session 
     68     * </p> 
     69     */ 
    4870    private IUserSession currentSession = null; 
    4971 
    5072    /** 
    51      * 
     73     * <p> 
     74     * initializes the task tree manager 
     75     * </p> 
    5276     */ 
    5377    public TaskTreeManager() { 
    … …  
    5680 
    5781    /** 
    58      * 
     82     * <p> 
     83     * creates a task model based on the provided user sessions. Yet, the user sessions are 
     84     * list of events. Such will be transformed in into task instances of event tasks assigned 
     85     * to {@link IUserSession}s. The {@link IUserSession}s will then be restructured using 
     86     * the temporal relationship rule manager to detect tasks and respective instances. The 
     87     * results of this transformation is stored in a task model which is the return value of 
     88     * this method. 
     89     * </p> 
     90     *  
     91     * @param newSessions the user sessions of which the task model shall be created 
     92     *  
     93     * @return the task model created from the user sessions 
     94     *  
     95     * @throws IllegalStateException if the task manager is already used by providing it with 
     96     *                               single events 
    5997     */ 
    6098    public synchronized ITaskModel createTaskModel(Collection<List<Event>> newSessions) { 
    … …  
    78116 
    79117    /** 
    80      * 
     118     * <p> 
     119     * handles a single event that occurred in a user session. 
     120     * </p> 
     121     *  
     122     * @param event the event to handle 
    81123     */ 
    82124    public void handleNewEvent(Event event) { 
    … …  
    87129 
    88130    /** 
    89      *  
     131     * <p> 
     132     * used to denote, that all previously added events using {@link #handleNewEvent(Event)} 
     133     * belong to the same session and that this session is now complete. All further events 
     134     * will be added to a new session which may be ended using this method, as well. 
     135     * </p> 
    90136     */ 
    91137    public void finishSession() { 
    … …  
    97143 
    98144    /** 
    99      * 
     145     * <p> 
     146     * returns the task model, that belongs to the events in the user sessions collected so far. 
     147     * </p> 
     148     *  
     149     * @return the task model 
    100150     */ 
    101151    public synchronized ITaskModel getTaskModel() { 
    … …  
    110160 
    111161    /** 
    112      * 
     162     * <p> 
     163     * internally asserts that there is a current session to add new events to 
     164     * </p> 
    113165     */ 
    114166    private void assertSessionSequence() { 
Note: See TracChangeset for help on using the changeset viewer.