Fuzzy matching for journal abbreviations

build.gradle

@@ -179,6 +179,7 @@ dependencies {
     implementation "org.apache.lucene:lucene-analysis-common:$luceneVersion"
     implementation "org.apache.lucene:lucene-highlighter:$luceneVersion"
 
+
     implementation group: 'org.apache.commons', name: 'commons-csv', version: '1.13.0'
     implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.17.0'
     implementation group: 'org.apache.commons', name: 'commons-text', version: '1.13.0'

src/main/java/org/jabref/logic/journals/Abbreviation.java

@@ -1,17 +1,21 @@
 package org.jabref.logic.journals;
 
+import java.io.Serial;
 import java.io.Serializable;
 import java.util.Objects;
 
+import org.apache.commons.text.similarity.LevenshteinDistance;
+
 public class Abbreviation implements Comparable<Abbreviation>, Serializable {
 
+    @Serial
     private static final long serialVersionUID = 1;
 
-    private transient String name;
-    private final String abbreviation;
-    private transient String dotlessAbbreviation;
+    private static final LevenshteinDistance LEVENSHTEIN = LevenshteinDistance.getDefaultInstance();
 
-    // Is the empty string if not available
+    private final transient String name;
+    private final String abbreviation;
+    private final transient String dotlessAbbreviation;
     private String shortestUniqueAbbreviation;
 
     public Abbreviation(String name, String abbreviation) {
@@ -21,12 +25,12 @@ public Abbreviation(String name, String abbreviation) {
     public Abbreviation(String name, String abbreviation, String shortestUniqueAbbreviation) {
         this(name,
                 abbreviation,
-                // "L. N." becomes "L  N ", we need to remove the double spaces inbetween
                 abbreviation.replace(".", " ").replace("  ", " ").trim(),
                 shortestUniqueAbbreviation.trim());
     }
 
-    private Abbreviation(String name, String abbreviation, String dotlessAbbreviation, String shortestUniqueAbbreviation) {
+    private Abbreviation(String name, String abbreviation, String dotlessAbbreviation,
+                         String shortestUniqueAbbreviation) {
         this.name = name.intern();
         this.abbreviation = abbreviation.intern();
         this.dotlessAbbreviation = dotlessAbbreviation.intern();
@@ -58,11 +62,19 @@ public String getDotlessAbbreviation() {
 
     @Override
     public int compareTo(Abbreviation toCompare) {
+        if (isSimilar(toCompare.getName())) {
+            return 0;
+        }
+
         int nameComparison = getName().compareTo(toCompare.getName());
         if (nameComparison != 0) {
             return nameComparison;
         }
 
+        if (isSimilar(toCompare.getAbbreviation())) {
+            return 0;
+        }
+
         int abbreviationComparison = getAbbreviation().compareTo(toCompare.getAbbreviation());
         if (abbreviationComparison != 0) {
             return abbreviationComparison;
@@ -75,8 +87,10 @@ public String getNext(String current) {
         String currentTrimmed = current.trim();
 
         if (getDotlessAbbreviation().equals(currentTrimmed)) {
-            return getShortestUniqueAbbreviation().equals(getAbbreviation()) ? getName() : getShortestUniqueAbbreviation();
-        } else if (getShortestUniqueAbbreviation().equals(currentTrimmed) && !getShortestUniqueAbbreviation().equals(getAbbreviation())) {
+            return getShortestUniqueAbbreviation().equals(getAbbreviation()) ?
+                    getName() : getShortestUniqueAbbreviation();
+        } else if (getShortestUniqueAbbreviation().equals(currentTrimmed) &&
+                !getShortestUniqueAbbreviation().equals(getAbbreviation())) {
             return getName();
         } else if (getName().equals(currentTrimmed)) {
             return getAbbreviation();
@@ -85,13 +99,16 @@ public String getNext(String current) {
         }
     }
 
-    @Override
-    public String toString() {
-        return "Abbreviation{name=%s, abbreviation=%s, dotlessAbbreviation=%s, shortestUniqueAbbreviation=%s}".formatted(
-                this.name,
-                this.abbreviation,
-                this.dotlessAbbreviation,
-                this.shortestUniqueAbbreviation);
+    public boolean isSimilar(String otherName) {
+        String normalizedThis = normalize(this.name);
+        String normalizedOther = normalize(otherName);
+
+        int distance = LEVENSHTEIN.apply(normalizedThis, normalizedOther);
+        return distance <= 2;
+    }
+
+    private static String normalize(String input) {
+        return input.toLowerCase().replaceAll("[^a-z0-9 ]", "").trim();
     }
 
     @Override
@@ -103,11 +120,22 @@ public boolean equals(Object o) {
             return false;
         }
         Abbreviation that = (Abbreviation) o;
-        return getName().equals(that.getName()) && getAbbreviation().equals(that.getAbbreviation()) && getShortestUniqueAbbreviation().equals(that.getShortestUniqueAbbreviation());
+        return Objects.equals(normalize(name), normalize(that.name)) &&
+                Objects.equals(normalize(abbreviation), normalize(that.abbreviation)) &&
+                Objects.equals(normalize(shortestUniqueAbbreviation), normalize(that.shortestUniqueAbbreviation));
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(getName(), getAbbreviation(), getShortestUniqueAbbreviation());
+        return Objects.hash(normalize(getName()), normalize(getAbbreviation()), normalize(getShortestUniqueAbbreviation()));
+    }
+
+    @Override
+    public String toString() {
+        return "Abbreviation{name=%s, abbreviation=%s, dotlessAbbreviation=%s, shortestUniqueAbbreviation=%s}".formatted(
+                this.name,
+                this.abbreviation,
+                this.dotlessAbbreviation,
+                this.shortestUniqueAbbreviation);
     }
 }

src/main/java/org/jabref/logic/journals/JournalAbbreviationRepository.java

@@ -152,7 +152,7 @@ public void addCustomAbbreviations(Collection<Abbreviation> abbreviationsToAdd)
     }
 
     public Optional<String> getNextAbbreviation(String text) {
-        return get(text).map(abbreviation -> abbreviation.getNext(text));
+        return get(text).map(abbreviation -> abbreviation.getNext(text.trim()));
     }
 
     public Optional<String> getDefaultAbbreviation(String text) {

src/test/java/org/jabref/logic/journals/AbbreviationTest.java

@@ -4,6 +4,7 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 class AbbreviationTest {
 
@@ -111,10 +112,46 @@ void equals() {
         assertNotEquals("String", abbreviation);
     }
 
+    @Test
+    void testSlightDifferences() {
+        assertTrue(new Abbreviation("Long Name", "L. N.").isSimilar("Longn Name"));
+    }
+
+    @Test
+    void testMissingLetter() {
+        assertTrue(new Abbreviation("Long Name", "L. N.").isSimilar("Long ame"));
+    }
+
+    @Test
+    void testPunctuationDifferences() {
+        assertTrue(new Abbreviation("Long Name", "L. N.").isSimilar("Long, Name"));
+    }
+
+    @Test
+    void testCaseDifferences() {
+        assertTrue(new Abbreviation("Long Name", "L. N.").isSimilar("LONG NAME"));
+    }
+
     @Test
     void equalAbbrevationsWithFourComponentsAreAlsoCompareZero() {
         Abbreviation abbreviation1 = new Abbreviation("Long Name", "L. N.", "LN");
         Abbreviation abbreviation2 = new Abbreviation("Long Name", "L. N.", "LN");
         assertEquals(0, abbreviation1.compareTo(abbreviation2));
     }
+
+    @Test
+    void testCompareToWithFuzzyMatching() {
+        Abbreviation abbreviation1 = new Abbreviation("Long Name", "L. N.");
+        Abbreviation abbreviation2 = new Abbreviation("Long Name", "L. N.");
+        assertEquals(0, abbreviation1.compareTo(abbreviation2));
+
+        abbreviation2 = new Abbreviation("Long Name", "L. N. ");
+        assertEquals(0, abbreviation1.compareTo(abbreviation2));
+
+        abbreviation2 = new Abbreviation("Long Name", "L. N");
+        assertEquals(0, abbreviation1.compareTo(abbreviation2));
+
+        abbreviation2 = new Abbreviation("Short Name", "S. N.");
+        assertNotEquals(0, abbreviation1.compareTo(abbreviation2));
+    }
 }