Add an EditNode which reuses the attribute parsing from AddDep to update the values on a node

Author: AngledLuffa

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

@@ -0,0 +1,80 @@
+package edu.stanford.nlp.semgraph.semgrex.ssurgeon;
+
+import java.util.Map;
+import java.util.TreeMap;
+
+import edu.stanford.nlp.ling.CoreLabel;
+import edu.stanford.nlp.ling.IndexedWord;
+import edu.stanford.nlp.semgraph.SemanticGraph;
+import edu.stanford.nlp.semgraph.semgrex.SemgrexMatcher;
+
+/**
+ * Edit an existing node to have new attributes.
+ *
+ * @author John Bauer
+ */
+public class EditNode extends SsurgeonEdit {
+  public static final String LABEL = "editNode";
+
+  final String nodeName;
+  final Map<String, String> attributes;
+
+  public EditNode(String nodeName, Map<String, String> attributes) {
+    if (nodeName == null) {
+      throw new SsurgeonParseException("Cannot make an EditNode with no nodeName");
+    }
+    if (attributes.size() == 0) {
+      throw new SsurgeonParseException("Cannot make an EditNode with no attributes");
+    }
+    this.nodeName = nodeName;
+    this.attributes = new TreeMap<>(attributes);
+  }
+
+
+  /**
+   * Emits a parseable instruction string.
+   */
+  @Override
+  public String toEditString() {
+    StringBuilder buf = new StringBuilder();
+    buf.append(LABEL);  buf.append("\t");
+    buf.append(Ssurgeon.NODENAME_ARG);buf.append(" ");
+    buf.append(nodeName); buf.append("\t");
+
+    for (String key : attributes.keySet()) {
+      buf.append("-");
+      buf.append(key);
+      buf.append(" ");
+      buf.append(attributes.get(key));
+      buf.append("\"\t");
+    }
+
+    return buf.toString();
+  }
+
+  public boolean evaluate(SemanticGraph sg, SemgrexMatcher sm) {
+    IndexedWord word = sm.getNode(nodeName);
+    if (word == null)
+      return false;
+
+    CoreLabel other = AddDep.fromCheapStrings(attributes);
+    boolean changed = false;
+    for (Class key : other.keySet()) {
+      Object thisV = word.get(key);
+      Object otherV = other.get(key);
+      if (thisV == null || otherV == null) {
+        if (thisV != null || otherV != null) {
+          changed = true;
+          word.set(key, otherV);
+        }
+      } else {
+        if (!thisV.equals(otherV)) {
+          changed = true;
+          word.set(key, otherV);
+        }
+      }
+    }
+
+    return changed;
+  }
+}

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

@@ -395,6 +395,8 @@ public static SsurgeonEdit parseEditLine(String editLine) {
       retEdit = AddEdge.createEngAddEdge(argsBox.govNodeName, argsBox.dep, argsBox.reln, argsBox.weight);
     } else if (command.equalsIgnoreCase(DeleteGraphFromNode.LABEL)) {
       retEdit = new DeleteGraphFromNode(argsBox.node);
+    } else if (command.equalsIgnoreCase(EditNode.LABEL)) {
+      retEdit = new EditNode(argsBox.node, argsBox.annotations);
     } else if (command.equalsIgnoreCase(RelabelNamedEdge.LABEL)) {
       // TODO: pass around a Language (perhaps via ssurgeon argument)
       // rather than hardcoding English, which is probably not even true

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

@@ -826,6 +826,42 @@ public void checkAnnotationConversionErrors() {
     }
   }
 
+
+  /**
+   * Check that adding a word to the start of a sentence works as expected
+   */
+  @Test
+  public void readXMLEditNode() {
+    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 -word blue</edit-list>",
+                             "  </ssurgeon-pattern>",
+                             "</ssurgeon-pattern-list>");
+    List<SsurgeonPattern> patterns = inst.readFromString(add);
+    assertEquals(patterns.size(), 1);
+    SsurgeonPattern editSsurgeon = patterns.get(0);
+
+    SemanticGraph sg = SemanticGraph.valueOf("[has-2 nsubj> Jennifer-1 obj> [antennae-4 dep> green-3]]");
+    IndexedWord blueVertex = sg.getNodeByIndexSafe(3);
+    assertEquals("green", blueVertex.value());
+    SemanticGraph newSG = editSsurgeon.iterate(sg);
+    SemanticGraph expected = SemanticGraph.valueOf("[has-2 nsubj> Jennifer-1 obj> [antennae-4 dep> blue-3]]");
+    assertEquals(expected, newSG);
+    // the Ssurgeon we just created should not put a tag on the word
+    // but it SHOULD put blue at the start of the sentence
+    blueVertex = newSG.getNodeByIndexSafe(3);
+    assertNotNull(blueVertex);
+    assertNull(blueVertex.tag());
+    assertEquals("blue", blueVertex.value());
+  }
+
   /**
    * 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