Merge pull request #82 from Bram-Hub/uid_get_rule_by_id

Prototype getRuleByID()
Bram-Hub · Mar 8, 2022 · 9a0dcdc · 9a0dcdc
2 parents f910b4a + d0bd0ab
commit 9a0dcdc
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 7 deletions.
diff --git a/src/main/java/edu/rpi/legup/model/Puzzle.java b/src/main/java/edu/rpi/legup/model/Puzzle.java
@@ -385,6 +385,35 @@ public Rule getRuleByName(String name) {
         return null;
     }
 
+    /**
+     * Gets the rule using the specified name
+     *
+     * @param id name of the rule
+     * @return Rule
+     */
+    public Rule getRuleByID(String id) {
+        for (Rule rule : basicRules) {
+            if (rule.getRuleID().equals(id)) {
+                return rule;
+            }
+        }
+        for (Rule rule : contradictionRules) {
+            if (rule.getRuleID().equals(id)) {
+                return rule;
+            }
+        }
+        for (Rule rule : caseRules) {
+            if (rule.getRuleID().equals(id)) {
+                return rule;
+            }
+        }
+        Rule mergeRule = new MergeRule();
+        if (mergeRule.getRuleID().equals(id)) {
+            return mergeRule;
+        }
+        return null;
+    }
+
     /**
      * Gets the current board
      *

diff --git a/src/main/java/edu/rpi/legup/model/PuzzleExporter.java b/src/main/java/edu/rpi/legup/model/PuzzleExporter.java
@@ -44,7 +44,7 @@ public void exportPuzzle(String fileName) throws ExportFileException {
             Document newDocument = docBuilder.newDocument();
 
             org.w3c.dom.Element legupElement = newDocument.createElement("Legup");
-            legupElement.setAttribute("version", "2.0.0");
+            legupElement.setAttribute("version", "3.0.0");
             newDocument.appendChild(legupElement);
 
             org.w3c.dom.Element puzzleElement = newDocument.createElement("puzzle");
@@ -112,6 +112,7 @@ protected Element createTreeElement(Document newDocument) {
 
                     if (transition.isJustified()) {
                         transElement.setAttribute("rule", transition.getRule().getRuleName());
+                        transElement.setAttribute("rule_id", transition.getRule().getRuleID());
                     }
 
                     for (PuzzleElement data : transition.getBoard().getModifiedData()) {

diff --git a/src/main/java/edu/rpi/legup/model/PuzzleImporter.java b/src/main/java/edu/rpi/legup/model/PuzzleImporter.java
@@ -154,10 +154,10 @@ protected void createTree(Node node) throws InvalidFileFormatException {
             String nodeId = treeNodeElement.getAttribute("id");
             String isRoot = treeNodeElement.getAttribute("root");
             if (nodeId.isEmpty()) {
-                throw new InvalidFileFormatException("Proof Tree construction error: cannot find node id");
+                throw new InvalidFileFormatException("Proof Tree construction error: cannot find node ID");
             }
             if (treeNodes.containsKey(nodeId)) {
-                throw new InvalidFileFormatException("Proof Tree construction error: duplicate tree node id found");
+                throw new InvalidFileFormatException("Proof Tree construction error: duplicate tree node ID found");
             }
             TreeNode treeNode = new TreeNode(puzzle.getCurrentBoard().copy());
             if (isRoot.equalsIgnoreCase("true")) {
@@ -187,23 +187,24 @@ protected void createTree(Node node) throws InvalidFileFormatException {
                         treeNode.addChild(transition);
                         continue;
                     } else {
-                        throw new InvalidFileFormatException("Proof Tree construction error: duplicate transition id found");
+                        throw new InvalidFileFormatException("Proof Tree construction error: duplicate transition ID found");
                     }
 
                 }
 
                 String childId = trans.getAttribute("child");
                 String ruleName = trans.getAttribute("rule");
+                String ruleId = trans.getAttribute("rule_id");
 
                 TreeNode child = treeNodes.get(childId);
 
                 transition = new TreeTransition(treeNode, treeNode.getBoard().copy());
 
                 Rule rule;
                 if (!ruleName.isEmpty()) {
-                    rule = puzzle.getRuleByName(ruleName);
+                    rule = puzzle.getRuleByID(ruleId);
                     if (rule == null) {
-                        throw new InvalidFileFormatException("Proof Tree construction error: could not find rule by name");
+                        throw new InvalidFileFormatException("Proof Tree construction error: could not find rule by ID");
                     }
                     transition.setRule(rule);
                 }

diff --git a/src/main/java/edu/rpi/legup/model/rules/Rule.java b/src/main/java/edu/rpi/legup/model/rules/Rule.java
@@ -108,6 +108,15 @@ public String getRuleName() {
         return ruleName;
     }
 
+    /**
+     * Gets the name of the rule
+     *
+     * @return name of the rule
+     */
+    public String getRuleID() {
+        return ruleID;
+    }
+
     /**
      * Sets the rule name
      *

diff --git a/src/main/java/edu/rpi/legup/puzzle/nurikabe/rules/CantReachWhiteContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/nurikabe/rules/CantReachWhiteContradictionRule.java
@@ -15,7 +15,7 @@ public class CantReachWhiteContradictionRule extends ContradictionRule {
 
     public CantReachWhiteContradictionRule() {
         super("NURI-CONT-0002",
-                "Cant Reach white cell",
+                "Unreachables are Black",
                 "A white cell must be able to reach a white region",
                 "edu/rpi/legup/images/nurikabe/contradictions/CantReach.png");
     }