- * TODO comment + * This command performs a compression of HTML log files. It traverse a directory structure. All + * files in the same directory are treated as HTML log files. They are parsed and all GUI elements + * and events contained in them are dumped into a new log file. No GUI element is dumped more than + * once. Through this, several log files containing duplicates of GUI elements are condensed to + * only one. The events are put at the end of the new log file and are sorted based on their time + * stamp. *
* @@ -33,7 +38,5 @@ public class CMDcompressHTMLLogFiles implements Command { - /* - * (non-Javadoc) - * + /* (non-Javadoc) * @see de.ugoe.cs.util.console.Command#run(java.util.List) */ @@ -60,5 +63,9 @@ /** + *+ * convenience method for recursively calling the {@link HTMLLogCompressor} for each directory + *
* + * @param the directory to be traversed */ private void compressDirectory(File directory) { @@ -81,7 +88,5 @@ } - /* - * (non-Javadoc) - * + /* (non-Javadoc) * @see de.ugoe.cs.util.console.Command#help() */ Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/commands/CMDpseudomizeHTMLTextInputs.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/commands/CMDpseudomizeHTMLTextInputs.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/commands/CMDpseudomizeHTMLTextInputs.java (revision 1276) @@ -24,5 +24,9 @@ /** *- * TODO comment + * replaces all text inputs in a directory structure with MD5 hashes of the text input. If the + * text input is already hashed, it stays unchanged. For this, the command traverses the directory + * structure. In each directory it treats the contained files as HTML log files. It parses them, + * copies all GUI elements and events and replaces the entered text of text input events. The result + * is a copy of each treated log file. The origins are deleted. The copies are named as the origins. *
* @@ -32,7 +36,5 @@ public class CMDpseudomizeHTMLTextInputs implements Command { - /* - * (non-Javadoc) - * + /* (non-Javadoc) * @see de.ugoe.cs.util.console.Command#run(java.util.List) */ @@ -59,5 +61,9 @@ /** + *+ * convenience method to traverse the directory structure + *
* + * @param directory the directory to be treated next */ private void pseudomizeTextInputsInDirectory(File directory) { Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/eventcore/HTMLEventTypeFactory.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/eventcore/HTMLEventTypeFactory.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/eventcore/HTMLEventTypeFactory.java (revision 1276) @@ -39,5 +39,6 @@ /** *- * TODO comment + * convenience class to instantiate the correct event type based on an event name, event parameters, + * and the target GUI element. *
* @@ -47,12 +48,15 @@ public class HTMLEventTypeFactory { - /** */ + /** + *+ * single instance + *
+ */ private static HTMLEventTypeFactory instance = new HTMLEventTypeFactory(); /** *- * TODO: comment + * private constructor to implement correct singleton *
- * */ private HTMLEventTypeFactory() {} @@ -60,8 +64,6 @@ /** *- * TODO: comment + * singleton retrieval *
- * - * @return */ public static HTMLEventTypeFactory getInstance() { @@ -71,13 +73,22 @@ /** *- * TODO: comment + * returns the event type for the given event name, the parameters as well as the target GUI + * element *
* - * @param eventName - * @param eventParameters - * @return + * @param eventName the name of the event, e.g., onscroll + * @param eventParameters the parameters of the event, e.g., scroll coordinates + * @param guiElement the target GUI element of the event (required for some event type + * differentiation + * + * @return the event type matching the proviced parameters + * + * @throws IllegalArgumentException if the provided parameters in their combination do not + * correctly specify an event type */ - public IEventType getEventType(String eventName, Map- * TODO: comment + * convenience method to retrieve coordinates from the event parameters. *
- * - * @param eventName - * @param eventParameters - * @return */ private int[] getCoordinateParameter(String xParamName, Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLButton.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLButton.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLButton.java (revision 1276) @@ -19,5 +19,5 @@ /** *- * TODO comment + * *
* Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLDocument.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLDocument.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLDocument.java (revision 1276) @@ -19,5 +19,8 @@ /** *- * TODO comment + * a GUI element representing an HTML document, i.e., a page on an HTML server. This is the + * element for a GUI model of an HTML web site being always and only the children of servers. It + * is identified through the server on which it resists, its path, a potential query, and a title. + * Its children are HTML page elements *
* @@ -26,14 +29,18 @@ public class HTMLDocument extends HTMLGUIElement implements IDialog { - /** */ + /** + *+ * default serial version UID + *
+ */ private static final long serialVersionUID = 1L; /** *- * TODO: comment + * instantiates the document with it specification and its parent, which is always a server *
* - * @param specification - * @param parent + * @param specification the specification of the document + * @param parent the server on which the document resists */ public HTMLDocument(HTMLDocumentSpec specification, HTMLServer parent) { @@ -43,8 +50,8 @@ /** *- * TODO: comment + * returns the path in the URL of the document *
* - * @return + * @return the path in the URL of the document */ public String getPath() { @@ -64,19 +71,19 @@ /** *- * TODO: comment + * returns the server on which the document resists *
* - * @return + * @return the server on which the document resists */ - HTMLServerSpec getServer() { - return ((HTMLDocumentSpec) super.getSpecification()).getServer(); + HTMLServer getServer() { + return (HTMLServer) super.getParent(); } /** *- * TODO: comment + * returns the title of the document *
* - * @return + * @return the title of the document */ String getTitle() { Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLDocumentSpec.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLDocumentSpec.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLDocumentSpec.java (revision 1276) @@ -19,5 +19,8 @@ /** *- * TODO comment + * a GUI element specification of an HTML document, i.e., a page on an HTML server. This is the + * element for a GUI model of an HTML web site being always and only the children of servers. It + * is identified through the server on which it resists, its path, a potential query, and a title. + * Its children are HTML page elements *
* @@ -26,27 +29,50 @@ public class HTMLDocumentSpec extends HTMLGUIElementSpec implements IGUIElementSpec { - /** */ + /** + *+ * default serial version UID + *
+ */ private static final long serialVersionUID = 1L; - /** */ + /** + *+ * the server on which the document resists + *
+ */ private HTMLServerSpec server; - /** */ + /** + *+ * the path in the URL of the document + *
+ */ private String path; - /** */ + /** + *+ * the query in the URL of the document + *
+ */ private String query; - /** */ + /** + *+ * the title of the document + *
+ */ private String title; /** *- * TODO: comment + * initializes the document with its server, path, query, and title *
* - * @param server - * @param pagePath - * @param pageTitle + * @param server the server on which the document resists + * @param path the path in the URL of the document + * @param query the query in the URL of the document + * @param title the title of the document + * + * @throws IllegalArgumentException if the server or path are invalid, i.e. null */ public HTMLDocumentSpec(HTMLServerSpec server, String path, String query, String title) { @@ -104,8 +130,8 @@ /** *- * TODO: comment + * returns the server on which the document resists *
* - * @return + * @return the server on which the document resists */ public HTMLServerSpec getServer() { @@ -115,8 +141,8 @@ /** *- * TODO: comment + * returns the path in the URL of the document *
* - * @return + * @return the path in the URL of the document */ String getPath() { @@ -126,8 +152,8 @@ /** *- * TODO: comment + * returns the query in the URL of the document *
* - * @return + * @return the query in the URL of the document */ String getQuery() { @@ -137,8 +163,8 @@ /** *- * TODO: comment + * returns the title of the document *
* - * @return + * @return the title of the document */ String getTitle() { Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLGUIElementSpec.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLGUIElementSpec.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLGUIElementSpec.java (revision 1276) @@ -19,5 +19,5 @@ /** *- * TODO comment + * base class for all GUI element specifications in the context of HTML *
* @@ -26,18 +26,27 @@ public class HTMLGUIElementSpec implements IGUIElementSpec { - /** */ + /** + *+ * default serial version UID + *
+ */ private static final long serialVersionUID = 1L; - /** */ + /** + *+ * the type of GUI element represented by this specification, which is usually the tag name of + * the HTML GUI element + *
+ */ private String type; /** *- * TODO: comment + * instantiated the specification with the type, i.e., tag name of the represented GUI element *
* - * @param type - * @param index - * @param id + * @param type the type, i.e., tag name of the represented GUI element + * + * @throws IllegalArgumentException if the provided type is null */ public HTMLGUIElementSpec(String type) { @@ -70,8 +79,6 @@ } - /** - *- * TODO: comment - *
+ /* (non-Javadoc) + * @see de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElementSpec#getTypeHierarchy() */ @Override Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLPageElement.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLPageElement.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLPageElement.java (revision 1276) @@ -17,5 +17,7 @@ /** *- * TODO comment + * This is a GUI element representing tags in HTML documents. Each tag belongs to a certain + * document. Each page element has a tag name and either an id or at least + * an index in the list of siblings of the same type. *
* @@ -24,14 +26,18 @@ public class HTMLPageElement extends HTMLGUIElement { - /** */ + /** + *+ * default serial version UID + *
+ */ private static final long serialVersionUID = 1L; /** *- * TODO: comment + * instantiates a page element with it parent (either a document or another page element) *
* - * @param specification - * @param parent + * @param specification the specification of the page element + * @param parent the parent GUI element */ public HTMLPageElement(HTMLPageElementSpec specification, HTMLGUIElement parent) { @@ -41,20 +47,8 @@ /** *- * TODO: comment + * returns the name of the tag represented by this specification *
* - * @param specification - * @param parent - */ - public HTMLPageElement(HTMLPageElementSpec specification, HTMLDocument parent) { - super(specification, parent); - } - - /** - *- * TODO: comment - *
- * - * @return + * @return the name of the tag represented by this specification */ public String getTagName() { @@ -64,8 +58,8 @@ /** *- * TODO: comment + * returns the id of the tag represented by this specification *
* - * @return + * @return the id of the tag represented by this specification */ public String getHtmlId() { @@ -75,8 +69,8 @@ /** *- * TODO: comment + * returns the index of the tag *
* - * @return + * @return the index of the tag */ public int getIndex() { @@ -94,14 +88,3 @@ } - /** - *- * TODO: comment - *
- * - * @return - */ - HTMLDocumentSpec getPage() { - return ((HTMLPageElementSpec) super.getSpecification()).getPage(); - } - } Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLPageElementSpec.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLPageElementSpec.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLPageElementSpec.java (revision 1276) @@ -19,5 +19,8 @@ /** *- * TODO comment + * This is a GUI element specification for tags in HTML documents. Each tag belongs to a certain + * document. However, for similarity comparison, two page elements are similar even if they do + * not belong to the same document. Each page element has a tag name and either an id or at least + * an index in the list of siblings of the same type. *
* @@ -26,27 +29,56 @@ public class HTMLPageElementSpec extends HTMLGUIElementSpec implements IGUIElementSpec { - /** */ + /** + *+ * default serial version UID + *
+ */ private static final long serialVersionUID = 1L; - /** */ + /** + *+ * the page to which the represented tag belongs + *
+ */ private HTMLDocumentSpec page; - /** */ + /** + *+ * the name of the tag represented by this specification + *
+ */ private String tagName; - /** */ + /** + *+ * the id of the tag represented by this specification, i.e., the value of the id attribute + * of the tag. May be null in the case the id attribute of the tag is not set. + *
+ */ private String htmlId; - /** */ + /** + *+ * the index of the tag (0 based) in the list of siblings in the same parent being of the + * same type. If, e.g., a parent has three li tags as children, the first will have index 0, + * the second index 1 and the third index2. The indexes are ignored, if the tag have an + * assigned id. + *
+ */ private int index; /** *- * TODO: comment + * initializes the specification with the page to which the represented tag belongs, the tags + * name, its id or its index. *
* - * @param type - * @param index - * @param id + * @param page the page to which the represented tag belongs + * @param tagName the name of the tag represented by this specification + * @param htmlId the id of the tag represented by this specification + * @param index the index of the tag + * + * @throws IllegalArgumentException if page and name are null or if neither an id nor an index + * are provided correctly */ public HTMLPageElementSpec(HTMLDocumentSpec page, String tagName, String htmlId, int index) { @@ -118,8 +150,8 @@ /** *- * TODO: comment + * returns the page to which the represented tag belongs *
* - * @return + * @return the page to which the represented tag belongs */ HTMLDocumentSpec getPage() { @@ -129,8 +161,8 @@ /** *- * TODO: comment + * returns the name of the tag represented by this specification *
* - * @return + * @return the name of the tag represented by this specification */ String getTagName() { @@ -140,8 +172,8 @@ /** *- * TODO: comment + * returns the id of the tag represented by this specification *
* - * @return + * @return the id of the tag represented by this specification */ String getHtmlId() { @@ -151,8 +183,8 @@ /** *- * TODO: comment + * returns the index of the tag *
* - * @return + * @return the index of the tag */ int getIndex() { Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLServer.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLServer.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLServer.java (revision 1276) @@ -19,5 +19,6 @@ /** *- * TODO comment + * a GUI element representing an HTML server. This is the root element for a GUI model of + * an HTML web site. It is identified through a host and a port. Its children are documents. *
* @@ -26,14 +27,21 @@ public class HTMLServer extends HTMLGUIElement implements IFrame { - /** */ + /** + *+ * default serial version UID + *
+ */ private static final long serialVersionUID = 1L; /** *- * TODO: comment + * instantiates the server with an appropriate specification *
* - * @param specification - * @param parent + * @param specification the server specification + * @param parent the parent of the server --> must always be null. Just included as + * required by the automatic instantiation mechanism + * + * @throws IllegalArgumentException if the provided parent is not null */ public HTMLServer(HTMLServerSpec specification, HTMLGUIElement parent) { @@ -58,8 +66,8 @@ /** *- * TODO: comment + * returns the host of the represented server *
* - * @return + * @return the host */ public String getHost() { @@ -69,8 +77,8 @@ /** *- * TODO: comment + * returns the port of the represented server *
* - * @return + * @return the port */ public int getPort() { Index: trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLServerSpec.java =================================================================== --- trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLServerSpec.java (revision 1272) +++ trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/guimodel/HTMLServerSpec.java (revision 1276) @@ -19,5 +19,6 @@ /** *- * TODO comment + * a GUI element specification of an HTML server. This is the root element for a GUI model of + * an HTML web site. It is identified through a host and a port. Its children are documents. *
* @@ -26,20 +27,34 @@ public class HTMLServerSpec extends HTMLGUIElementSpec implements IGUIElementSpec { - /** */ + /** + *+ * default serial version UID + *
+ */ private static final long serialVersionUID = 1L; - /** */ + /** + *+ * the host of the server + *
+ */ private String host; - /** */ + /** + *+ * the port of the server + *
+ */ private int port; /** *- * TODO: comment + * initialize the server specification with a host and a port. *
* - * @param serverName - * @param port + * @param host the host name of the server + * @param port the port number of the server + * + * @throws IllegalArgumentException if one of the parameters is invalid (e.g. host = null) */ public HTMLServerSpec(String host, int port) { @@ -97,8 +112,8 @@ /** *- * TODO: comment + * returns the host of the represented server *
* - * @return + * @return the host */ String getHost() { @@ -108,8 +123,8 @@ /** *- * TODO: comment + * returns the port of the represented server *
* - * @return + * @return the port */ int getPort() {