opennlp git commit: OPENNLP-1004: Write a test case for the BilouCodec class

[jo...@apache.org]

Repository: opennlp
Updated Branches:
  refs/heads/master f1984c42b -> c2abe862e


OPENNLP-1004: Write a test case for the BilouCodec class

This closes #142


Project: http://git-wip-us.apache.org/repos/asf/opennlp/repo
Commit: http://git-wip-us.apache.org/repos/asf/opennlp/commit/c2abe862
Tree: http://git-wip-us.apache.org/repos/asf/opennlp/tree/c2abe862
Diff: http://git-wip-us.apache.org/repos/asf/opennlp/diff/c2abe862

Branch: refs/heads/master
Commit: c2abe862ecb7f980260a7b44d907fa116a6bbab9
Parents: f1984c4
Author: Peter Thygesen <pe...@gmail.com>
Authored: Wed Mar 15 18:54:26 2017 +0100
Committer: J�rn Kottmann <jo...@apache.org>
Committed: Thu Mar 16 09:52:48 2017 +0100

----------------------------------------------------------------------
 .../opennlp/tools/namefind/BilouCodecTest.java  | 209 +++++++++++++++++++
 1 file changed, 209 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/opennlp/blob/c2abe862/opennlp-tools/src/test/java/opennlp/tools/namefind/BilouCodecTest.java
----------------------------------------------------------------------
diff --git a/opennlp-tools/src/test/java/opennlp/tools/namefind/BilouCodecTest.java b/opennlp-tools/src/test/java/opennlp/tools/namefind/BilouCodecTest.java
new file mode 100644
index 0000000..96d939f
--- /dev/null
+++ b/opennlp-tools/src/test/java/opennlp/tools/namefind/BilouCodecTest.java
@@ -0,0 +1,209 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package opennlp.tools.namefind;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import opennlp.tools.util.Span;
+
+/**
+ * This is the test class for {@link BilouCodec}.
+ */
+public class BilouCodecTest {
+
+  private static final BilouCodec codec = new BilouCodec();
+
+  private static final String A_TYPE = "atype";
+  private static final String A_START = A_TYPE + "-" + BilouCodec.START;
+  private static final String A_CONTINUE = A_TYPE + "-" + BilouCodec.CONTINUE;
+  private static final String A_LAST = A_TYPE + "-" + BilouCodec.LAST;
+  private static final String A_UNIT = A_TYPE + "-" + BilouCodec.UNIT;
+
+  private static final String B_TYPE = "btype";
+  private static final String B_START = B_TYPE + "-" + BilouCodec.START;
+  private static final String B_CONTINUE = B_TYPE + "-" + BilouCodec.CONTINUE;
+  private static final String B_LAST = B_TYPE + "-" + BilouCodec.LAST;
+  private static final String B_UNIT = B_TYPE + "-" + BilouCodec.UNIT;
+
+  private static final String C_TYPE = "ctype";
+  private static final String C_UNIT = C_TYPE + "-" + BilouCodec.UNIT;
+
+  private static final String OTHER = BilouCodec.OTHER;
+
+  @Test
+  public void testEncodeNoNames() {
+    NameSample nameSample = new NameSample("Once upon a time.".split(" "), new Span[] {}, true);
+    String[] expected = new String[] {OTHER, OTHER, OTHER, OTHER};
+    String[] acutal = codec.encode(nameSample.getNames(), nameSample.getSentence().length);
+    Assert.assertArrayEquals("Only 'Other' is expected.", expected, acutal);
+  }
+
+  @Test
+  public void testEncodeSingleUnitTokenSpan() {
+    String[] sentence = "I called Julie again.".split(" ");
+    Span[] singleSpan = new Span[] { new Span(2,3, A_TYPE)};
+    NameSample nameSample = new NameSample(sentence, singleSpan, true);
+    String[] expected = new String[] {OTHER, OTHER, A_UNIT, OTHER};
+    String[] acutal = codec.encode(nameSample.getNames(), nameSample.getSentence().length);
+    Assert.assertArrayEquals("'Julie' should be 'unit' only, the rest should be 'other'.", expected, acutal);
+  }
+
+  @Test
+  public void testEncodeDoubleTokenSpan() {
+    String[] sentence = "I saw Stefanie Schmidt today.".split(" ");
+    Span[] singleSpan = new Span[] { new Span(2,4, A_TYPE)};
+    NameSample nameSample = new NameSample(sentence, singleSpan, true);
+    String[] expected = new String[] {OTHER, OTHER, A_START, A_LAST, OTHER};
+    String[] acutal = codec.encode(nameSample.getNames(), nameSample.getSentence().length);
+    Assert.assertArrayEquals("'Stefanie' should be 'start' only, 'Schmidt' is 'last' " +
+        "and the rest should be 'other'.", expected, acutal);
+  }
+
+  @Test
+  public void testEncodeTripleTokenSpan() {
+    String[] sentence = "Secretary - General Anders Fogh Rasmussen is from Denmark.".split(" ");
+    Span[] singleSpan = new Span[] { new Span(3,6, A_TYPE)};
+    NameSample nameSample = new NameSample(sentence, singleSpan, true);
+    String[] expected = new String[] {OTHER, OTHER, OTHER, A_START, A_CONTINUE,
+        A_LAST, OTHER, OTHER, OTHER};
+    String[] acutal = codec.encode(nameSample.getNames(), nameSample.getSentence().length);
+    Assert.assertArrayEquals("'Anders' should be 'start' only, 'Fogh' is 'inside', " +
+        "'Rasmussen' is 'last' and the rest should be 'other'.", expected, acutal);
+  }
+
+  @Test
+  public void testEncodeAdjacentUnitSpans() {
+    String[] sentence = "word PersonA PersonB word".split(" ");
+    Span[] singleSpan = new Span[] { new Span(1,2, A_TYPE), new Span(2, 3, A_TYPE)};
+    NameSample nameSample = new NameSample(sentence, singleSpan, true);
+    String[] expected = new String[] {OTHER, A_UNIT, A_UNIT, OTHER};
+    String[] acutal = codec.encode(nameSample.getNames(), nameSample.getSentence().length);
+    Assert.assertArrayEquals("Both PersonA and PersonB are 'unit' tags", expected, acutal);
+  }
+
+  @Test
+  public void testCreateSequenceValidator() {
+    Assert.assertTrue(codec.createSequenceValidator() instanceof BilouNameFinderSequenceValidator);
+  }
+
+  @Test
+  public void testDecodeEmpty() {
+    Span[] expected = new Span[] {};
+    Span[] actual = codec.decode(new ArrayList<String>());
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+  /**
+   * Unit, Other
+   */
+  @Test
+  public void testDecodeSingletonFirst() {
+
+    List<String> encoded = Arrays.asList(A_UNIT, OTHER);
+    Span[] expected = new Span[] {new Span(0,1, A_TYPE)};
+    Span[] actual = codec.decode(encoded);
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+  /**
+   * Unit, Unit, Other
+   */
+  @Test
+  public void testDecodeAdjacentSingletonFirst() {
+    List<String> encoded = Arrays.asList(A_UNIT, A_UNIT, OTHER);
+    Span[] expected = new Span[] {new Span(0, 1, A_TYPE), new Span(1, 2, A_TYPE)};
+    Span[] actual = codec.decode(encoded);
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+  /**
+   * Start, Last, Other
+   */
+  @Test
+  public void testDecodePairFirst() {
+    List<String> encoded = Arrays.asList(A_START, A_LAST, OTHER);
+    Span[] expected = new Span[] {new Span(0, 2, A_TYPE)};
+    Span[] actual = codec.decode(encoded);
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+  /**
+   * Start, Continue, Last, Other
+   */
+  @Test
+  public void testDecodeTripletFirst() {
+    List<String> encoded = Arrays.asList(A_START, A_CONTINUE, A_LAST, OTHER);
+    Span[] expected = new Span[] {new Span(0, 3, A_TYPE)};
+    Span[] actual = codec.decode(encoded);
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+  /**
+   * Start, Continue, Continue, Last, Other
+   */
+  @Test
+  public void testDecodeTripletContinuationFirst() {
+    List<String> encoded = Arrays.asList(A_START, A_CONTINUE, A_CONTINUE,
+        A_LAST, OTHER);
+    Span[] expected = new Span[] {new Span(0, 4, A_TYPE)};
+    Span[] actual = codec.decode(encoded);
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+  /**
+   * Start, Last, Unit, Other
+   */
+  @Test
+  public void testDecodeAdjacentPairSingleton() {
+    List<String> encoded = Arrays.asList(A_START, A_LAST, A_UNIT, OTHER);
+    Span[] expected = new Span[] {new Span(0, 2, A_TYPE),
+        new Span(2, 3, A_TYPE)};
+    Span[] actual = codec.decode(encoded);
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+  /**
+   * Other, Unit, Other
+   */
+  @Test
+  public void testDecodeOtherFirst() {
+    List<String> encoded = Arrays.asList(OTHER, A_UNIT, OTHER);
+    Span[] expected = new Span[] {new Span(1, 2, A_TYPE)};
+    Span[] actual = codec.decode(encoded);
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+  /**
+   * Other, A-Start, A-Continue, A-Last, Other, B-Start, B-Last, Other, C-Unit, Other
+   */
+  @Test
+  public void testDecodeMultiClass() {
+    List<String> encoded = Arrays.asList(OTHER, A_START, A_CONTINUE, A_LAST, OTHER,
+        B_START, B_LAST, OTHER, C_UNIT, OTHER);
+    Span[] expected = new Span[] {new Span(1, 4, A_TYPE),
+        new Span(5, 7, B_TYPE), new Span(8,9, C_TYPE)};
+    Span[] actual = codec.decode(encoded);
+    Assert.assertArrayEquals(expected, actual);
+  }
+
+}