Ignore:
Timestamp:
02/27/14 17:34:28 (11 years ago)
Author:
pharms
Message:
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/HTMLLogParser.java

    r1379 r1416  
    4545 * <p> 
    4646 * This class provides the functionality to parse XML log files generated by the HTMLMonitor of 
    47  * AutoQUEST. The result of parsing a file is a collection of event sequences and a GUI model 
     47 * AutoQUEST. The result of parsing a file is a collection of event sequences and a GUI model. 
     48 * </p> 
     49 * <p> 
     50 * The parser can be configured with parsing parameters to ignore, e.g., ids or indexes of 
     51 * parsed GUI elements. Details can be found in the manual pages of the respective parsing commands. 
    4852 * </p> 
    4953 *  
    … …  
    8690    /** 
    8791     * <p> 
    88      * TODO: comment 
     92     * initializes the parser with the parsing parameters to be considered 
    8993     * </p> 
    9094     * 
    91      * @param parseParams 
     95     * @param parseParams the parsing parameters to be considered 
    9296     */ 
    9397    public HTMLLogParser(Map<String, List<String>> parseParams) { 
    … …  
    220224    /** 
    221225     * <p> 
    222      * TODO: comment 
     226     * checks if for a specific GUI element the index shall be ignored or not by considering the 
     227     * parsing parameters. 
    223228     * </p> 
    224229     * 
    225      * @param tagName 
    226      * @param parent 
    227      * @return 
     230     * @param tagName the tag of the considered GUI element 
     231     * @param index   the index of the GUI element 
     232     * @param id      the id of the GUI element 
     233     * @param parent  the parent GUI element of the considered GUI element 
     234     *  
     235     * @return true if the index shall be ignored, false else. 
    228236     */ 
    229237    private boolean clearIndex(String tagName, int index, String id, HTMLGUIElement parent) { 
    … …  
    233241    /** 
    234242     * <p> 
    235      * TODO: comment 
     243     * checks if the parsing parameters define a replacement for the id of the given GUI element 
     244     * and if so returns this replacement 
    236245     * </p> 
    237246     * 
    238      * @param tagName 
    239      * @param index 
    240      * @param htmlId 
    241      * @param parent 
    242      * @return 
     247     * @param tagName the tag of the considered GUI element 
     248     * @param index   the index of the GUI element 
     249     * @param id      the id of the GUI element 
     250     * @param parent  the parent GUI element of the considered GUI element 
     251     *  
     252     * @return the identified replacement 
    243253     */ 
    244254    private String replaceHTMLId(String tagName, int index, String htmlId, HTMLGUIElement parent) 
    … …  
    301311    /** 
    302312     * <p> 
    303      * TODO: comment 
     313     * checks if for a specific GUI element the id shall be ignored or not by considering the 
     314     * parsing parameters. 
    304315     * </p> 
    305316     * 
    306      * @param tagName 
    307      * @param parent 
    308      * @return 
     317     * @param tagName the tag of the considered GUI element 
     318     * @param index   the index of the GUI element 
     319     * @param id      the id of the GUI element 
     320     * @param parent  the parent GUI element of the considered GUI element 
     321     *  
     322     * @return true if the id shall be ignored, false else. 
    309323     */ 
    310324    private boolean clearHTMLId(String tagName, int index, String id, HTMLGUIElement parent) { 
    … …  
    314328    /** 
    315329     * <p> 
    316      * TODO: comment 
     330     * convenience method to check for the existence for specific parsing parameters for clearing 
     331     * ids or indexes of GUI elements. 
    317332     * </p> 
    318333     * 
    319      * @param tagName 
    320      * @param parent 
    321      * @return 
     334     * @param parseParamId the id of the parsing parameter to be checked for the GUI element 
     335     * @param tagName      the tag of the considered GUI element 
     336     * @param index        the index of the GUI element 
     337     * @param id           the id of the GUI element 
     338     * @param parent       the parent GUI element of the considered GUI element 
     339     *  
     340     * @return true if the denoted parse parameter is set to ignore, false else. 
    322341     */ 
    323342    private boolean clearSomething(String         parseParamId, 
    … …  
    350369    /** 
    351370     * <p> 
    352      * TODO: comment 
     371     * convenience method to check if a given GUI element matches a specification tags provided 
     372     * through the parsing parameters. 
    353373     * </p> 
    354374     * 
    355      * @param tagName 
    356      * @param parent 
    357      * @param spec 
    358      * @return 
     375     * @param tagName  the tag of the considered GUI element 
     376     * @param index    the index of the GUI element 
     377     * @param id       the id of the GUI element 
     378     * @param parent   the parent GUI element of the considered GUI element 
     379     * @param tagSpecs the specification of a GUI element to match against the given GUI element 
     380     *  
     381     * @return true if the denoted parse parameter is set to ignore, false else. 
    359382     */ 
    360383    private boolean tagMatchesTagSpec(String         tagName, 
Note: See TracChangeset for help on using the changeset viewer.