+ * the handle to the locator for correctly throwing exceptions with location information + *
+ */ + private Locator locator; + + /** + ** Constructor. Creates a new logParser. *
@@ -134,6 +142,8 @@ * @param filename * name and path of the log file - */ - public void parseFile(String filename) { + * + * @throws SAXException in the case, the file could not be parsed + */ + public void parseFile(String filename) throws SAXException { if (filename == null) { throw new IllegalArgumentException("filename must not be null"); @@ -150,6 +160,8 @@ * @param file * file to be parsed - */ - public void parseFile(File file) { + * + * @throws SAXException in the case, the file could not be parsed + */ + public void parseFile(File file) throws SAXException { if (file == null) { throw new IllegalArgumentException("file must not be null"); @@ -167,19 +179,17 @@ Console.printerrln("Error parsing file " + file.getName()); Console.logException(e); - return; + throw new SAXParseException("Error parsing file " + file.getName(), locator, e); } catch (ParserConfigurationException e) { Console.printerrln("Error parsing file " + file.getName()); Console.logException(e); - return; - } - catch (SAXException e) { - Console.printerrln("Error parsing file " + file.getName()); - Console.logException(e); + throw new SAXParseException("Error parsing file " + file.getName(), locator, e); } catch (FileNotFoundException e) { Console.printerrln("Error parsing file " + file.getName()); Console.logException(e); - } + throw new SAXParseException("Error parsing file " + file.getName(), locator, e); + } + if (inputSource != null) { inputSource.setSystemId("file://" + file.getAbsolutePath()); @@ -190,18 +200,8 @@ saxParser.parse(inputSource, this); } - catch (SAXParseException e) { - Console.printerrln("Failure parsing file in line " + e.getLineNumber() + - ", column " + e.getColumnNumber() + "."); - Console.logException(e); - } - catch (SAXException e) { - Console.printerrln("Error parsing file " + file.getName()); - Console.logException(e); - return; - } catch (IOException e) { Console.printerrln("Error parsing file " + file.getName()); Console.logException(e); - return; + throw new SAXParseException("Error parsing file " + file.getName(), locator, e); } } @@ -228,4 +228,12 @@ public GUIModel getGuiModel() { return guiElementTree.getGUIModel(); + } + + /* (non-Javadoc) + * @see org.xml.sax.helpers.DefaultHandler#setDocumentLocator(org.xml.sax.Locator) + */ + @Override + public void setDocumentLocator(Locator locator) { + this.locator = locator; } @@ -298,10 +306,13 @@ /** *- * TODO: comment - *
- * - * @param id - * @param parameters - * @return + * called to handle parsed GUI elements + * + * + * @param id the id of the parsed GUI element + * @param parameters all parameters parsed for the GUI element + * + * @return true, if the GUI element could be handled. In this case this method is not called + * again for the same GUI element. Otherwise the method is called later again. This + * may be required, if a child GUI element is parsed before the parent GUI element */ protected abstract boolean handleGUIElement(String id, Map- * TODO: comment - *
- * - * @param id - * @param parameters - * @return + * called to handle parsed events + * + * + * @param type the type of the parsed event + * @param parameters the parameters of the parsed event + * + * @return true, if the event could be handled. In this case this method is not called + * again for the same event. Otherwise the method is called later again. This + * may be required, if e.g. the target of the event, i.e. the GUI element, is not yet + * parsed */ protected abstract boolean handleEvent(String type, Map- * TODO: comment - *
- * - * @return + * returns the tree of parsed GUI elements, which consists of the ids of the GUI elements + * + * + * @return as described */ protected GUIElementTree- * TODO: comment + * adds an event to the currently parsed sequence of events *
* @@ -344,7 +359,10 @@ /** *- * TODO: comment - *
- * + * this method internally processes GUI elements, that have been parsed but not processed yet. + * I.e., for such GUI elements, either the method {@link #handleGUIElement(String, Map)} has + * not been called yet, or it returned false for the previous calls. In this case, the method + * is called (again). Furthermore, the processing of events is initiated by a call to + * {@link #processEvents()}. + * */ private void processGUIElements() throws SAXException { @@ -374,7 +392,9 @@ /** *- * TODO: comment - *
- * + * this method internally processes events, that have been parsed but not processed yet. + * I.e., for such events, either the method {@link #handleEvent(String, Map)} has + * not been called yet, or it returned false for the previous calls. In this case, the method + * is called (again). + * */ private void processEvents() throws SAXException { @@ -410,5 +430,5 @@ /** *- * TODO document + * This class is used internally for storing events and GUI elements in lists. *
*/ Index: /trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/HTMLLogCompressor.java =================================================================== --- /trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/HTMLLogCompressor.java (revision 1231) +++ /trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/HTMLLogCompressor.java (revision 1232) @@ -35,8 +35,9 @@ /** *- * TODO comment + * This class can be used to compress a bunch of HTML log files to one file, that contains only + * one full GUI model. *
* - * @author Fabian Glaser, Patrick Harms + * @author Patrick Harms * @version 1.0 * @@ -45,21 +46,32 @@ /** - * + *+ * The output writer into which the compressed variant of the log files is written + *
*/ private PrintWriter outputWriter; /** + ** the GUI elements, that were already logged and need therefore not be logged again into * the same file + *
*/ private Set* the events that were read + *
*/ private List+ * called to compress all log files in the provided directory. The method reuses + * {@link #compressFilesInDirectory(File)}. + *
* + * @param directory the directory containing the log files to be compressed */ public void compressFilesInDirectory(String directory) { @@ -72,5 +84,13 @@ /** + *+ * called to compress all log files in the provided directory. The directory if processed + * recursively. For each directory containing at least one log file the log files are + * replaced by one large log file containing the GUI model as well as all events contained in + * the compressed log file. If one log file could not be parsed, it is ignored and not + * compressed with the other ones. + *
* + * @param directory the directory containing the log files to be compressed */ public void compressFilesInDirectory(File directory) { @@ -213,5 +233,5 @@ /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#handleEvent(java.lang.String, java.util.Map) + * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#handleEvent(String,Map) */ @Override @@ -299,20 +319,29 @@ /** - * + *+ * this class is used internally for storing events in a sorted list together with the + * timestamps, being the sort criteria. + *
*/ private class EventEntry { /** - * + *+ * the type of the event + *
*/ private String type; /** - * + *+ * the parameters of the event + *
*/ private Map+ * the timestamp of the event + *
*/ private long timestamp; @@ -320,10 +349,6 @@ /** *- * TODO: comment - *
- * - * @param type - * @param parameters - * @param timestamp + * creates a new event entry with event type, parameters and the timestamp + * */ private EventEntry(String type, Map+ * convenience method for dumping the event into the compressed log file + *
*/ private void dump() { Index: /trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/HTMLLogParser.java =================================================================== --- /trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/HTMLLogParser.java (revision 1231) +++ /trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/HTMLLogParser.java (revision 1232) @@ -47,5 +47,7 @@ /** - * + *+ * the pattern used for parsing HTML GUI element paths + *
*/ private Pattern htmlElementPattern = @@ -53,5 +55,5 @@ /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#handleGUIElement(java.lang.String, java.util.Map) + * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#handleGUIElement(String, Map) */ @Override @@ -149,5 +151,5 @@ /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#handleEvent(java.lang.String, java.util.Map) + * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#handleEvent(String, Map) */ @Override @@ -201,10 +203,7 @@ /** *- * TODO: comment + * used to determine the id of a target denoted by an event. This is only required for older + * document formats. The new formats use concrete ids. *
- * - * @param targetDocument - * @param targetDOMPath - * @return */ private String determineTargetId(String targetDocument, String targetDOMPath) @@ -280,6 +279,7 @@ * * - * @param tagName - * @return + * @param tagName the tag name to check + * + * @return true, if the tag must be considered, false else */ private boolean tagNameMustBeConsidered(String tagName) { @@ -289,5 +289,6 @@ !"iframe".equals(tagName) && !"input_hidden".equals(tagName) && !"option".equals(tagName) && !"tt".equals(tagName) && !"br".equals(tagName) && - !"colgroup".equals(tagName) && !"col".equals(tagName); + !"colgroup".equals(tagName) && !"col".equals(tagName) && !"hr".equals(tagName) && + !"param".equals(tagName); }