Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/GUIModel.java =================================================================== --- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/GUIModel.java (revision 820) +++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/GUIModel.java (revision 821) @@ -8,4 +8,7 @@ import java.util.LinkedList; import java.util.List; +import java.util.logging.Level; + +import de.ugoe.cs.util.console.Console; /** @@ -17,8 +20,5 @@ *

* - * TODO: getChildren and getParent should be rewritten to at least throw warnings, in case there are - * multiple nodes in allNodes that match the current GUI element. - * - * @version $Revision: $ $Date: 14.08.2012$ + * @version 1.0 * @author Patrick Harms, Steffen Herbold */ @@ -110,19 +110,26 @@ */ public List getChildren(IGUIElement guiElement) { + List result = null; for (TreeNode node : allNodes) { if (node.guiElement.equals(guiElement)) { - List result = new ArrayList(); - - if (node.children != null) { - for (TreeNode child : node.children) { - result.add(child.guiElement); + if (result == null) { + result = new ArrayList(); + + if (node.children != null) { + for (TreeNode child : node.children) { + result.add(child.guiElement); + } } } - - return result; - } - } - - return null; + else { + Console + .traceln(Level.SEVERE, + "Multiple nodes in the internal GUI model match the same GUI element. " + + "This should not be the case and the GUI model is probably invalid."); + } + } + } + + return result; } @@ -139,13 +146,23 @@ */ public IGUIElement getParent(IGUIElement guiElement) { + IGUIElement parent = null; + for (TreeNode node : allNodes) { for (TreeNode child : node.children) { if (child.guiElement.equals(guiElement)) { - return node.guiElement; + if (parent != null) { + parent = node.guiElement; + } + else { + Console + .traceln(Level.SEVERE, + "Multiple nodes in the internal GUI model match the same GUI element. " + + "This should not be the case and the GUI model is probably invalid."); + } } } } - return null; + return parent; } @@ -203,10 +220,10 @@ /** *

- * TODO: comment + * By calling this method, the GUIModel is traversed and similar nodes are merged. *

* */ public void condenseModel() { - mergeSimilarChildren(root); + mergeSubTree(root); } @@ -238,9 +255,5 @@ TreeNode child = findEqualChild(parentNode, specToIntegrateElementFor); - if (child != null) { - // TODO this call should be deprecated and change nothing - child.guiElement.updateSpecification(specToIntegrateElementFor); - } - else { + if (child == null) { IGUIElement newElement = guiElementFactory.instantiateGUIElement(specToIntegrateElementFor, @@ -260,10 +273,8 @@ /** *

- * TODO: comment - *

- * - * @param parentNode - * @param specToMatch - * @return + * Searches the children of a tree node to see if the {@link IGUIElementSpec} of equals the + * specification of the {@link TreeNode#guiElement} of the child. If a match is found, the child + * is returned. + *

*/ private TreeNode findEqualChild(TreeNode parentNode, IGUIElementSpec specToMatch) { @@ -280,17 +291,24 @@ /** *

- * merges similar children of a parent node. The method compares all children of the parent node - * with each other. If two of them are similar, it merges them, registers them with each other - * for equality checks, and removes one of them from the list of children. - *

- */ - private void mergeSimilarChildren(TreeNode parentNode) { - if (parentNode.children == null || parentNode.children.isEmpty()) { + * Merges all similar nodes in the sub-tree of the GUI model defined by the subTreeRoot. + *

+ *

+ * The merging order is a bottom-up. This means, that we first call mergeSubTree recursively for + * the grand children of the subTreeRoot, before we merge subTreeRoot. + *

+ *

+ * The merging strategy is top-down. This means, that every time we merge two child nodes, we + * call mergeSubTree recursively for all children of the merged nodes in order to check if we + * can merge the children, too. + *

+ */ + private void mergeSubTree(TreeNode subTreeRoot) { + if (subTreeRoot.children == null || subTreeRoot.children.isEmpty()) { return; } - // lets first merge the grandchildren - for (TreeNode child : parentNode.children) { - mergeSimilarChildren(child); + // lets first merge the grand children of the parentNode + for (TreeNode child : subTreeRoot.children) { + mergeSubTree(child); } @@ -299,16 +317,16 @@ do { performedMerge = false; - for (int i = 0; !performedMerge && i < parentNode.children.size(); i++) { + for (int i = 0; !performedMerge && i < subTreeRoot.children.size(); i++) { IGUIElementSpec elemSpec1 = - parentNode.children.get(i).guiElement.getSpecification(); - for (int j = i + 1; !performedMerge && j < parentNode.children.size(); j++) { + subTreeRoot.children.get(i).guiElement.getSpecification(); + for (int j = i + 1; !performedMerge && j < subTreeRoot.children.size(); j++) { IGUIElementSpec elemSpec2 = - parentNode.children.get(j).guiElement.getSpecification(); + subTreeRoot.children.get(j).guiElement.getSpecification(); if (elemSpec1.getSimilarity(elemSpec2)) { TreeNode replacement = - mergeTreeNodes(parentNode.children.get(i), parentNode.children.get(j)); - - parentNode.children.set(i, replacement); - parentNode.children.remove(j); + mergeTreeNodes(subTreeRoot.children.get(i), subTreeRoot.children.get(j)); + + subTreeRoot.children.set(i, replacement); + subTreeRoot.children.remove(j); performedMerge = true; i--; @@ -344,5 +362,4 @@ if (treeNode1.children != null) { for (TreeNode child : treeNode1.children) { - // replacement.addChild(child.guiElement); replacement.addChildNode(child); } @@ -350,10 +367,9 @@ if (treeNode2.children != null) { for (TreeNode child : treeNode2.children) { - // replacement.addChild(child.guiElement); replacement.addChildNode(child); } } - mergeSimilarChildren(replacement); + mergeSubTree(replacement); replacement.guiElement.updateSpecification(treeNode2.guiElement.getSpecification()); @@ -405,7 +421,4 @@ /** */ private List children; - - /** */ - // private TreeNode parent; /** @@ -421,5 +434,4 @@ TreeNode child = new TreeNode(); child.guiElement = guiElement; - // child.parent = this; children.add(child); @@ -432,9 +444,6 @@ * *

- * TODO: comment + * Adds a TreeNode as child to the current node. This way, the whole sub-tree is added. *

- * - * @param node - * @return */ private TreeNode addChildNode(TreeNode node) {