Merge PR #1155 head update into the gRPC helper base

Author: krickert

dev/test-omw-wordnets.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+# 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.
+
+set -euo pipefail
+
+readonly RELEASE_URL="https://github.com/omwn/omw-data/releases/download/v2.0"
+readonly IT_SHA512="d0ed09eaa6617509a7c8a1162e92d8085570328f5f773a108a168d7c517b02c8a1a79fe81297b7e94722b480b22f44f34419c46675f0c3e3af253504c2c5b380"
+readonly ES_SHA512="86851763f10cf9ba1c5ea42e8c09bcbff7954aea22c62fbd229bcf546f236de4d67251582ecfd7956e8dae22e975fdf1d5bfa3fd7e2fbf4d901751c89bc0ca66"
+readonly SV_SHA512="897a79c6a6ec43c10024c6ee55aac886bd27182e28127ef1248cc8748c1189e573b05b0b2cd9ada91756f0527b25cbac9a49b88a1f13a897f5442da7f0656c13"
+
+fixture_dir=$(mktemp -d "${TMPDIR:-/tmp}/opennlp-omw.XXXXXXXX")
+trap 'rm -rf -- "$fixture_dir"' EXIT
+
+fetch() {
+  local language=$1
+  local expected=$2
+  local archive="$fixture_dir/omw-$language-2.0.tar.xz"
+  curl --fail --location --silent --show-error \
+    --connect-timeout 15 --max-time 120 \
+    --output "$archive" "$RELEASE_URL/omw-$language-2.0.tar.xz"
+  local actual
+  actual=$(sha512sum "$archive" | cut -d' ' -f1)
+  if [[ "$actual" != "$expected" ]]; then
+    echo "SHA-512 mismatch for omw-$language-2.0.tar.xz" >&2
+    exit 1
+  fi
+  tar -xJf "$archive" -C "$fixture_dir"
+}
+
+fetch it "$IT_SHA512"
+fetch es "$ES_SHA512"
+fetch sv "$SV_SHA512"
+
+repo_dir=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)
+cd "$repo_dir"
+./mvnw -pl opennlp-extensions/opennlp-wordnet -am \
+  -Dopennlp.forkCount=1 -Drat.skip=true \
+  -Dtest=WnLmfOmwIntegrationTest -Dsurefire.failIfNoSpecifiedTests=false \
+  -Dopennlp.wordnet.omwDir="$fixture_dir" test

opennlp-api/src/main/java/opennlp/tools/wordnet/Synset.java

@@ -39,8 +39,9 @@
  *                  empty.
  * @param pos       The part of speech. Must not be {@code null}.
  * @param lemmas    The member lemmas in source order, human-readable (multiword lemmas use
- *                  spaces, not the underscores some formats store). Must not be {@code null} or
- *                  empty, and must not contain {@code null} or empty elements.
+ *                  spaces, not the underscores some formats store). Must not be {@code null} and
+ *                  must not contain {@code null} or empty elements. May be empty for an
+ *                  unlexicalized concept retained as a relation target.
  * @param gloss     The definition text, possibly empty when the source has none. Must not be
  *                  {@code null}.
  * @param relations The typed relations, each mapping to the target synset ids in source order.
@@ -67,8 +68,8 @@ public record Synset(
     if (pos == null) {
       throw new IllegalArgumentException("Pos must not be null");
     }
-    if (lemmas == null || lemmas.isEmpty()) {
-      throw new IllegalArgumentException("Lemmas must not be null or empty for synset " + id);
+    if (lemmas == null) {
+      throw new IllegalArgumentException("Lemmas must not be null for synset " + id);
     }
     for (final String lemma : lemmas) {
       if (lemma == null || lemma.isEmpty()) {

opennlp-api/src/main/java/opennlp/tools/wordnet/WordNetRelation.java

@@ -23,6 +23,10 @@
  * <p>Relations that a source format draws between individual word senses (antonymy and
  * derivation, for example) surface here at the synset level: the synset containing the source
  * sense carries the relation to the synset containing the target sense.</p>
+ *
+ * <p>The vocabulary includes every typed synset and sense relation in the
+ * <a href="https://globalwordnet.github.io/schemas/WN-LMF-1.4.dtd">Global WordNet Association
+ * WN-LMF 1.4 format</a>. Format-specific readers document any contextual mapping.</p>
  */
 public enum WordNetRelation {
 
@@ -111,5 +115,239 @@ public enum WordNetRelation {
   DOMAIN_USAGE,
 
   /** A synset belonging to this usage domain. */
-  MEMBER_OF_DOMAIN_USAGE
+  MEMBER_OF_DOMAIN_USAGE,
+
+  /** An entity that intentionally performs or initiates an event. */
+  AGENT,
+
+  /** A state that this concept enters or occupies. */
+  BE_IN_STATE,
+
+  /** A semantic class that classifies this concept. */
+  CLASSIFIED_BY,
+
+  /** A concept classified by this semantic class. */
+  CLASSIFIES,
+
+  /** An instrument that participates with this agent. */
+  CO_AGENT_INSTRUMENT,
+
+  /** A patient that participates with this agent. */
+  CO_AGENT_PATIENT,
+
+  /** A result that participates with this agent. */
+  CO_AGENT_RESULT,
+
+  /** An agent that participates with this instrument. */
+  CO_INSTRUMENT_AGENT,
+
+  /** A patient that participates with this instrument. */
+  CO_INSTRUMENT_PATIENT,
+
+  /** A result that participates with this instrument. */
+  CO_INSTRUMENT_RESULT,
+
+  /** An agent that participates with this patient. */
+  CO_PATIENT_AGENT,
+
+  /** An instrument that participates with this patient. */
+  CO_PATIENT_INSTRUMENT,
+
+  /** An agent that participates with this result. */
+  CO_RESULT_AGENT,
+
+  /** An instrument that participates with this result. */
+  CO_RESULT_INSTRUMENT,
+
+  /** A semantic role that participates with this role. */
+  CO_ROLE,
+
+  /** A direction associated with an event or entity. */
+  DIRECTION,
+
+  /** An equivalent synonym relation from WN-LMF. */
+  EQ_SYNONYM,
+
+  /** The location whole that contains this concept. */
+  LOCATION_HOLONYM,
+
+  /** The portion whole that contains this concept. */
+  PORTION_HOLONYM,
+
+  /** A whole related by an unspecified holonym relation. */
+  HOLONYM,
+
+  /** The manner in which this concept occurs. */
+  IN_MANNER,
+
+  /** An instrument used in an event. */
+  INSTRUMENT,
+
+  /** A location associated with an entity or event. */
+  LOCATION,
+
+  /** An event or situation in which this concept is involved. */
+  INVOLVED,
+
+  /** The agent involved in an event. */
+  INVOLVED_AGENT,
+
+  /** The direction involved in an event. */
+  INVOLVED_DIRECTION,
+
+  /** The instrument involved in an event. */
+  INVOLVED_INSTRUMENT,
+
+  /** The location involved in an event. */
+  INVOLVED_LOCATION,
+
+  /** The patient involved in an event. */
+  INVOLVED_PATIENT,
+
+  /** The result involved in an event. */
+  INVOLVED_RESULT,
+
+  /** The source direction involved in an event. */
+  INVOLVED_SOURCE_DIRECTION,
+
+  /** The target direction involved in an event. */
+  INVOLVED_TARGET_DIRECTION,
+
+  /** A synonym relation that is intentionally irregular or non-equivalent. */
+  IR_SYNONYM,
+
+  /** An event of which this concept is a subevent. */
+  IS_SUBEVENT_OF,
+
+  /** An event for which this concept specifies the manner. */
+  MANNER_OF,
+
+  /** A location part contained by this concept. */
+  LOCATION_MERONYM,
+
+  /** A portion contained by this concept. */
+  PORTION_MERONYM,
+
+  /** A part related by an unspecified meronym relation. */
+  MERONYM,
+
+  /** An entity affected by an event. */
+  PATIENT,
+
+  /** A concept that restricts this concept. */
+  RESTRICTED_BY,
+
+  /** A concept restricted by this concept. */
+  RESTRICTS,
+
+  /** A result produced by an event. */
+  RESULT,
+
+  /** A semantic role associated with an event. */
+  ROLE,
+
+  /** The source direction of an event. */
+  SOURCE_DIRECTION,
+
+  /** An event or entity for which this concept is a state. */
+  STATE_OF,
+
+  /** An event contained within this event. */
+  SUBEVENT,
+
+  /** The target direction of an event. */
+  TARGET_DIRECTION,
+
+  /** A feminine form related to this concept. */
+  FEMININE,
+
+  /** A concept whose feminine form is this concept. */
+  HAS_FEMININE,
+
+  /** A masculine form related to this concept. */
+  MASCULINE,
+
+  /** A concept whose masculine form is this concept. */
+  HAS_MASCULINE,
+
+  /** A young form related to this concept. */
+  YOUNG,
+
+  /** A concept whose young form is this concept. */
+  HAS_YOUNG,
+
+  /** A diminutive form related to this concept. */
+  DIMINUTIVE,
+
+  /** A concept whose diminutive form is this concept. */
+  HAS_DIMINUTIVE,
+
+  /** An augmentative form related to this concept. */
+  AUGMENTATIVE,
+
+  /** A concept whose augmentative form is this concept. */
+  HAS_AUGMENTATIVE,
+
+  /** A gradable antonym relation. */
+  ANTO_GRADABLE,
+
+  /** A simple antonym relation. */
+  ANTO_SIMPLE,
+
+  /** A converse antonym relation. */
+  ANTO_CONVERSE,
+
+  /** A simple imperfective-to-perfective aspect relation. */
+  SIMPLE_ASPECT_IP,
+
+  /** A secondary imperfective-to-perfective aspect relation. */
+  SECONDARY_ASPECT_IP,
+
+  /** A simple perfective-to-imperfective aspect relation. */
+  SIMPLE_ASPECT_PI,
+
+  /** A secondary perfective-to-imperfective aspect relation. */
+  SECONDARY_ASPECT_PI,
+
+  /** A metaphorically related sense. */
+  METAPHOR,
+
+  /** A sense for which this sense is a metaphor. */
+  HAS_METAPHOR,
+
+  /** A metonymically related sense. */
+  METONYM,
+
+  /** A sense for which this sense is a metonym. */
+  HAS_METONYM,
+
+  /** The material associated with an entity or event. */
+  MATERIAL,
+
+  /** An event associated with a sense. */
+  EVENT,
+
+  /** The means by which an event occurs. */
+  BY_MEANS_OF,
+
+  /** An entity that undergoes an event. */
+  UNDERGOER,
+
+  /** A property expressed by a sense. */
+  PROPERTY,
+
+  /** A state expressed by a sense. */
+  STATE,
+
+  /** A resource or entity used by an event. */
+  USES,
+
+  /** The destination of an event. */
+  DESTINATION,
+
+  /** A body part associated with a sense. */
+  BODY_PART,
+
+  /** A vehicle associated with a sense. */
+  VEHICLE
 }

opennlp-api/src/test/java/opennlp/tools/wordnet/SynsetTest.java

@@ -109,11 +109,11 @@ void testRejectsNullPos() {
   }
 
   @Test
-  void testRejectsNullOrEmptyLemmas() {
+  void testAllowsUnlexicalizedSynsetButRejectsInvalidLemmaLists() {
     assertThrows(IllegalArgumentException.class,
         () -> new Synset("test-1-n", WordNetPOS.NOUN, null, "", Map.of()));
-    assertThrows(IllegalArgumentException.class,
-        () -> new Synset("test-1-n", WordNetPOS.NOUN, List.of(), "", Map.of()));
+    assertTrue(new Synset("test-1-n", WordNetPOS.NOUN, List.of(), "", Map.of())
+        .lemmas().isEmpty());
     final List<String> withNull = new ArrayList<>();
     withNull.add(null);
     assertThrows(IllegalArgumentException.class,