[GH-288] Rename MultilingualString in OntoDriver to Translations.

Should prevent confusion with MultilingualString in JOPA API.
kbss-cvut · Dec 11, 2024 · ba9ac57 · ba9ac57
1 parent 853e5c3
commit ba9ac57
Show file tree

Hide file tree

Showing 16 changed files with 82 additions and 83 deletions.
diff --git a/jopa-impl/src/main/java/cz/cvut/kbss/jopa/oom/converter/ToMultilingualStringConverter.java b/jopa-impl/src/main/java/cz/cvut/kbss/jopa/oom/converter/ToMultilingualStringConverter.java
@@ -19,6 +19,7 @@
 
 import cz.cvut.kbss.jopa.model.MultilingualString;
 import cz.cvut.kbss.ontodriver.model.LangString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 
 /**
  * Supports mapping selected value types to multilingual strings.
@@ -30,17 +31,16 @@ public class ToMultilingualStringConverter implements ConverterWrapper<Multiling
 
     @Override
     public Object convertToAxiomValue(MultilingualString value) {
-        return new cz.cvut.kbss.ontodriver.model.MultilingualString(value.getValue());
+        return new Translations(value.getValue());
     }
 
     @Override
     public MultilingualString convertToAttribute(Object value) {
         final Class<?> type = value.getClass();
         assert supportsAxiomValueType(type);
-        if (value instanceof cz.cvut.kbss.ontodriver.model.MultilingualString) {
-            return new MultilingualString(((cz.cvut.kbss.ontodriver.model.MultilingualString) value).getValue());
-        } else if (value instanceof LangString) {
-            final LangString ls = (LangString) value;
+        if (value instanceof Translations translations) {
+            return new MultilingualString(translations.getValue());
+        } else if (value instanceof LangString ls) {
             return MultilingualString.create(ls.getValue(), ls.getLanguage().orElse(null));
         } else {
             return MultilingualString.create(value.toString(), null);
@@ -49,7 +49,7 @@ public MultilingualString convertToAttribute(Object value) {
 
     @Override
     public boolean supportsAxiomValueType(Class<?> type) {
-        return cz.cvut.kbss.ontodriver.model.MultilingualString.class.isAssignableFrom(type)
+        return Translations.class.isAssignableFrom(type)
                 || LangString.class.isAssignableFrom(type)
                 || String.class.isAssignableFrom(type);
     }

diff --git a/...impl/src/test/java/cz/cvut/kbss/jopa/oom/converter/ToMultilingualStringConverterTest.java b/...impl/src/test/java/cz/cvut/kbss/jopa/oom/converter/ToMultilingualStringConverterTest.java
@@ -18,7 +18,7 @@
 package cz.cvut.kbss.jopa.oom.converter;
 
 import cz.cvut.kbss.ontodriver.model.LangString;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
@@ -45,7 +45,7 @@ void supportsReturnsTrueForSupportedAxiomValueTypes(Class<?> type) {
 
     static Stream<Arguments> supportedTypes() {
         return Stream.of(
-                Arguments.of(MultilingualString.class),
+                Arguments.of(Translations.class),
                 Arguments.of(LangString.class),
                 Arguments.of(String.class)
         );
@@ -61,13 +61,13 @@ void convertToAxiomValueReturnsOntoDriverMultilingualStringWithProvidedValue() {
         final cz.cvut.kbss.jopa.model.MultilingualString value = cz.cvut.kbss.jopa.model.MultilingualString.create("en", "Test");
 
         final Object result = sut.convertToAxiomValue(value);
-        assertInstanceOf(MultilingualString.class, result);
-        assertEquals(value.getValue(), ((MultilingualString) result).getValue());
+        assertInstanceOf(Translations.class, result);
+        assertEquals(value.getValue(), ((Translations) result).getValue());
     }
 
     @Test
     void convertToAttributeConvertsOntoDriverMultilingualStringToJopaMultilingualString() {
-        final MultilingualString value = new MultilingualString(Map.of("en", "Test"));
+        final Translations value = new Translations(Map.of("en", "Test"));
 
         final cz.cvut.kbss.jopa.model.MultilingualString result = sut.convertToAttribute(value);
         assertEquals(value.getValue(), result.getValue());

diff --git a/.../ontodriver/model/MultilingualString.java → ...t/kbss/ontodriver/model/Translations.java b/.../ontodriver/model/MultilingualString.java → ...t/kbss/ontodriver/model/Translations.java
@@ -32,15 +32,15 @@
  * string need to be treated as a single value. Its main purpose is to allow support for multilingual strings in
  * referenced lists (e.g., {@link cz.cvut.kbss.ontodriver.Lists#loadReferencedList(ReferencedListDescriptor)}).
  */
-public final class MultilingualString implements Serializable {
+public final class Translations implements Serializable {
 
     private final Map<String, String> value;
 
-    public MultilingualString() {
+    public Translations() {
         this.value = new HashMap<>();
     }
 
-    public MultilingualString(Map<String, String> value) {
+    public Translations(Map<String, String> value) {
         this.value = new HashMap<>(Objects.requireNonNull(value));
     }
 
@@ -79,10 +79,9 @@ public boolean equals(Object o) {
         if (this == o) {
             return true;
         }
-        if (!(o instanceof MultilingualString)) {
+        if (!(o instanceof Translations that)) {
             return false;
         }
-        MultilingualString that = (MultilingualString) o;
         return value.equals(that.value);
     }
 

diff --git a/ontodriver-jena/src/main/java/cz/cvut/kbss/ontodriver/jena/list/ReferencedListHelper.java b/ontodriver-jena/src/main/java/cz/cvut/kbss/ontodriver/jena/list/ReferencedListHelper.java
@@ -20,7 +20,7 @@
 import cz.cvut.kbss.ontodriver.jena.util.JenaUtils;
 import cz.cvut.kbss.ontodriver.model.Assertion;
 import cz.cvut.kbss.ontodriver.model.LangString;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import cz.cvut.kbss.ontodriver.model.Value;
 import org.apache.jena.rdf.model.RDFNode;
 
@@ -33,7 +33,7 @@ private ReferencedListHelper() {
     }
 
     static Stream<RDFNode> toRdfNodes(Object value, Assertion nodeContentAssertion) {
-        if (value instanceof MultilingualString mls) {
+        if (value instanceof Translations mls) {
             return mls.getValue().entrySet().stream()
                       .map(e -> JenaUtils.valueToRdfNode(nodeContentAssertion, new Value<>(new LangString(e.getValue(), e.getKey()))));
         } else {

diff --git a/ontodriver-jena/src/main/java/cz/cvut/kbss/ontodriver/jena/list/ReferencedListIterator.java b/ontodriver-jena/src/main/java/cz/cvut/kbss/ontodriver/jena/list/ReferencedListIterator.java
@@ -24,7 +24,7 @@
 import cz.cvut.kbss.ontodriver.model.Assertion;
 import cz.cvut.kbss.ontodriver.model.Axiom;
 import cz.cvut.kbss.ontodriver.model.AxiomImpl;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import cz.cvut.kbss.ontodriver.model.NamedResource;
 import cz.cvut.kbss.ontodriver.model.Value;
 import org.apache.jena.rdf.model.Literal;
@@ -79,7 +79,7 @@ T nextValue() {
             return (T) (value.isResource() ? NamedResource.create(value.asResource()
                                                                        .getURI()) : JenaUtils.literalToValue(value.asLiteral()));
         } else {
-            final MultilingualString mls = new MultilingualString();
+            final Translations mls = new Translations();
             content.forEach(n -> {
                 assert n.isLiteral();
                 final Literal lit = n.asLiteral();

diff --git a/ontodriver-jena/src/test/java/cz/cvut/kbss/ontodriver/jena/list/ListTestUtil.java b/ontodriver-jena/src/test/java/cz/cvut/kbss/ontodriver/jena/list/ListTestUtil.java
@@ -19,7 +19,7 @@
 
 import cz.cvut.kbss.ontodriver.jena.connector.StorageConnector;
 import cz.cvut.kbss.ontodriver.jena.environment.Generator;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import org.apache.jena.rdf.model.Property;
 import org.apache.jena.rdf.model.Resource;
 import org.apache.jena.rdf.model.Statement;
@@ -118,10 +118,10 @@ void initReferencedListStatements(List<?> items) {
             final List<Statement> contentStatements;
             if (content instanceof URI) {
                 contentStatements = List.of(createStatement(node, hasContent, createResource(content.toString())));
-            } else if (content instanceof MultilingualString) {
-                contentStatements = ((MultilingualString) content).getValue().entrySet().stream()
-                                                                  .map(e -> createStatement(node, hasContent, createLangLiteral(e.getValue(), e.getKey())))
-                                                                  .collect(Collectors.toList());
+            } else if (content instanceof Translations) {
+                contentStatements = ((Translations) content).getValue().entrySet().stream()
+                                                            .map(e -> createStatement(node, hasContent, createLangLiteral(e.getValue(), e.getKey())))
+                                                            .collect(Collectors.toList());
             } else {
                 contentStatements = List.of(createStatement(node, hasContent, createTypedLiteral(content)));
             }

diff --git a/...river-jena/src/test/java/cz/cvut/kbss/ontodriver/jena/list/ReferencedListHandlerTest.java b/...river-jena/src/test/java/cz/cvut/kbss/ontodriver/jena/list/ReferencedListHandlerTest.java
@@ -25,7 +25,7 @@
 import cz.cvut.kbss.ontodriver.model.Assertion;
 import cz.cvut.kbss.ontodriver.model.Axiom;
 import cz.cvut.kbss.ontodriver.model.LangString;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import cz.cvut.kbss.ontodriver.model.NamedResource;
 import org.apache.jena.rdf.model.Property;
 import org.apache.jena.rdf.model.RDFNode;
@@ -330,12 +330,12 @@ public void loadListRetrievesAllDataPropertyListElements() {
 
     @Test
     void persistListSavesMultilingualStringTranslationsAsContentOfSingleNode() {
-        final ReferencedListValueDescriptor<MultilingualString> desc = new ReferencedListValueDescriptor<>(OWNER,
-                HAS_LIST,
-                HAS_NEXT, Assertion.createDataPropertyAssertion(HAS_CONTENT.getIdentifier(), false));
-        final List<MultilingualString> refList = List.of(
-                new MultilingualString(Map.of("en", "one", "cs", "jedna")),
-                new MultilingualString(Map.of("en", "two", "cs", "dva"))
+        final ReferencedListValueDescriptor<Translations> desc = new ReferencedListValueDescriptor<>(OWNER,
+                                                                                                     HAS_LIST,
+                                                                                                     HAS_NEXT, Assertion.createDataPropertyAssertion(HAS_CONTENT.getIdentifier(), false));
+        final List<Translations> refList = List.of(
+                new Translations(Map.of("en", "one", "cs", "jedna")),
+                new Translations(Map.of("en", "two", "cs", "dva"))
         );
         refList.forEach(desc::addValue);
 

diff --git a/...iver-jena/src/test/java/cz/cvut/kbss/ontodriver/jena/list/ReferencedListIteratorTest.java b/...iver-jena/src/test/java/cz/cvut/kbss/ontodriver/jena/list/ReferencedListIteratorTest.java
@@ -24,7 +24,7 @@
 import cz.cvut.kbss.ontodriver.jena.exception.ListProcessingException;
 import cz.cvut.kbss.ontodriver.model.Assertion;
 import cz.cvut.kbss.ontodriver.model.Axiom;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import cz.cvut.kbss.ontodriver.model.NamedResource;
 import org.apache.jena.rdf.model.Resource;
 import org.apache.jena.rdf.model.Statement;
@@ -221,11 +221,11 @@ void nextAxiomReturnsAxiomWithMultilingualStringValueWhenNodeContentIsMultilingu
                 createStatement(node, HAS_CONTENT, createLangLiteral("jedna", "cs"))
         );
         when(connectorMock.find(node, HAS_CONTENT, null, Collections.emptySet())).thenReturn(content);
-        final ReferencedListIterator<MultilingualString> sut = new ReferencedListIterator<>(descriptor(Assertion.AssertionType.DATA_PROPERTY, null), connectorMock);
+        final ReferencedListIterator<Translations> sut = new ReferencedListIterator<>(descriptor(Assertion.AssertionType.DATA_PROPERTY, null), connectorMock);
 
-        final Axiom<MultilingualString> result = sut.nextAxiom();
+        final Axiom<Translations> result = sut.nextAxiom();
         assertNotNull(result);
-        assertEquals(new MultilingualString(Map.of("en", "one", "cs", "jedna")), result.getValue().getValue());
+        assertEquals(new Translations(Map.of("en", "one", "cs", "jedna")), result.getValue().getValue());
     }
 
     @Test
@@ -238,9 +238,9 @@ void replaceReplacesAllTranslationsOfMultilingualStringInCurrentNode() {
                 createStatement(node, HAS_CONTENT, createLangLiteral("jedna", "cs"))
         );
         when(connectorMock.find(node, HAS_CONTENT, null, Collections.emptySet())).thenReturn(content);
-        final ReferencedListIterator<MultilingualString> sut = new ReferencedListIterator<>(descriptor(Assertion.AssertionType.DATA_PROPERTY, null), connectorMock);
+        final ReferencedListIterator<Translations> sut = new ReferencedListIterator<>(descriptor(Assertion.AssertionType.DATA_PROPERTY, null), connectorMock);
 
-        final MultilingualString newContent = new MultilingualString(Map.of(
+        final Translations newContent = new Translations(Map.of(
                 "en", "New",
                 "cs", "Nový"
         ));

diff --git a/...iver-owlapi/src/main/java/cz/cvut/kbss/ontodriver/owlapi/list/ReferencedListIterator.java b/...iver-owlapi/src/main/java/cz/cvut/kbss/ontodriver/owlapi/list/ReferencedListIterator.java
@@ -21,7 +21,7 @@
 import cz.cvut.kbss.ontodriver.exception.IntegrityConstraintViolatedException;
 import cz.cvut.kbss.ontodriver.model.Assertion;
 import cz.cvut.kbss.ontodriver.model.Axiom;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import cz.cvut.kbss.ontodriver.model.NamedResource;
 import cz.cvut.kbss.ontodriver.owlapi.AxiomAdapter;
 import cz.cvut.kbss.ontodriver.owlapi.change.MutableAddAxiom;
@@ -158,14 +158,14 @@ protected T extractNodeContent() {
                 return (T) OwlapiUtils.owlLiteralToValue(literal);
             }
         } else {
-            final MultilingualString mls = new MultilingualString();
+            final Translations translations = new Translations();
             nextItem.forEach(n -> {
                 assert n instanceof OWLLiteral;
                 final OWLLiteral lit = (OWLLiteral) n;
                 assert lit.getLang() != null;
-                mls.set(lit.getLang(), lit.getLiteral());
+                translations.set(lit.getLang(), lit.getLiteral());
             });
-            return (T) mls;
+            return (T) translations;
         }
     }
 

diff --git a/...owlapi/src/main/java/cz/cvut/kbss/ontodriver/owlapi/list/ReferencedListNodeGenerator.java b/...owlapi/src/main/java/cz/cvut/kbss/ontodriver/owlapi/list/ReferencedListNodeGenerator.java
@@ -22,7 +22,7 @@
 import cz.cvut.kbss.ontodriver.model.Assertion;
 import cz.cvut.kbss.ontodriver.model.AxiomImpl;
 import cz.cvut.kbss.ontodriver.model.LangString;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import cz.cvut.kbss.ontodriver.model.NamedResource;
 import cz.cvut.kbss.ontodriver.model.Value;
 import cz.cvut.kbss.ontodriver.owlapi.AxiomAdapter;
@@ -80,8 +80,8 @@ <V> Collection<TransactionalChange> generateNodeContent(NamedResource node, V va
             return List.of(new MutableAddAxiom(ontology, valueAxiom));
         } else {
             assert descriptor.getNodeContent().getType() == Assertion.AssertionType.DATA_PROPERTY;
-            if (value instanceof MultilingualString) {
-                final MultilingualString mls = (MultilingualString) value;
+            if (value instanceof Translations) {
+                final Translations mls = (Translations) value;
                 return mls.getValue().entrySet().stream().map(e -> {
                     final String lang = e.getKey();
                     final String val = e.getValue();

diff --git a/...r-owlapi/src/test/java/cz/cvut/kbss/ontodriver/owlapi/list/ReferencedListHandlerTest.java b/...r-owlapi/src/test/java/cz/cvut/kbss/ontodriver/owlapi/list/ReferencedListHandlerTest.java
@@ -24,7 +24,7 @@
 import cz.cvut.kbss.ontodriver.model.Assertion;
 import cz.cvut.kbss.ontodriver.model.Axiom;
 import cz.cvut.kbss.ontodriver.model.LangString;
-import cz.cvut.kbss.ontodriver.model.MultilingualString;
+import cz.cvut.kbss.ontodriver.model.Translations;
 import cz.cvut.kbss.ontodriver.model.NamedResource;
 import cz.cvut.kbss.ontodriver.owlapi.OwlapiAdapter;
 import cz.cvut.kbss.ontodriver.owlapi.connector.OntologySnapshot;
@@ -382,11 +382,11 @@ public void loadListLoadsListWithDataPropertyValues() {
 
     @Test
     void persistListSavesMultilingualStringTranslationsAsContentOfSingleNode() {
-        final List<MultilingualString> refList = List.of(
-                new MultilingualString(Map.of("en", "one", "cs", "jedna")),
-                new MultilingualString(Map.of("en", "two", "cs", "dva"))
+        final List<Translations> refList = List.of(
+                new Translations(Map.of("en", "one", "cs", "jedna")),
+                new Translations(Map.of("en", "two", "cs", "dva"))
         );
-        final ReferencedListValueDescriptor<MultilingualString> valueDescriptor = new ReferencedListValueDescriptor<>(ListTestHelper.SUBJECT, ListTestHelper.HAS_LIST, ListTestHelper.HAS_NEXT, Assertion.createDataPropertyAssertion(URI.create(ListTestHelper.HAS_CONTENT_PROPERTY), false));
+        final ReferencedListValueDescriptor<Translations> valueDescriptor = new ReferencedListValueDescriptor<>(ListTestHelper.SUBJECT, ListTestHelper.HAS_LIST, ListTestHelper.HAS_NEXT, Assertion.createDataPropertyAssertion(URI.create(ListTestHelper.HAS_CONTENT_PROPERTY), false));
         refList.forEach(valueDescriptor::addValue);
 
         sut.persistList(valueDescriptor);