Ignore:
Timestamp:
09/05/14 20:20:29 (10 years ago)
Author:
rkrimmel
Message:

Added automatically created javadoc, still needs to be commented properly though

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/SequenceForTaskDetectionRule.java

    r1733 r1734  
    4343import de.ugoe.cs.util.console.Console; 
    4444 
     45// TODO: Auto-generated Javadoc 
    4546/** 
    4647 * <p> 
     
    6667 
    6768        /** 
     69         * The Class MaxCountAndLongestTasksFinder. 
     70         * 
    6871         * @author Patrick Harms 
    6972         */ 
     
    7174                        TrieProcessor<ITaskInstance> { 
    7275 
    73                 /** 
    74                  *  
    75                  */ 
     76                /** The current count. */ 
    7677                private int currentCount; 
    7778 
    78                 /** 
    79                  *  
    80                  */ 
     79                /** The found tasks. */ 
    8180                private final List<List<ITaskInstance>> foundTasks = new LinkedList<List<ITaskInstance>>(); 
    8281 
    8382                /** 
    84                  * 
     83                 * Instantiates a new max count and longest tasks finder. 
    8584                 */ 
    8685                public MaxCountAndLongestTasksFinder() { 
     
    9089 
    9190                /** 
    92                  * @return 
     91                 * Gets the found tasks. 
     92                 * 
     93                 * @return the found tasks 
    9394                 */ 
    9495                public Tasks getFoundTasks() { 
     
    158159 
    159160                /** 
    160                  * 
     161                 * Removes the permutations of shorter tasks. 
    161162                 */ 
    162163                private void removePermutationsOfShorterTasks() { 
     
    189190 
    190191        /** 
    191          *  
     192         * The Class RuleApplicationData. 
    192193         */ 
    193194        private static class RuleApplicationData { 
    194195 
    195                 /** 
    196                  *  
    197                  */ 
     196                /** The sessions. */ 
    198197                private final List<IUserSession> sessions; 
    199198 
    200                 /** 
    201                  *  
    202                  */ 
     199                /** The last trie. */ 
    203200                private TaskInstanceTrie lastTrie; 
    204201 
    205                 /** 
    206                  * default and minimum trained sequence length is 3 
    207                  */ 
     202                /** default and minimum trained sequence length is 3. */ 
    208203                private int trainedSequenceLength = 3; 
    209204 
    210                 /** 
    211                  *  
    212                  */ 
     205                /** The last found tasks. */ 
    213206                private Tasks lastFoundTasks = new Tasks(Integer.MAX_VALUE, null); 
    214207 
    215                 /** 
    216                  *  
    217                  */ 
     208                /** The detected and replaced tasks. */ 
    218209                private boolean detectedAndReplacedTasks; 
    219210 
    220                 /** 
    221                  *  
    222                  */ 
     211                /** The result. */ 
    223212                private final RuleApplicationResult result = new RuleApplicationResult(); 
    224213 
    225                 /** 
    226                  *  
    227                  */ 
     214                /** The stop watch. */ 
    228215                private final StopWatch stopWatch = new StopWatch(); 
    229216 
    230217                /** 
    231                  *  
     218                 * Instantiates a new rule application data. 
     219                 * 
     220                 * @param sessions the sessions 
    232221                 */ 
    233222                private RuleApplicationData(List<IUserSession> sessions) { 
     
    236225 
    237226                /** 
    238                  * 
     227                 * Detected and replaced tasks. 
     228                 * 
     229                 * @return true, if successful 
    239230                 */ 
    240231                private boolean detectedAndReplacedTasks() { 
     
    243234 
    244235                /** 
    245                  * 
     236                 * Detected and replaced tasks. 
     237                 * 
     238                 * @param detectedAndReplacedTasks the detected and replaced tasks 
    246239                 */ 
    247240                private void detectedAndReplacedTasks(boolean detectedAndReplacedTasks) { 
     
    250243 
    251244                /** 
     245                 * Gets the last found tasks. 
     246                 * 
    252247                 * @return the lastFoundSequences 
    253248                 */ 
     
    257252 
    258253                /** 
     254                 * Gets the last trie. 
     255                 * 
    259256                 * @return the lastTrie 
    260257                 */ 
     
    264261 
    265262                /** 
     263                 * Gets the result. 
     264                 * 
    266265                 * @return the result 
    267266                 */ 
     
    271270 
    272271                /** 
     272                 * Gets the sessions. 
     273                 * 
    273274                 * @return the tree 
    274275                 */ 
     
    278279 
    279280                /** 
     281                 * Gets the stop watch. 
     282                 * 
    280283                 * @return the stopWatch 
    281284                 */ 
     
    285288 
    286289                /** 
     290                 * Gets the trained sequence length. 
     291                 * 
    287292                 * @return the trainedSequenceLength 
    288293                 */ 
     
    292297 
    293298                /** 
    294                  * @param lastFoundSequences 
    295                  *            the lastFoundSequences to set 
     299                 * Sets the last found tasks. 
     300                 * 
     301                 * @param lastFoundSequences            the lastFoundSequences to set 
    296302                 */ 
    297303                private void setLastFoundTasks(Tasks lastFoundSequences) { 
     
    300306 
    301307                /** 
    302                  * @param lastTrie 
    303                  *            the lastTrie to set 
     308                 * Sets the last trie. 
     309                 * 
     310                 * @param lastTrie            the lastTrie to set 
    304311                 */ 
    305312                private void setLastTrie(TaskInstanceTrie lastTrie) { 
     
    308315 
    309316                /** 
    310                  * @param trainedSequenceLength 
    311                  *            the trainedSequenceLength to set 
     317                 * Sets the trained sequence length. 
     318                 * 
     319                 * @param trainedSequenceLength            the trainedSequenceLength to set 
    312320                 */ 
    313321                private void setTrainedSequenceLength(int trainedSequenceLength) { 
     
    318326 
    319327        /** 
     328         * The Class Tasks. 
     329         * 
    320330         * @author Patrick Harms 
    321331         */ 
    322332        private static class Tasks implements Iterable<List<ITaskInstance>> { 
    323333 
    324                 /** 
    325                  *  
    326                  */ 
     334                /** The occurrence count. */ 
    327335                private final int occurrenceCount; 
    328336 
    329                 /** 
    330                  *  
    331                  */ 
     337                /** The sequences. */ 
    332338                private final List<List<ITaskInstance>> sequences; 
    333339 
    334340                /** 
    335                  * @param occurrenceCount 
    336                  * @param sequences 
     341                 * Instantiates a new tasks. 
     342                 * 
     343                 * @param occurrenceCount the occurrence count 
     344                 * @param sequences the sequences 
    337345                 */ 
    338346                private Tasks(int occurrenceCount, List<List<ITaskInstance>> sequences) { 
     
    343351 
    344352                /** 
    345                  * @return 
     353                 * Gets the occurrence count. 
     354                 * 
     355                 * @return the occurrence count 
    346356                 */ 
    347357                private int getOccurrenceCount() { 
     
    364374 
    365375                /** 
    366                  * @return 
     376                 * Size. 
     377                 * 
     378                 * @return the int 
    367379                 */ 
    368380                private int size() { 
     
    391403        } 
    392404 
    393         /** 
    394          * <p> 
    395          * the task factory to be used for creating substructures for the temporal 
    396          * relationships identified during rul application 
    397          * </p> 
    398          */ 
     405        /** <p> the task factory to be used for creating substructures for the temporal relationships identified during rul application </p>. */ 
    399406        private final ITaskFactory taskFactory;; 
    400407 
    401         /** 
    402          * <p> 
    403          * the task builder to be used for creating substructures for the temporal 
    404          * relationships identified during rule application 
    405          * </p> 
    406          */ 
     408        /** <p> the task builder to be used for creating substructures for the temporal relationships identified during rule application </p>. */ 
    407409        private final ITaskBuilder taskBuilder; 
    408410 
     
    498500 
    499501        /** 
    500          * @param appData 
    501          *            the rule application data combining all data used for applying 
     502         * Creates the new trie. 
     503         * 
     504         * @param appData            the rule application data combining all data used for applying 
    502505         *            this rule 
    503506         */ 
     
    554557 
    555558        /** 
    556          * TODO go on commenting 
    557          *  
    558          * @param appData 
    559          *            the rule application data combining all data used for applying 
     559         * TODO go on commenting. 
     560         * 
     561         * @param appData            the rule application data combining all data used for applying 
    560562         *            this rule 
    561563         */ 
     
    578580 
    579581        /** 
    580          * @param appData 
    581          *            the rule application data combining all data used for applying 
     582         * Gets the sequences occuring most often. 
     583         * 
     584         * @param appData            the rule application data combining all data used for applying 
    582585         *            this rule 
     586         * @return the sequences occuring most often 
    583587         */ 
    584588        private void getSequencesOccuringMostOften(RuleApplicationData appData) { 
     
    668672 
    669673        /** 
    670          * @param trie 
    671          * @param object 
    672          * @return 
     674         * Gets the sub list index. 
     675         * 
     676         * @param list the list 
     677         * @param subList the sub list 
     678         * @param startIndex the start index 
     679         * @return the sub list index 
    673680         */ 
    674681        private int getSubListIndex(ITaskInstanceList list, 
     
    702709 
    703710        /** 
    704          * @param trie 
    705          * @param object 
    706          * @return 
     711         * Gets the sub list index. 
     712         * 
     713         * @param list the list 
     714         * @param subList the sub list 
     715         * @param startIndex the start index 
     716         * @return the sub list index 
    707717         */ 
    708718        private int getSubListIndex(List<ITaskInstance> list, 
     
    790800         * <p> 
    791801         * TODO clarify why this is done 
    792          * </p> 
     802         * </p>. 
     803         * 
     804         * @param iteration the iteration 
     805         * @param iterationInstances the iteration instances 
    793806         */ 
    794807        private void harmonizeIterationInstancesModel(IIteration iteration, 
     
    851864 
    852865        /** 
    853          * 
     866         * Harmonize sequence instances model. 
     867         * 
     868         * @param sequence the sequence 
     869         * @param sequenceInstances the sequence instances 
     870         * @param sequenceLength the sequence length 
    854871         */ 
    855872        private void harmonizeSequenceInstancesModel(ISequence sequence, 
     
    924941         * <p> 
    925942         * replaces all occurrences of all tasks provided in the set with iterations 
    926          * </p> 
    927          * 
    928          * @param iteratedTasks 
    929          *            the tasks to be replaced with iterations 
    930          * @param sessions 
    931          *            the sessions in which the tasks are to be replaced 
    932          * @param appData 
    933          *            the rule application data combining all data used for applying 
     943         * </p>. 
     944         * 
     945         * @param iteratedTasks            the tasks to be replaced with iterations 
     946         * @param sessions            the sessions in which the tasks are to be replaced 
     947         * @param appData            the rule application data combining all data used for applying 
    934948         *            this rule 
    935949         */ 
     
    9901004 
    9911005        /** 
    992          * @param appData 
    993          *            the rule application data combining all data used for applying 
     1006         * Replace sequences occurring most often. 
     1007         * 
     1008         * @param appData            the rule application data combining all data used for applying 
    9941009         *            this rule 
    9951010         */ 
     
    10321047 
    10331048        /** 
    1034          * @param tree 
     1049         * Replace task occurrences. 
     1050         * 
     1051         * @param task the task 
     1052         * @param sessions the sessions 
     1053         * @param temporalTaskModel the temporal task model 
     1054         * @return the list 
    10351055         */ 
    10361056        private List<ISequenceInstance> replaceTaskOccurrences( 
     
    11161136         * iterated, it is added to the returned set. 
    11171137         * </p> 
    1118          *  
    1119          * @param the 
    1120          *            session to search for iterations in 
    1121          *  
     1138         * 
     1139         * @param sessions the sessions 
    11221140         * @return a set of tasks being iterated somewhere 
    11231141         */ 
Note: See TracChangeset for help on using the changeset viewer.