Add a new field for citation count #13531

SalvadorRomo · 2025-07-12T18:06:52Z

This PR add a new filed in the General Count to fetch the citationCount for a given Entry, with the ability to look it up.

Steps to test

1- Add a new paper
2- Go to the General Tab and
3 - Place your cursor in the new Citation Field
4- next to the field, there is button available to start the search
5- if the value is blank or the TTL for the actual Doi has expiered, the field must be filled with the expected value
6- if the there is an existing value or the TTL is not yet reached, it won't perform fetching and will keep the same value

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (if change is visible to the user)
[/] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

jabgui/src/main/java/org/jabref/gui/fieldeditors/identifier/CitationCountEditorViewModel.java

jablib/src/main/java/org/jabref/logic/importer/fetcher/citation/CitationFetcher.java

jablib/src/main/java/org/jabref/model/entry/field/FieldFactory.java

jabgui/src/main/java/org/jabref/gui/fieldeditors/FieldEditors.java

jabgui/src/main/java/org/jabref/gui/entryeditor/SciteTab.java

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditor.java

jablib/src/main/java/org/jabref/logic/citation/SearchCitationsRelationsService.java

CHANGELOG.md

jablib/build.gradle.kts

jablib/src/main/java/org/jabref/logic/citation/SearchCitationsRelationsService.java

...g/jabref/logic/importer/fetcher/citation/semanticscholar/SemanticScholarCitationFetcher.java

jablib/src/main/java/org/jabref/model/entry/field/FieldProperty.java

jablib/src/main/java/org/jabref/model/entry/field/StandardField.java

koppor · 2025-07-13T20:21:39Z

...test/resources/org/jabref/logic/exporter/OldOpenOfficeCalcExportFormatContentSingleEntry.xml

+                <table:table-cell>
+                    <text:p>Citation count</text:p>
+                </table:table-cell>


Not sure why this file is updated.

Do you realy handle OpenOffice? This was not part of the issue!!

Maybe, just revert all changes in this file

mmm i had to fix this because by adding the new field, now this test expected it. Not sure if it was because i added to FieldProperty and by remove we should be fine but if it persist the error we need to consider this change

Hey, tried to revert this change but the test that read this file again failed. Not sure if its because it reads all the Fields. I also even delete the entry in FieldProperty and no luck.

@subhramit Can you have a look; maybe, you know better than me 😅

will take a look soon

I wasn't able to look through the code yet, but @SalvadorRomo try to search where this filename is being used in the code. That will lead you to the logic that expects this field. If de-coupling is possible, then do it, otherwise this seems alright.

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditor.java

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditorViewModel.java

jablib/src/test/java/org/jabref/logic/citation/SearchCitationsRelationsServiceTest.java

...g/jabref/logic/importer/fetcher/citation/semanticscholar/SemanticScholarCitationFetcher.java

trag-bot · 2025-07-15T19:12:08Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditor.java

@@ -0,0 +1,84 @@
+package org.jabref.gui.fieldeditors;
+
+import javax.swing.undo.UndoManager;


Using Swing components in a JavaFX application violates the architectural decision to use only JavaFX. The UndoManager should be replaced with a JavaFX-specific implementation.

JabRef uses this - which is OK.

CHANGELOG.md

jablib/src/main/java/org/jabref/logic/citation/SearchCitationsRelationsService.java

...g/jabref/logic/importer/fetcher/citation/semanticscholar/SemanticScholarCitationFetcher.java

jablib/src/main/java/org/jabref/model/entry/field/FieldProperty.java

koppor · 2025-07-15T21:06:20Z

jablib/src/main/java/org/jabref/model/entry/field/StandardField.java

@@ -138,6 +138,7 @@ public enum StandardField implements Field {
    OWNER("owner"),
    TIMESTAMP("timestamp", FieldProperty.DATE),
    CREATIONDATE("creationdate", FieldProperty.DATE),
+    CITATIONCOUNT("Citation count"),


Move at the end - the two fields before and the one after is related to date - this one not.

Made this change, but seems to impact the open office tests, seems the order of this contstants impact how the output will be in files, so don't konw what you think about it

Please show the excerpt here.

I think, you ened to adapt jablib/src/test/resources/org/jabref/logic/exporter/OldOpenOfficeCalcExportFormatContentSingleEntry.xml accordingly. Which is OK - you add a thing there (and we have the discussion on that there. Maybe, this is really required)

(And please let us resolve the conversations so that we save one click while reviewing) - otherwise, I need to open all resolved conversations)

jablib/src/test/java/org/jabref/logic/citation/SearchCitationsRelationsServiceTest.java

jablib/src/main/java/org/jabref/logic/citation/SearchCitationsRelationsService.java

trag-bot · 2025-07-16T02:20:33Z

...g/jabref/logic/importer/fetcher/citation/semanticscholar/SemanticScholarCitationFetcher.java

+        }
+        URL referencesUrl;
+        try {
+            referencesUrl = URLUtil.create(getUrlForCitationCount(entry));


Variable name 'referencesUrl' is misleading as it's used for citation count URL, not references. This reduces code readability and maintainability.

...g/jabref/logic/importer/fetcher/citation/semanticscholar/SemanticScholarCitationFetcher.java

trag-bot · 2025-07-16T03:45:09Z

@trag-bot didn't find any issues in the code! ✅✨

koppor

Close to finish 😅

We keep commenting to share our development knowledge with you with the hope that you learn something - otherwise, we would "just" finish the PR for our selves.

koppor · 2025-07-16T09:43:13Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditorViewModel.java

+                      .onRunning(() -> fetchCitationCountInProgress.setValue(true))
+                      .onFinished(() -> fetchCitationCountInProgress.setValue(false))
+                      .onFailure(e ->
+                          dialogService.showErrorDialogAndWait(Localization.lang("Error Occurred")))


This is not JabRef's style. The text does not contain any information what the user should do.

Rename string to Error occurred (also in JabRef_en.properties`)

dialogService.notify(...)

LOGGER.error("Error while fetching citation count", e)

With 3, there is a log entry, and users can see it in the log viewer accessible in the help menu.

koppor · 2025-07-16T09:43:41Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditorViewModel.java

+    }
+
+    public void getCitationCount() {
+        Optional<String> fieldAux = entry.getField(field);


aux is very strange. Maybe name it fieldContent

koppor · 2025-07-16T09:44:20Z

jabgui/src/main/resources/org/jabref/gui/fieldeditors/CitationCountEditor.fxml

+        <graphic>
+            <StackPane>
+                <JabRefIconView glyph="LOOKUP_IDENTIFIER"
+                                visible="${controller.viewModel.fetchCitationCountInProgress == false}"/>


Use !... instead of == false

koppor · 2025-07-16T09:45:22Z

jablib/src/main/java/org/jabref/logic/importer/fetcher/citation/CitationFetcher.java

+     * Get the paper details that includes citation count field for a given {@link BibEntry}.
+     *
+     * @param entry entry to search citation count field
+     * @return returns a {@link PaperDetails}, that includes citation count field (may be empty)


Ajdust JavaDoc to actual return value (Integer is not PaperDetails)

koppor · 2025-07-16T09:47:21Z

jablib/src/main/java/org/jabref/model/entry/field/StandardField.java

@@ -138,6 +138,7 @@ public enum StandardField implements Field {
    OWNER("owner"),
    TIMESTAMP("timestamp", FieldProperty.DATE),
    CREATIONDATE("creationdate", FieldProperty.DATE),
+    CITATIONCOUNT("Citation count"),


Please show the excerpt here.

I think, you ened to adapt jablib/src/test/resources/org/jabref/logic/exporter/OldOpenOfficeCalcExportFormatContentSingleEntry.xml accordingly. Which is OK - you add a thing there (and we have the discussion on that there. Maybe, this is really required)

(And please let us resolve the conversations so that we save one click while reviewing) - otherwise, I need to open all resolved conversations)

SalvadorRomo and others added 11 commits July 7, 2025 20:35

first changes

dcc6076

partial change

1a76c57

add fields to GUI

aaef2ce

finish change

150bc2c

fix citation count identifier

fe6b48d

adding tests

23fbd53

Merge branch 'JabRef:main' into fix-for-issue-13477

b37475d

add more testing

f4fa327

merge files

1193823

remove unwanted logic

44de54c

add entry to change log

05aa416

trag-bot bot reviewed Jul 12, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/fieldeditors/identifier/CitationCountEditorViewModel.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Jul 12, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/fieldeditors/identifier/CitationCountEditorViewModel.java Outdated Show resolved Hide resolved

SalvadorRomo changed the title ~~Fix for issue 13477~~ PR to add a new field for citation count Jul 12, 2025

SalvadorRomo added 9 commits July 12, 2025 12:31

resolve comments

15baed1

resolve comments

19923b8

resolve conflicts

db2ffd2

enhance citation count change log

cd836e7

enhance citation count change log

a90024c

change assertion style

9c3facb

resolve conflicts

84af44f

resolve conflicts

1d265d3

resolve conflicts

8bfc988

trag-bot bot reviewed Jul 12, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/importer/fetcher/citation/CitationFetcher.java Show resolved Hide resolved

trag-bot bot reviewed Jul 12, 2025

View reviewed changes

jablib/src/main/java/org/jabref/model/entry/field/FieldFactory.java Show resolved Hide resolved

koppor requested changes Jul 12, 2025

View reviewed changes

SalvadorRomo added 3 commits July 12, 2025 17:37

resolve test errors

83709c9

resolve conflicts

4333732

fix branch

18f9de0

trag-bot bot reviewed Jul 13, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditor.java Outdated Show resolved Hide resolved

calixtus changed the title ~~PR to add a new field for citation count~~ Add a new field for citation count Jul 13, 2025

SalvadorRomo added 2 commits July 13, 2025 05:59

merge incoming changes

e4fdd97

resolve comment

e1928d8

trag-bot bot reviewed Jul 13, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/citation/SearchCitationsRelationsService.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Jul 13, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/citation/SearchCitationsRelationsService.java Show resolved Hide resolved

koppor requested changes Jul 13, 2025

View reviewed changes

SalvadorRomo and others added 10 commits July 14, 2025 08:35

Update CHANGELOG.md

18e51bd

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

resolve comments

d12e8e4

merge master

1f7f5cf

fix comments

ba09528

fix comments

25e3649

fix comments

4e0c1af

fix issues

1accb7c

Merge branch 'main' into fix-for-issue-13477

85190f9

Merge branch 'main' into fix-for-issue-13477

371f9f6

Merge branch 'main' into fix-for-issue-13477

3074fde

koppor requested changes Jul 15, 2025

View reviewed changes

SalvadorRomo added 2 commits July 15, 2025 13:00

fix comments

41deb2b

remove unused import

fa1297f

trag-bot bot reviewed Jul 15, 2025

View reviewed changes

koppor reviewed Jul 15, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

koppor requested changes Jul 15, 2025

View reviewed changes

fix comments

4f1250d

trag-bot bot reviewed Jul 16, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/citation/SearchCitationsRelationsService.java Show resolved Hide resolved

trag-bot bot reviewed Jul 16, 2025

View reviewed changes

...g/jabref/logic/importer/fetcher/citation/semanticscholar/SemanticScholarCitationFetcher.java Show resolved Hide resolved

SalvadorRomo and others added 2 commits July 15, 2025 21:12

fix test cases

49d6d47

Merge branch 'main' into fix-for-issue-13477

827b4a7

koppor requested changes Jul 16, 2025

View reviewed changes

		@@ -0,0 +1,84 @@
		package org.jabref.gui.fieldeditors;

		import javax.swing.undo.UndoManager;

Uh oh!

Add a new field for citation count #13531

Are you sure you want to change the base?

Add a new field for citation count #13531

Uh oh!

Conversation

SalvadorRomo commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Mandatory checks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SalvadorRomo Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trag-bot bot Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trag-bot bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trag-bot bot commented Jul 16, 2025

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SalvadorRomo commented Jul 12, 2025 •

edited

Loading

SalvadorRomo Jul 14, 2025 •

edited

Loading