Error check that no one tries to update idx, sentIdx, or DocId

Author: AngledLuffa

src/edu/stanford/nlp/semgraph/semgrex/ssurgeon/AddDep.java

@@ -60,6 +60,8 @@ public AddDep(String govNodeName, GrammaticalRelation relation, Map<String, Stri
       }
     }
 
+    checkIllegalAttributes(attributes);
+
     this.attributes = new TreeMap<>(attributes);
     this.relation = relation;
     this.govNodeName = govNodeName;
@@ -200,6 +202,22 @@ public boolean evaluate(SemanticGraph sg, SemgrexMatcher sm) {
     return true;
   }
 
+  /**
+   * Certain attributes cannot be edited, especially docid, sentid, idx,
+   * or they mess up the hashmaps in the SemanticGraph
+   */
+  public static void checkIllegalAttributes(Map<String, String> attributes) {
+    if (attributes.containsKey("idx")) {
+      throw new SsurgeonParseException("Cannot manually set the index attribute.  If you need a moveWord operation, please file an issue on github.");
+    }
+    if (attributes.containsKey("sentIndex")) {
+      throw new SsurgeonParseException("Cannot manually change the sentence index.  If you need an operation to change an entire sentence's sentIndex, please file an issue on github.");
+    }
+    if (attributes.containsKey("docID")) {
+      throw new SsurgeonParseException("Cannot manually change a document ID.  If you need an operation to change an entire sentence's document ID, please file an issue on github.");
+    }
+  }
+
   /**
    * Given the keys and values of the CoreAnnotation attributes,
    * build a CoreLabel to use as the new word

src/edu/stanford/nlp/semgraph/semgrex/ssurgeon/EditNode.java

@@ -26,6 +26,7 @@ public EditNode(String nodeName, Map<String, String> attributes) {
     if (attributes.size() == 0) {
       throw new SsurgeonParseException("Cannot make an EditNode with no attributes");
     }
+    AddDep.checkIllegalAttributes(attributes);
     this.nodeName = nodeName;
     this.attributes = new TreeMap<>(attributes);
   }

test/src/edu/stanford/nlp/semgraph/semgrex/ssurgeon/SsurgeonTest.java

@@ -862,6 +862,47 @@ public void readXMLEditNode() {
     assertEquals("blue", blueVertex.value());
   }
 
+
+  /**
+   * Test that we don't allow changing a word index, for example, in EditNode or AddDep
+   */
+  @Test
+  public void forbidIllegalAttributes() {
+    Ssurgeon inst = Ssurgeon.inst();
+
+    // use "dep" as the dependency so as to be language-agnostic in this test
+    String add = String.join(newline,
+                             "<ssurgeon-pattern-list>",
+                             "  <ssurgeon-pattern>",
+                             "    <uid>38</uid>",
+                             "    <notes>Edit a node</notes>",
+                             "    <semgrex>" + XMLUtils.escapeXML("{word:green}=blue") + "</semgrex>",
+                             "    <edit-list>EditNode -node blue -idx 5</edit-list>",
+                             "  </ssurgeon-pattern>",
+                             "</ssurgeon-pattern-list>");
+    try {
+      List<SsurgeonPattern> patterns = inst.readFromString(add);
+      throw new AssertionError("Expected a parse exception!");
+    } catch(SsurgeonParseException e) {
+      // yay
+    }
+    add = String.join(newline,
+                      "<ssurgeon-pattern-list>",
+                      "  <ssurgeon-pattern>",
+                      "    <uid>38</uid>",
+                      "    <notes>Edit a node</notes>",
+                      "    <semgrex>" + XMLUtils.escapeXML("{word:green}=blue") + "</semgrex>",
+                      "    <edit-list>addDep -gov antennae -reln dep -headidx blue -idx 5</edit-list>",
+                      "  </ssurgeon-pattern>",
+                      "</ssurgeon-pattern-list>");
+    try {
+      List<SsurgeonPattern> patterns = inst.readFromString(add);
+      throw new AssertionError("Expected a parse exception!");
+    } catch(SsurgeonParseException e) {
+      // yay
+    }
+  }
+
   /**
    * Simple test of an Ssurgeon edit script.  This instances a simple semantic graph,
    * a semgrex pattern, and then the resulting actions over the named nodes in the