Modifier and Type	Class and Description
private static interface	CitationRelationsTab.CitationFetch One of the two citation searches of `SearchCitationsRelationsService`, parameterized over the cancellation check so that `createSearchTask` can supply the one belonging to the task it is currently building.
private static record	CitationRelationsTab.LibrarySnapshot Immutable snapshot of the active library, taken on the JavaFX Application Thread and consumed by the background duplicate matching in `matchAgainstLibrary`.

Modifier and Type	Field and Description
private final CitationsRelationsTabViewModel	citationsRelationsTabViewModel
private @Nullable CitationComponents	currentCitedByComponents
private @Nullable CitationComponents	currentCitingComponents
private final DialogService	dialogService
private final DuplicateCheck	duplicateCheck
private final EntryEditorPreferences	entryEditorPreferences
private final BibEntryTypesManager	entryTypesManager
private ComboBox<CitationFetcherType>	fetcherCombo
private static final Logger	LOGGER Hides org.jabref.gui.entryeditor.EntryEditorTab.LOGGER.
private final GuiPreferences	preferences
private final MainTableTooltip	previewTooltip
private final ProgressIndicator	progressIndicator
private final GridPane	sciteResultsPane
private final SearchCitationsRelationsService	searchCitationsRelationsService
private boolean	shouldClearSelectionOnDrop
private final StateManager	stateManager
private final TaskExecutor	taskExecutor

Access	Constructor and Description
public	CitationRelationsTab(DialogService dialogService, StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, GuiPreferences preferences, TaskExecutor taskExecutor, BibEntryTypesManager bibEntryTypesManager, SearchCitationsRelationsService searchCitationsRelationsService)

Method Summary

Modifier and Type	Method and Description
protected void	bindToEntry(BibEntry entry) Implements abstract org.jabref.gui.entryeditor.EntryEditorTab.bindToEntry.
private ContextMenu	Returns: a ContextMenu with the "Open API URL in browser" option createCitationContextMenu(BibEntry the BibEntry to get the API URL for entry, SearchType the type of search (CITES for references, CITED_BY for citations) searchType) Creates a context menu for citation relation labels with an option to open the API URL in browser
private org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>>	createCitationSearchTask(BibEntry entry, SearchType searchType, boolean bypassCache, List<BibEntry> libraryEntries, BibDatabaseMode databaseMode)
private org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>>	createSearchTask(CitationRelationsTab.CitationFetch fetch, List<BibEntry> libraryEntries, BibDatabaseMode databaseMode) Wraps fetching and duplicate matching into a task whose cancellation checks are bound to that very task.
private void	executeSearch(CitationComponents citationComponents, boolean bypassCache)
private VBox	getErrorPane()
private SplitPane	Returns: SplitPane to display getPaneAndStartSearch(BibEntry BibEntry which is currently selected in JabRef Database entry) Method to create main SplitPane holding all lists, buttons and labels for tab and starts search
private String	getSourceString(BibEntry entry, BibDatabaseMode type, FieldPreferences fieldPreferences, BibEntryTypesManager entryTypesManager)
private BorderPane	getTalliesPane(TalliesResponse tallModel)
private HBox	getTopBar()
private void	handleDragDetected(CheckListView<CitationRelationItem> listView, CitationRelationItem item, MouseEvent event)
private void	handleDragDone(CheckListView<CitationRelationItem> listView, DragEvent event)
private void	handleItemClick(CitationRelationItem item, MouseEvent event, CheckListView<CitationRelationItem> listView, CitationComponents citationComponents)
private void	handleRefresh(CitationComponents citationComponents, CitationComponents otherCitationComponents)
private void	hideNodes(Node... nodes)
private void	importEntries(List<CitationRelationItem> entries to import entriesToImport, SearchType searchType, BibEntry existingEntry) Function to import selected entries to the database.
private void	initFetcherCombo()
private void	jumpToEntry(CitationRelationItem entry)
private List<CitationRelationItem>	matchAgainstLibrary(List<BibEntry> fetchedList, List<BibEntry> libraryEntries, BibDatabaseMode databaseMode, BooleanSupplier isCancelled)
private void	onDoiLookUp()
private void	onDoiLookUpError()
private void	onDoiMissing()
private void	onSciteLookUp()
private void	onSearchForRelationsSucceed(CitationComponents citationComponents, List<CitationRelationItem> citationRelationItems, ObservableList<CitationRelationItem> observableList)
private void	openPossibleDuplicateEntriesWindow(CitationRelationItem duplicate in the citation relations tab citationRelationItem, CheckListView<CitationRelationItem> CheckListView to display citations listView) Function to open possible duplicate entries window to compare duplicate entries
private void	refreshCurrentEntryAfterDoiLookup(BibEntry entry)
private void	resetEmptyPanels()
private void	searchForRelations(CitationComponents citationComponents, CitationComponents otherCitationComponents, boolean bypassCache)
private static void	setLabelOn(CheckListView<CitationRelationItem> listView, String message)
private static void	setLoadingPlaceholder(CheckListView<CitationRelationItem> listView)
private void	setSciteResultsPane()
private void	setUpEmptyPanel(CitationComponents citationComponents, CitationComponents otherCitationComponents)
private void	showEntrySourceDialog(BibEntry entry)
private void	showNodes(Node... nodes)
private CitationRelationsTab.LibrarySnapshot	snapshotActiveLibrary() Snapshots the active library on the JavaFX Application Thread, so the background matching task never iterates the live entry list, which the user can modify while the search runs.
private void	styleFetchedListView(CheckListView<CitationRelationItem> CheckListView to style listView, CitationComponents citationComponents) Styles a given CheckListView to display BibEntries either with a hyperlink or an add button.
private void	styleLabel(Label label to style label, String tooltip text tooltipText) Method to style heading labels
private void	triggerDoiLookup()

Inherited from org.jabref.gui.entryeditor.EntryEditorTab:: currentEntryProperty dispose getCurrentEntry handleFocus notifyAboutFocus setContentDrivenVisibility setPreferenceDrivenVisibility visibility

Field Detail

citationsRelationsTabViewModel	back to summary
private final CitationsRelationsTabViewModel citationsRelationsTabViewModel

currentCitedByComponents	back to summary
private @Nullable CitationComponents currentCitedByComponents

currentCitingComponents	back to summary
private @Nullable CitationComponents currentCitingComponents

dialogService	back to summary
private final DialogService dialogService

duplicateCheck	back to summary
private final DuplicateCheck duplicateCheck

entryEditorPreferences	back to summary
private final EntryEditorPreferences entryEditorPreferences

entryTypesManager	back to summary
private final BibEntryTypesManager entryTypesManager

fetcherCombo	back to summary
private ComboBox<CitationFetcherType> fetcherCombo

LOGGER	back to summary
private static final Logger LOGGER Hides org.jabref.gui.entryeditor.EntryEditorTab.LOGGER.

preferences	back to summary
private final GuiPreferences preferences

previewTooltip	back to summary
private final MainTableTooltip previewTooltip

progressIndicator	back to summary
private final ProgressIndicator progressIndicator

sciteResultsPane	back to summary
private final GridPane sciteResultsPane

searchCitationsRelationsService	back to summary
private final SearchCitationsRelationsService searchCitationsRelationsService

shouldClearSelectionOnDrop	back to summary
private boolean shouldClearSelectionOnDrop

stateManager	back to summary
private final StateManager stateManager

taskExecutor	back to summary
private final TaskExecutor taskExecutor

Constructor Detail

CitationRelationsTab	back to summary
public CitationRelationsTab(DialogService dialogService, StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, GuiPreferences preferences, TaskExecutor taskExecutor, BibEntryTypesManager bibEntryTypesManager, SearchCitationsRelationsService searchCitationsRelationsService)

Method Detail

bindToEntry	back to summary
protected void bindToEntry(BibEntry entry) Implements abstract org.jabref.gui.entryeditor.EntryEditorTab.bindToEntry. Annotations @Override

bindToEntry

back to summary

protected void bindToEntry(BibEntry entry)

Implements abstract org.jabref.gui.entryeditor.EntryEditorTab.bindToEntry.

Annotations

@Override

createCitationContextMenu	back to summary
private ContextMenu createCitationContextMenu(BibEntry entry, SearchType searchType) Creates a context menu for citation relation labels with an option to open the API URL in browser Parameters entry:BibEntry the BibEntry to get the API URL for searchType:SearchType the type of search (CITES for references, CITED_BY for citations) Returns:ContextMenu a ContextMenu with the "Open API URL in browser" option

createCitationContextMenu

back to summary

private ContextMenu createCitationContextMenu(BibEntry entry, SearchType searchType)

Creates a context menu for citation relation labels with an option to open the API URL in browser

Parameters

entry:BibEntry: the BibEntry to get the API URL for
searchType:SearchType: the type of search (CITES for references, CITED_BY for citations)

Returns:ContextMenu

a ContextMenu with the "Open API URL in browser" option

createCitationSearchTask	back to summary
private org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> createCitationSearchTask(BibEntry entry, SearchType searchType, boolean bypassCache, List<BibEntry> libraryEntries, BibDatabaseMode databaseMode)

createSearchTask back to summary

createSearchTask	back to summary
private org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> createSearchTask(CitationRelationsTab.CitationFetch fetch, List<BibEntry> libraryEntries, BibDatabaseMode databaseMode) Wraps fetching and duplicate matching into a task whose cancellation checks are bound to that very task. They must not read the mutable per-direction task references instead: those references are reassigned - or set to `null` - on the JavaFX Application Thread as soon as another entry is selected, so a check evaluated after the fetch returned would either hit `null` or observe an unrelated, newer task.

private org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> createSearchTask(CitationRelationsTab.CitationFetch fetch, List<BibEntry> libraryEntries, BibDatabaseMode databaseMode)

Wraps fetching and duplicate matching into a task whose cancellation checks are bound to that very task. They must not read the mutable per-direction task references instead: those references are reassigned - or set to null - on the JavaFX Application Thread as soon as another entry is selected, so a check evaluated after the fetch returned would either hit null or observe an unrelated, newer task.

executeSearch	back to summary
private void executeSearch(CitationComponents citationComponents, boolean bypassCache)

getErrorPane	back to summary
private VBox getErrorPane()

getPaneAndStartSearch	back to summary
private SplitPane getPaneAndStartSearch(BibEntry entry) Method to create main SplitPane holding all lists, buttons and labels for tab and starts search Parameters entry:BibEntry BibEntry which is currently selected in JabRef Database Returns:SplitPane SplitPane to display

getPaneAndStartSearch

back to summary

private SplitPane getPaneAndStartSearch(BibEntry entry)

Method to create main SplitPane holding all lists, buttons and labels for tab and starts search

Parameters

entry:BibEntry: BibEntry which is currently selected in JabRef Database

Returns:SplitPane

SplitPane to display

getSourceString	back to summary
private String getSourceString(BibEntry entry, BibDatabaseMode type, FieldPreferences fieldPreferences, BibEntryTypesManager entryTypesManager) throws IOException Implementation Note This code is similar to `org.jabref.gui.collab.entrychange.PreviewWithSourceTab`.

getTalliesPane	back to summary
private BorderPane getTalliesPane(TalliesResponse tallModel)

getTopBar	back to summary
private HBox getTopBar()

handleDragDetected	back to summary
private void handleDragDetected(CheckListView<CitationRelationItem> listView, CitationRelationItem item, MouseEvent event)

handleDragDone	back to summary
private void handleDragDone(CheckListView<CitationRelationItem> listView, DragEvent event)

handleItemClick	back to summary
private void handleItemClick(CitationRelationItem item, MouseEvent event, CheckListView<CitationRelationItem> listView, CitationComponents citationComponents)

handleRefresh	back to summary
private void handleRefresh(CitationComponents citationComponents, CitationComponents otherCitationComponents)

hideNodes	back to summary
private void hideNodes(Node... nodes)

importEntries	back to summary
private void importEntries(List<CitationRelationItem> entriesToImport, SearchType searchType, BibEntry existingEntry) Function to import selected entries to the database. Also writes the entries to import to the CITING/CITED field Parameters entriesToImport:List<CitationRelationItem> entries to import

importEntries

back to summary

private void importEntries(List<CitationRelationItem> entriesToImport, SearchType searchType, BibEntry existingEntry)

Function to import selected entries to the database. Also writes the entries to import to the CITING/CITED field

Parameters

entriesToImport:List<CitationRelationItem>: entries to import

initFetcherCombo	back to summary
private void initFetcherCombo()

jumpToEntry	back to summary
private void jumpToEntry(CitationRelationItem entry)

matchAgainstLibrary	back to summary
private List<CitationRelationItem> matchAgainstLibrary(List<BibEntry> fetchedList, List<BibEntry> libraryEntries, BibDatabaseMode databaseMode, BooleanSupplier isCancelled)

onDoiLookUp	back to summary
private void onDoiLookUp()

onDoiLookUpError	back to summary
private void onDoiLookUpError()

onDoiMissing	back to summary
private void onDoiMissing()

onSciteLookUp	back to summary
private void onSciteLookUp()

onSearchForRelationsSucceed	back to summary
private void onSearchForRelationsSucceed(CitationComponents citationComponents, List<CitationRelationItem> citationRelationItems, ObservableList<CitationRelationItem> observableList)

openPossibleDuplicateEntriesWindow	back to summary
private void openPossibleDuplicateEntriesWindow(CitationRelationItem citationRelationItem, CheckListView<CitationRelationItem> listView) Function to open possible duplicate entries window to compare duplicate entries Parameters citationRelationItem:CitationRelationItem duplicate in the citation relations tab listView:CheckListView<CitationRelationItem> CheckListView to display citations

openPossibleDuplicateEntriesWindow

back to summary

private void openPossibleDuplicateEntriesWindow(CitationRelationItem citationRelationItem, CheckListView<CitationRelationItem> listView)

Function to open possible duplicate entries window to compare duplicate entries

Parameters

citationRelationItem:CitationRelationItem: duplicate in the citation relations tab
listView:CheckListView<CitationRelationItem>: CheckListView to display citations

refreshCurrentEntryAfterDoiLookup	back to summary
private void refreshCurrentEntryAfterDoiLookup(BibEntry entry)

resetEmptyPanels	back to summary
private void resetEmptyPanels()

searchForRelations	back to summary
private void searchForRelations(CitationComponents citationComponents, CitationComponents otherCitationComponents, boolean bypassCache)

setLabelOn	back to summary
private static void setLabelOn(CheckListView<CitationRelationItem> listView, String message)

setLoadingPlaceholder	back to summary
private static void setLoadingPlaceholder(CheckListView<CitationRelationItem> listView)

setSciteResultsPane	back to summary
private void setSciteResultsPane()

setUpEmptyPanel	back to summary
private void setUpEmptyPanel(CitationComponents citationComponents, CitationComponents otherCitationComponents)

showEntrySourceDialog	back to summary
private void showEntrySourceDialog(BibEntry entry)

showNodes	back to summary
private void showNodes(Node... nodes)

snapshotActiveLibrary

back to summary

private CitationRelationsTab.LibrarySnapshot snapshotActiveLibrary()

Snapshots the active library on the JavaFX Application Thread, so the background matching task never iterates the live entry list, which the user can modify while the search runs.

Todo

This could be a wrong database, because the user might have switched to another library. Snapshotting when the search is triggered instead of when its result arrives narrows the window, but does not close it - this is still the active library, not the entry's own one. If we were on fixing this, we would need to a) associate a BibEntry with a database or b) pass the database at "bindToEntry".

styleFetchedListView

back to summary

private void styleFetchedListView(CheckListView<CitationRelationItem> listView, CitationComponents citationComponents)

Styles a given CheckListView to display BibEntries either with a hyperlink or an add button. Also adds the handling of mouse clicks.

Parameters

listView:CheckListView<CitationRelationItem>: CheckListView to style

styleLabel

back to summary

private void styleLabel(Label label, String tooltipText)

Method to style heading labels

Parameters

label:Label: label to style
tooltipText:String: tooltip text

triggerDoiLookup	back to summary
private void triggerDoiLookup()

org.jabref.gui.entryeditor.citationrelationtab back to summary

private Interface CitationRelationsTab.CitationFetch

Annotations

@FunctionalInterface

One of the two citation searches of SearchCitationsRelationsService, parameterized over the cancellation check so that createSearchTask can supply the one belonging to the task it is currently building.

Method Summary

Modifier and Type	Method and Description
public List<BibEntry>	fetch(BooleanSupplier isCancelled)

Method Detail

fetch	back to summary
public List<BibEntry> fetch(BooleanSupplier isCancelled) throws org.jabref.logic.importer.FetcherException

org.jabref.gui.entryeditor.citationrelationtab back to summary

private final Record CitationRelationsTab.LibrarySnapshot

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.gui.entryeditor.citationrelationtab.CitationRelationsTab.LibrarySnapshot

Record Components

entries:List<BibEntry>
mode:BibDatabaseMode

Immutable snapshot of the active library, taken on the JavaFX Application Thread and consumed by the background duplicate matching in matchAgainstLibrary.

Field Summary

Modifier and Type	Field and Description
private final List<BibEntry>	entries Record Component accessed by entries().
private final BibDatabaseMode	mode Record Component accessed by mode().

Constructor Summary

Access	Constructor and Description
private	LibrarySnapshot(List<BibEntry> entries, BibDatabaseMode mode)

Method Summary

Modifier and Type	Method and Description
public List<BibEntry>	entries() Record Component getter of entries.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public BibDatabaseMode	mode() Record Component getter of mode.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

entries	back to summary
private final List<BibEntry> entries Record Component accessed by entries().

mode	back to summary
private final BibDatabaseMode mode Record Component accessed by mode().

Constructor Detail

LibrarySnapshot	back to summary
private LibrarySnapshot(List<BibEntry> entries, BibDatabaseMode mode)

Method Detail

entries	back to summary
public List<BibEntry> entries() Record Component getter of entries.

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

mode	back to summary
public BibDatabaseMode mode() Record Component getter of mode.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class CitationRelationsTab

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface CitationRelationsTab.CitationFetch

Method Summary

Method Detail

private final Record CitationRelationsTab.LibrarySnapshot

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail