Verified Owner
Top Inners Fields Constructors Methods
org.jabref.gui.entryeditor.citationrelationtab

public Class CitationsRelationsTabViewModel

extends Object
Class Inheritance
Annotations
@NullMarked
Imports
java.util.List, .Optional, .SequencedSet, java.util.concurrent.Future, javafx.beans.property.ObjectProperty, .ReadOnlyObjectProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, org.jabref.gui.DialogService, .StateManager, org.jabref.gui.externalfiles.ImportHandler, org.jabref.gui.preferences.GuiPreferences, org.jabref.logic.importer.fetcher.CrossRef, .SciteAiFetcher, org.jabref.logic.importer.fetcher.citation.CitationFetcher, org.jabref.logic.l10n.Localization, org.jabref.logic.util.BackgroundTask, .TaskExecutor, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntry, org.jabref.model.entry.field.StandardField, org.jabref.model.sciteTallies.TalliesResponse, org.jabref.model.util.FileUpdateMonitor, org.jspecify.annotations.NullMarked, .Nullable, org.slf4j.Logger, .LoggerFactory

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
CitationsRelationsTabViewModel.SciteStatus

Field Summary

Modifier and TypeField and Description
private @Nullable org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>>
citedByTask

private @Nullable org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>>
citingTask

private @Nullable BibEntry
currentEntry

private Optional<TalliesResponse>
currentResult

private final DialogService
dialogService

private @Nullable Future<?>
doiLookupTask

private final FileUpdateMonitor
fileUpdateMonitor

private final ObjectProperty<@Nullable BibEntry>
lastImportedEntry

private static final Logger
LOGGER

private final GuiPreferences
preferences

private final SciteAiFetcher
sciteAiFetcher

private final StringProperty
searchError

private @Nullable Future<?>
searchTask

private final StateManager
stateManager

private final ObjectProperty<CitationsRelationsTabViewModel.SciteStatus>
status

private final TaskExecutor
taskExecutor

Constructor Summary

AccessConstructor and Description
public
CitationsRelationsTabViewModel(GuiPreferences preferences, StateManager stateManager, DialogService dialogService, FileUpdateMonitor fileUpdateMonitor, TaskExecutor taskExecutor)

Method Summary

Modifier and TypeMethod and Description
public void
cancelCitationSearch(SearchType searchType)

public void
cancelCitationSearches()

public void
cancelDoiLookup()

private void
cancelSearch()

private void
cancelTrackedCitationSearch(@Nullable org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> task)

public void
clearTrackedCitationSearch(SearchType searchType, org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> task)

public Optional<TalliesResponse>
getCurrentResult()

private void
importCitedBy(List<BibEntry> entries, BibEntry existingEntry, ImportHandler importHandler)

"cited by" is the opposite of "cites", but not stored in field CITED_BY, but in the CITES field of the citing entry.

private void
importCites(List<BibEntry> entries, BibEntry existingEntry, ImportHandler importHandler)

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

public boolean
isTrackedCitationSearch(SearchType searchType, org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> task)

public ReadOnlyObjectProperty<BibEntry>
lastImportedEntryProperty()

public void
lookUpDoi(BibEntry entry, Runnable onDoiFound)

public StringProperty
searchErrorProperty()

public ObjectProperty<CitationsRelationsTabViewModel.SciteStatus>
statusProperty()

public void
trackCitationSearch(SearchType searchType, org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> task)

public void
updateForEntry(@Nullable BibEntry entry)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

citedByTaskback to summary
private @Nullable org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> citedByTask
citingTaskback to summary
private @Nullable org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> citingTask
currentEntryback to summary
private @Nullable BibEntry currentEntry
currentResultback to summary
private Optional<TalliesResponse> currentResult
dialogServiceback to summary
private final DialogService dialogService
doiLookupTaskback to summary
private @Nullable Future<?> doiLookupTask
fileUpdateMonitorback to summary
private final FileUpdateMonitor fileUpdateMonitor
lastImportedEntryback to summary
private final ObjectProperty<@Nullable BibEntry> lastImportedEntry
LOGGERback to summary
private static final Logger LOGGER
preferencesback to summary
private final GuiPreferences preferences
sciteAiFetcherback to summary
private final SciteAiFetcher sciteAiFetcher
searchErrorback to summary
private final StringProperty searchError
searchTaskback to summary
private @Nullable Future<?> searchTask
stateManagerback to summary
private final StateManager stateManager
statusback to summary
private final ObjectProperty<CitationsRelationsTabViewModel.SciteStatus> status
taskExecutorback to summary
private final TaskExecutor taskExecutor

Constructor Detail

CitationsRelationsTabViewModelback to summary
public CitationsRelationsTabViewModel(GuiPreferences preferences, StateManager stateManager, DialogService dialogService, FileUpdateMonitor fileUpdateMonitor, TaskExecutor taskExecutor)

Method Detail

cancelCitationSearchback to summary
public void cancelCitationSearch(SearchType searchType)
cancelCitationSearchesback to summary
public void cancelCitationSearches()
cancelDoiLookupback to summary
public void cancelDoiLookup()
cancelSearchback to summary
private void cancelSearch()
cancelTrackedCitationSearchback to summary
private void cancelTrackedCitationSearch(@Nullable org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> task)
clearTrackedCitationSearchback to summary
public void clearTrackedCitationSearch(SearchType searchType, org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> task)
getCurrentResultback to summary
public Optional<TalliesResponse> getCurrentResult()
importCitedByback to summary
private void importCitedBy(List<BibEntry> entries, BibEntry existingEntry, ImportHandler importHandler)

"cited by" is the opposite of "cites", but not stored in field CITED_BY, but in the CITES field of the citing entry.

Therefore, some special handling is needed

importCitesback to summary
private void importCites(List<BibEntry> entries, BibEntry existingEntry, ImportHandler importHandler)
importEntriesback to summary
public void importEntries(List<CitationRelationItem> entriesToImport, SearchType searchType, BibEntry existingEntry)
isTrackedCitationSearchback to summary
public boolean isTrackedCitationSearch(SearchType searchType, org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> task)
lastImportedEntryPropertyback to summary
public ReadOnlyObjectProperty<BibEntry> lastImportedEntryProperty()
lookUpDoiback to summary
public void lookUpDoi(BibEntry entry, Runnable onDoiFound)
searchErrorPropertyback to summary
public StringProperty searchErrorProperty()
statusPropertyback to summary
public ObjectProperty<CitationsRelationsTabViewModel.SciteStatus> statusProperty()
trackCitationSearchback to summary
public void trackCitationSearch(SearchType searchType, org.jabref.logic.util.BackgroundTask<List<CitationRelationItem>> task)
updateForEntryback to summary
public void updateForEntry(@Nullable BibEntry entry)
org.jabref.gui.entryeditor.citationrelationtab back to summary

public final Enum CitationsRelationsTabViewModel.SciteStatus

extends Enum<CitationsRelationsTabViewModel.SciteStatus>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final CitationsRelationsTabViewModel.SciteStatus
DOI_LOOK_UP

public static final CitationsRelationsTabViewModel.SciteStatus
DOI_LOOK_UP_ERROR

public static final CitationsRelationsTabViewModel.SciteStatus
DOI_MISSING

public static final CitationsRelationsTabViewModel.SciteStatus
ERROR

public static final CitationsRelationsTabViewModel.SciteStatus
FOUND

public static final CitationsRelationsTabViewModel.SciteStatus
IN_PROGRESS

Constructor Summary

AccessConstructor and Description
private
SciteStatus()

Method Summary

Modifier and TypeMethod and Description
public static CitationsRelationsTabViewModel.SciteStatus
valueOf(String name)

public static CitationsRelationsTabViewModel.SciteStatus[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DOI_LOOK_UPback to summary
public static final CitationsRelationsTabViewModel.SciteStatus DOI_LOOK_UP
DOI_LOOK_UP_ERRORback to summary
public static final CitationsRelationsTabViewModel.SciteStatus DOI_LOOK_UP_ERROR
DOI_MISSINGback to summary
public static final CitationsRelationsTabViewModel.SciteStatus DOI_MISSING
ERRORback to summary
public static final CitationsRelationsTabViewModel.SciteStatus ERROR
FOUNDback to summary
public static final CitationsRelationsTabViewModel.SciteStatus FOUND
IN_PROGRESSback to summary
public static final CitationsRelationsTabViewModel.SciteStatus IN_PROGRESS

Constructor Detail

SciteStatusback to summary
private SciteStatus()

Method Detail

valueOfback to summary
public static CitationsRelationsTabViewModel.SciteStatus valueOf(String name)
valuesback to summary
public static CitationsRelationsTabViewModel.SciteStatus[] values()