Improve merge logic to prefer valid year and entry type (#13506)

ArshKumar84 · koppor · web-flow · commit f52fcb400c4a · 2025-07-09T14:51:24.000Z
* feat: improve merge dialog to prefer better entry type and year (fixes #12549) - Added YearFieldValueValidityComparator to prefer DOI year when local year is unrealistic or differs by more than 10 years - Enhanced entry type comparison logic to select DOI entry type if local is "misc" - Applied auto-selection in Merge Entries dialog when merging using DOI fetcher * Update CHANGELOG.md Enhanced field selection logic in the Merge Entries dialog when fetching from DOI to prefer valid years and entry types * Update CHANGELOG.md * feat: improve merge dialog to prefer better entry type and year (fixes #12549) - applied enum for comparison result to improve the readability - Refactored FieldValueValidityComparator to abstract FieldValuePlausibilityComparator - Enabled plausibility comparison across all fetcher types * feat: Improved readability and removed unnecessary method call - Removed unnecessary method call from ComparisonResult in YearFieldValuePlausibilityComparator - Removed unnecessary code in enum ComparisonResult - Added comment for extractYear() in YearFieldValuePlausibilityComparator * Apply suggestion from @koppor Co-authored-by: Oliver Kopp <kopp.dev@gmail.com> * Apply suggestion from @koppor Co-authored-by: Oliver Kopp <kopp.dev@gmail.com> --------- Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -74,6 +74,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We fixed an issue where Document Viewer showed technical exceptions when opening entries with non-PDF files. [#13198](https://github.com/JabRef/jabref/issues/13198)
 - When creating a library, if you drag a PDF file containing only a single column, the dialog will now automatically close. [#13262](https://github.com/JabRef/jabref/issues/13262)
 - We fixed an issue where the tab showing the fulltext search results would appear blank after switching library. [#13241](https://github.com/JabRef/jabref/issues/13241)
+- Enhanced field selection logic in the Merge Entries dialog when fetching from DOI to prefer valid years and entry types. [#12549](https://github.com/JabRef/jabref/issues/12549)
 
 ### Removed
 
diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/FetchAndMergeEntry.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/FetchAndMergeEntry.java
@@ -107,6 +107,7 @@ private void showMergeDialog(BibEntry originalEntry, BibEntry fetchedEntry, WebF
         dialog.setTitle(Localization.lang("Merge entry with %0 information", fetcher.getName()));
         dialog.setLeftHeaderText(Localization.lang("Original entry"));
         dialog.setRightHeaderText(Localization.lang("Entry from %0", fetcher.getName()));
+        dialog.autoSelectBetterFields();
         Optional<BibEntry> mergedEntry = dialogService.showCustomDialogAndWait(dialog).map(EntriesMergeResult::mergedEntry);
 
         if (mergedEntry.isPresent()) {
diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/MergeEntriesDialog.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/MergeEntriesDialog.java
@@ -64,4 +64,8 @@ public void setRightHeaderText(String rightHeaderText) {
     public void configureDiff(ShowDiffConfig diffConfig) {
         threeWayMergeView.showDiff(diffConfig);
     }
+
+    public void autoSelectBetterFields() {
+        threeWayMergeView.autoSelectBetterFields();
+    }
 }
diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/newmergedialog/FieldRowView.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/newmergedialog/FieldRowView.java
@@ -208,6 +208,10 @@ public boolean hasEqualLeftAndRightValues() {
         return viewModel.hasEqualLeftAndRightValues();
     }
 
+    public void autoSelectBetterValue() {
+        viewModel.autoSelectBetterValue();
+    }
+
     @Override
     public String toString() {
         return "FieldRowView [shouldShowDiffs=" + shouldShowDiffs.get() + ", fieldNameCell=" + fieldNameCell + ", leftValueCell=" + leftValueCell + ", rightValueCell=" + rightValueCell + ", mergedValueCell=" + mergedValueCell + "]";
diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/newmergedialog/FieldRowViewModel.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/newmergedialog/FieldRowViewModel.java
@@ -16,10 +16,14 @@
 
 import org.jabref.gui.mergeentries.newmergedialog.fieldsmerger.FieldMerger;
 import org.jabref.gui.mergeentries.newmergedialog.fieldsmerger.FieldMergerFactory;
+import org.jabref.logic.bibtex.comparator.ComparisonResult;
+import org.jabref.logic.bibtex.comparator.YearFieldValuePlausibilityComparator;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.field.Field;
 import org.jabref.model.entry.field.InternalField;
+import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.entry.types.EntryTypeFactory;
+import org.jabref.model.entry.types.StandardEntryType;
 import org.jabref.model.strings.StringUtil;
 
 import com.tobiasdiez.easybind.EasyBind;
@@ -120,6 +124,25 @@ public FieldRowViewModel(Field field, BibEntry leftEntry, BibEntry rightEntry, B
         EasyBind.subscribe(hasEqualLeftAndRightBinding(), this::setIsFieldsMerged);
     }
 
+    public void autoSelectBetterValue() {
+        String leftValue = getLeftFieldValue();
+        String rightValue = getRightFieldValue();
+
+        if (StandardField.YEAR == field) {
+                YearFieldValuePlausibilityComparator comparator = new YearFieldValuePlausibilityComparator();
+                ComparisonResult comparison = comparator.compare(leftValue, rightValue);
+                if (ComparisonResult.RIGHT_BETTER == comparison) {
+                    selectRightValue();
+                } else if (ComparisonResult.LEFT_BETTER == comparison) {
+                    selectLeftValue();
+                }
+        } else if (InternalField.TYPE_HEADER == field) {
+            if (leftValue.equalsIgnoreCase(StandardEntryType.Misc.getName())) {
+                selectRightValue();
+            }
+        }
+    }
+
     public void selectNonEmptyValue() {
         if (StringUtil.isNullOrEmpty(leftFieldValue.get())) {
             selectRightValue();
diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/newmergedialog/ThreeWayMergeView.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/newmergedialog/ThreeWayMergeView.java
@@ -200,4 +200,10 @@ public BibEntry getRightEntry() {
     public void saveConfiguration() {
         toolbar.saveToolbarConfiguration();
     }
+
+    public void autoSelectBetterFields() {
+        for (FieldRowView row : fieldRows) {
+            row.autoSelectBetterValue();
+        }
+    }
 }
diff --git a/jabgui/src/test/java/org/jabref/gui/mergeentries/FieldRowViewModelTest.java b/jabgui/src/test/java/org/jabref/gui/mergeentries/FieldRowViewModelTest.java
@@ -214,6 +214,24 @@ void unmergeFieldsShouldDoNothingIfFieldsAreNotMerged() {
         assertEquals(oldRightGroups, groupsField.getRightFieldValue());
     }
 
+    @Test
+    void newYearShouldBeSelectedForYearsWithLargeValueGap() {
+        BibEntry leftEntry = new BibEntry().withField(StandardField.YEAR, "1990");
+        BibEntry rightEntry = new BibEntry().withField(StandardField.YEAR, "2020");
+        FieldRowViewModel yearField = new FieldRowViewModel(StandardField.YEAR, leftEntry, rightEntry, mergedEntry, fieldMergerFactory);
+        yearField.autoSelectBetterValue();
+        assertEquals(FieldRowViewModel.Selection.RIGHT, yearField.getSelection());
+    }
+
+    @Test
+    void yearInRangeShouldBeSelected() {
+        BibEntry leftEntry = new BibEntry().withField(StandardField.YEAR, "1700");
+        BibEntry rightEntry = new BibEntry().withField(StandardField.YEAR, "2000");
+        FieldRowViewModel yearField = new FieldRowViewModel(StandardField.YEAR, leftEntry, rightEntry, mergedEntry, fieldMergerFactory);
+        yearField.autoSelectBetterValue();
+        assertEquals(FieldRowViewModel.Selection.RIGHT, yearField.getSelection());
+    }
+
     public FieldRowViewModel createViewModelForField(Field field) {
         return new FieldRowViewModel(field, leftEntry, rightEntry, mergedEntry, fieldMergerFactory);
     }
diff --git a/jablib/src/main/java/module-info.java b/jablib/src/main/java/module-info.java
@@ -249,5 +249,6 @@
     requires mslinks;
     requires org.antlr.antlr4.runtime;
     requires org.libreoffice.uno;
+    requires org.jetbrains.annotations;
     // endregion
 }
diff --git a/jablib/src/main/java/org/jabref/logic/bibtex/comparator/ComparisonResult.java b/jablib/src/main/java/org/jabref/logic/bibtex/comparator/ComparisonResult.java
@@ -0,0 +1,7 @@
+package org.jabref.logic.bibtex.comparator;
+
+public enum ComparisonResult {
+    LEFT_BETTER,
+    RIGHT_BETTER,
+    UNDETERMINED
+}
diff --git a/jablib/src/main/java/org/jabref/logic/bibtex/comparator/FieldValuePlausibilityComparator.java b/jablib/src/main/java/org/jabref/logic/bibtex/comparator/FieldValuePlausibilityComparator.java
@@ -0,0 +1,12 @@
+package org.jabref.logic.bibtex.comparator;
+
+public abstract class FieldValuePlausibilityComparator {
+    /**
+     * Compares the plausibility of two field values.
+     *
+     * @param leftValue  value from the library (or candidate)
+     * @param rightValue value from the fetcher (or existing record)
+     * @return ComparisonResult indicating which field is more plausible: RIGHT_BETTER, LEFT_BETTER, or UNDETERMINED
+     */
+    public abstract ComparisonResult compare(String leftValue, String rightValue);
+}
diff --git a/jablib/src/main/java/org/jabref/logic/bibtex/comparator/YearFieldValuePlausibilityComparator.java b/jablib/src/main/java/org/jabref/logic/bibtex/comparator/YearFieldValuePlausibilityComparator.java
@@ -0,0 +1,62 @@
+package org.jabref.logic.bibtex.comparator;
+
+import java.time.Year;
+import java.util.Optional;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.jabref.logic.integrity.YearChecker;
+
+public class YearFieldValuePlausibilityComparator extends FieldValuePlausibilityComparator {
+
+    private static final Pattern YEAR_PATTERN = Pattern.compile("(\\d{4})");
+
+    /**
+     * Compares the plausibility of two field values.
+     *
+     * @param leftValue  value from the library (or candidate)
+     * @param rightValue value from the fetcher (or existing record)
+     * @return ComparisonResult indicating which year is more plausible: RIGHT_BETTER, LEFT_BETTER, or UNDETERMINED
+     */
+
+    @Override
+    public ComparisonResult compare(String leftValue, String rightValue) {
+        YearChecker checker = new YearChecker();
+
+        boolean leftValid = checker.checkValue(leftValue).isEmpty();
+
+        if (leftValid) {
+            Optional<Integer> leftYear = extractYear(leftValue);
+            Optional<Integer> rightYear = extractYear(rightValue);
+
+            boolean leftYearInRange = (leftYear.get() >= 1800) && (leftYear.get() <= Year.now().getValue() + 2);
+
+            if (leftYearInRange) {
+                int diff = Math.abs(leftYear.get() - rightYear.get());
+                if (diff > 10) {
+                    return rightYear.get() > leftYear.get()
+                            ? ComparisonResult.RIGHT_BETTER
+                            : ComparisonResult.LEFT_BETTER;
+                }
+                return ComparisonResult.UNDETERMINED; // years are close, undetermined
+            }
+            return ComparisonResult.RIGHT_BETTER;
+            }
+        return ComparisonResult.RIGHT_BETTER;
+    }
+
+    /**
+     * Extracts the first 4-digit number found in the string.
+     * Used to identify year-like values such as "About 2000" or "Published in 1999".
+     *
+     * @param value the input string possibly containing a year
+     * @return Optional containing the 4-digit year if found, otherwise Optional.empty()
+     */
+    private Optional<Integer> extractYear(String value) {
+        Matcher matcher = YEAR_PATTERN.matcher(value);
+        if (matcher.find()) {
+            return Optional.of(Integer.parseInt(matcher.group(1)));
+        }
+        return Optional.empty();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -64,4 +64,8 @@ public void setRightHeaderText(String rightHeaderText) {`
`64`	`64`	`public void configureDiff(ShowDiffConfig diffConfig) {`
`65`	`65`	`threeWayMergeView.showDiff(diffConfig);`
`66`	`66`	`}`
	`67`	`+`
	`68`	`+ public void autoSelectBetterFields() {`
	`69`	`+ threeWayMergeView.autoSelectBetterFields();`
	`70`	`+ }`
`67`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -200,4 +200,10 @@ public BibEntry getRightEntry() {`
`200`	`200`	`public void saveConfiguration() {`
`201`	`201`	`toolbar.saveToolbarConfiguration();`
`202`	`202`	`}`
	`203`	`+`
	`204`	`+ public void autoSelectBetterFields() {`
	`205`	`+ for (FieldRowView row : fieldRows) {`
	`206`	`+ row.autoSelectBetterValue();`
	`207`	`+ }`
	`208`	`+ }`
`203`	`209`	`}`
Original file line number	Diff line number	Diff line change
`@@ -249,5 +249,6 @@`
`249`	`249`	`requires mslinks;`
`250`	`250`	`requires org.antlr.antlr4.runtime;`
`251`	`251`	`requires org.libreoffice.uno;`
	`252`	`+ requires org.jetbrains.annotations;`
`252`	`253`	`// endregion`
`253`	`254`	`}`