Fix issue #11189 part 00 refactor citation relation tab logic #11845
+1,605
−235
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,8 +37,6 @@ | |
| import org.jabref.gui.collab.entrychange.PreviewWithSourceTab; | ||
| import org.jabref.gui.desktop.os.NativeDesktop; | ||
| import org.jabref.gui.entryeditor.EntryEditorTab; | ||
| import org.jabref.gui.icon.IconTheme; | ||
| import org.jabref.gui.mergeentries.EntriesMergeResult; | ||
| import org.jabref.gui.mergeentries.MergeEntriesDialog; | ||
|
|
@@ -51,8 +49,10 @@ | |
| import org.jabref.logic.bibtex.BibEntryWriter; | ||
| import org.jabref.logic.bibtex.FieldPreferences; | ||
| import org.jabref.logic.bibtex.FieldWriter; | ||
| import org.jabref.logic.citation.SearchCitationsRelationsService; | ||
| import org.jabref.logic.database.DuplicateCheck; | ||
| import org.jabref.logic.exporter.BibWriter; | ||
| import org.jabref.logic.importer.fetcher.CitationFetcher; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.logic.os.OS; | ||
| import org.jabref.logic.util.BackgroundTask; | ||
|
|
@@ -92,7 +92,7 @@ public class CitationRelationsTab extends EntryEditorTab { | |
| private final GuiPreferences preferences; | ||
| private final LibraryTab libraryTab; | ||
| private final TaskExecutor taskExecutor; | ||
| private final SearchCitationsRelationsService searchCitationsRelationsService; | ||
| private final CitationsRelationsTabViewModel citationsRelationsTabViewModel; | ||
| private final DuplicateCheck duplicateCheck; | ||
| private final BibEntryTypesManager entryTypesManager; | ||
|
|
@@ -107,7 +107,8 @@ public CitationRelationsTab(DialogService dialogService, | |
| GuiPreferences preferences, | ||
| LibraryTab libraryTab, | ||
| TaskExecutor taskExecutor, | ||
| BibEntryTypesManager bibEntryTypesManager, | ||
| SearchCitationsRelationsService searchCitationsRelationsService) { | ||
| this.dialogService = dialogService; | ||
| this.databaseContext = databaseContext; | ||
| this.preferences = preferences; | ||
|
|
@@ -121,9 +122,17 @@ public CitationRelationsTab(DialogService dialogService, | |
|
|
||
| this.entryTypesManager = bibEntryTypesManager; | ||
| this.duplicateCheck = new DuplicateCheck(entryTypesManager); | ||
| this.searchCitationsRelationsService = searchCitationsRelationsService; | ||
|
|
||
| citationsRelationsTabViewModel = new CitationsRelationsTabViewModel( | ||
| databaseContext, | ||
| preferences, | ||
| undoManager, | ||
| stateManager, | ||
| dialogService, | ||
| fileUpdateMonitor, | ||
| taskExecutor | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -199,22 +208,22 @@ private SplitPane getPaneAndStartSearch(BibEntry entry) { | |
|
|
||
| refreshCitingButton.setOnMouseClicked(event -> { | ||
| searchForRelations(entry, citingListView, abortCitingButton, | ||
| refreshCitingButton, CitationFetcher.SearchType.CITES, importCitingButton, citingProgress); | ||
| }); | ||
|
|
||
| refreshCitedByButton.setOnMouseClicked(event -> searchForRelations(entry, citedByListView, abortCitedButton, | ||
| refreshCitedByButton, CitationFetcher.SearchType.CITED_BY, importCitedByButton, citedByProgress)); | ||
|
|
||
| // Create SplitPane to hold all nodes above | ||
| SplitPane container = new SplitPane(citingVBox, citedByVBox); | ||
| styleFetchedListView(citedByListView); | ||
| styleFetchedListView(citingListView); | ||
|
|
||
| searchForRelations(entry, citingListView, abortCitingButton, refreshCitingButton, | ||
| CitationFetcher.SearchType.CITES, importCitingButton, citingProgress); | ||
|
|
||
| searchForRelations(entry, citedByListView, abortCitedButton, refreshCitedByButton, | ||
| CitationFetcher.SearchType.CITED_BY, importCitedByButton, citedByProgress); | ||
|
|
||
| return container; | ||
| } | ||
|
|
@@ -410,7 +419,7 @@ protected void bindToEntry(BibEntry entry) { | |
| */ | ||
| private void searchForRelations(BibEntry entry, CheckListView<CitationRelationItem> listView, Button abortButton, | ||
| Button refreshButton, CitationFetcher.SearchType searchType, Button importButton, | ||
| ProgressIndicator progress) { | ||
| if (entry.getDOI().isEmpty()) { | ||
| hideNodes(abortButton, progress); | ||
| showNodes(refreshButton); | ||
|
|
@@ -424,47 +433,59 @@ private void searchForRelations(BibEntry entry, CheckListView<CitationRelationIt | |
|
|
||
| listView.setItems(observableList); | ||
|
|
||
| // TODO: It should not be possible to cancel a search task that is already running for same tab | ||
| if (citingTask != null && !citingTask.isCancelled()) { | ||
| citingTask.cancel(); | ||
| } | ||
|
|
||
| this.createBackGroundTask(entry, searchType) | ||
| .consumeOnRunning(task -> prepareToSearchForRelations( | ||
|
There was a problem hiding this comment. Could probably be renamed |
||
| abortButton, refreshButton, importButton, progress, task | ||
| )) | ||
| .onSuccess(fetchedList -> onSearchForRelationsSucceed( | ||
| entry, | ||
| listView, | ||
| abortButton, | ||
| refreshButton, | ||
| searchType, | ||
| importButton, | ||
| progress, | ||
| fetchedList, | ||
| observableList | ||
| )) | ||
| .onFailure(exception -> { | ||
| LOGGER.error("Error while fetching citing Articles", exception); | ||
|
There was a problem hiding this comment.
just a typo 😃 There was a problem hiding this comment. @InAnYan This was here before I touched this code. I am leaving this for now in this PR as this out of the scope. |
||
| hideNodes(abortButton, progress, importButton); | ||
| listView.setPlaceholder(new Label(Localization.lang("Error while fetching citing entries: %0", | ||
|
There was a problem hiding this comment. @InAnYan This was here before I touched this code. I am leaving this for now in this PR as this out of the scope. |
||
| exception.getMessage()))); | ||
| refreshButton.setVisible(true); | ||
| dialogService.notify(exception.getMessage()); | ||
| }) | ||
| .executeWith(taskExecutor); | ||
| } | ||
|
|
||
| /** | ||
| * TODO: Make the method return a callable and let the calling method create the background task. | ||
| */ | ||
| private BackgroundTask<List<BibEntry>> createBackGroundTask( | ||
| BibEntry entry, CitationFetcher.SearchType searchType | ||
| ) { | ||
| return switch (searchType) { | ||
| case CitationFetcher.SearchType.CITES -> { | ||
| citingTask = BackgroundTask.wrap( | ||
|
There was a problem hiding this comment. I do not really appreciate this solution. The method should return a There was a problem hiding this comment. OK for me. You can add a TODO comment if you want. There was a problem hiding this comment. TODO added. Will see how to enhance the task management after this PR merge. |
||
| () -> this.searchCitationsRelationsService.searchReferences(entry) | ||
| ); | ||
| yield citingTask; | ||
| } | ||
| case CitationFetcher.SearchType.CITED_BY -> { | ||
| citedByTask = BackgroundTask.wrap( | ||
| () -> this.searchCitationsRelationsService.searchCitations(entry) | ||
| ); | ||
| yield citedByTask; | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| private void onSearchForRelationsSucceed(BibEntry entry, CheckListView<CitationRelationItem> listView, | ||
| Button abortButton, Button refreshButton, | ||
| CitationFetcher.SearchType searchType, Button importButton, | ||
|
|
@@ -481,7 +502,7 @@ private void onSearchForRelationsSucceed(BibEntry entry, CheckListView<CitationR | |
| .map(localEntry -> new CitationRelationItem(entr, localEntry, true)) | ||
| .orElseGet(() -> new CitationRelationItem(entr, false))) | ||
| .toList() | ||
| ); | ||
|
|
||
| if (!observableList.isEmpty()) { | ||
| listView.refresh(); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Introduces a service layer that segregates the fetching and repository logic definitions.