Changeset 557 for trunk/quest-core-tasktrees/src/main/java/de/ugoe/cs/quest/tasktrees/nodeequality/SequenceComparisonRule.java

Timestamp:

08/17/12 08:33:29 (12 years ago)

Author:

pharms

Message:

• adapted task tree creation stuff to more general event handling

File:

• trunk/quest-core-tasktrees/src/main/java/de/ugoe/cs/quest/tasktrees/nodeequality/SequenceComparisonRule.java (modified) (2 diffs)

trunk/quest-core-tasktrees/src/main/java/de/ugoe/cs/quest/tasktrees/nodeequality/SequenceComparisonRule.java

@@ -1 @@
-//-------------------------------------------------------------------------------------------------
 // Module    : $RCSfile: NodeIdentityRule.java,v $
 // Version   : $Revision: 0.0 $  $Author: patrick $  $Date: 19.02.2012 $
@@ -5 +4 @@
 // Creation  : 2012 by patrick
 // Copyright : Patrick Harms, 2012
-//-------------------------------------------------------------------------------------------------
+
 package de.ugoe.cs.quest.tasktrees.nodeequality;
 
-import de.ugoe.cs.quest.tasktrees.treeifc.Sequence;
-import de.ugoe.cs.quest.tasktrees.treeifc.TaskTreeNode;
+import de.ugoe.cs.quest.tasktrees.treeifc.ISequence;
+import de.ugoe.cs.quest.tasktrees.treeifc.ITaskTreeNode;
 
-//-------------------------------------------------------------------------------------------------
 /**
- * TODO comment
+ * <p>
+ * This rule is capable of comparing sequences. If both sequences do not have children, they are
+ * treated as lexically equal. Sequences are lexically equal, if they have the same number and
+ * order of lexically equal children. The rule can not decide, if two sequences are syntactically
+ * or semantically equal.
+ * </p>
  * 
  * @version $Revision: $ $Date: 19.02.2012$
  * @author 2012, last modified by $Author: patrick$
  */
-//-------------------------------------------------------------------------------------------------
-public class SequenceComparisonRule implements NodeComparisonRule
-{
+public class SequenceComparisonRule implements NodeComparisonRule {
 
+    /** the rule manager for internally comparing task tree nodes */
+    private NodeEqualityRuleManager mRuleManager;
 
-  /** */
-  private NodeEqualityRuleManager mRuleManager;
+    /**
+     * <p>
+     * simple constructor to provide the rule with the node equality rule manager to be able
+     * to perform comparisons of the children of provided task tree nodes
+     * </p>
+     * 
+     * @param ruleManager the rule manager for comparing task tree nodes
+     */
+    SequenceComparisonRule(NodeEqualityRuleManager ruleManager) {
+        super();
+        mRuleManager = ruleManager;
+    }
 
-  //-----------------------------------------------------------------------------------------------
-  /**
-   * TODO: comment
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  SequenceComparisonRule(NodeEqualityRuleManager ruleManager)
-  {
-    super();
-    mRuleManager = ruleManager;
-  }
+    /*
+     * (non-Javadoc)
+     * 
+     * @see de.ugoe.cs.tasktree.nodeequality.NodeEqualityRule#apply(TaskTreeNode, TaskTreeNode)
+     */
+    @Override
+    public NodeEquality compare(ITaskTreeNode node1, ITaskTreeNode node2) {
+        if ((!(node1 instanceof ISequence)) || (!(node2 instanceof ISequence))) {
+            return null;
+        }
 
-  //-----------------------------------------------------------------------------------------------
-  /* (non-Javadoc)
-   * @see de.ugoe.cs.tasktree.nodeequality.NodeEqualityRule#apply(TaskTreeNode, TaskTreeNode)
-   */
-  //-----------------------------------------------------------------------------------------------
-  @Override
-  public NodeEquality compare(TaskTreeNode node1, TaskTreeNode node2)
-  {
-    if ((!(node1 instanceof Sequence)) || (!(node2 instanceof Sequence)))
-    {
-      return null;
+        // if both sequences do not have children, they are equal although this doesn't make sense
+        if ((node1.getChildren().size() == 0) && (node2.getChildren().size() == 0)) {
+            return NodeEquality.LEXICALLY_EQUAL;
+        }
+
+        // 
+        if (node1.getChildren().size() != node2.getChildren().size()) {
+            return null;
+        }
+
+        for (int i = 0; i < node1.getChildren().size(); i++) {
+            ITaskTreeNode child1 = node1.getChildren().get(i);
+            ITaskTreeNode child2 = node2.getChildren().get(i);
+
+            NodeEquality nodeEquality = mRuleManager.applyRules(child1, child2);
+
+            if (!nodeEquality.isAtLeast(NodeEquality.LEXICALLY_EQUAL)) {
+                return null;
+            }
+        }
+
+        return NodeEquality.LEXICALLY_EQUAL;
     }
-    
-    // if both sequences do not have children, they are equal although this doesn't make sense
-    if ((node1.getChildren().size() == 0) && (node2.getChildren().size() == 0))
-    {
-      return new NodesEqual();
-    }
-    
-    // Sequences are equal, if they have the same number and order of children. If all the
-    // children match structurally, then the sequences are structurally equal. Otherwise, if
-    // at least one pair of children matches only semantically, then the sequences match only
-    // semantically.
-    if (node1.getChildren().size() != node2.getChildren().size())
-    {
-      return null;
-    }
-    
-    boolean structurallyEqual = true;
-    for (int i = 0; i < node1.getChildren().size(); i++)
-    {
-      TaskTreeNode child1 = node1.getChildren().get(i);
-      TaskTreeNode child2 = node2.getChildren().get(i);
-      
-      NodeEquality nodeEquality = mRuleManager.applyRules(child1, child2);
-      
-      structurallyEqual &= nodeEquality.getStructuralEquality();
-      
-      if (!structurallyEqual && !nodeEquality.getSemanticalEquality())
-      {
-        return null;
-      }
-    }
-    
-    if (structurallyEqual)
-    {
-      return new NodesEqual();
-    }
-    else
-    {
-      return new NodesSemanticallyEqual();
-    }
-  }
 
 }