Verified Owner
Top Fields Constructors Methods
org.jabref.gui.importer

public Class ImportEntriesViewModel

extends AbstractViewModel
Class Inheritance
Imports
java.io.IOException, .StringWriter, java.util.ArrayList, .List, .Optional, javafx.beans.property.BooleanProperty, .IntegerProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleIntegerProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, javafx.collections.FXCollections, .ObservableList, .ObservableSet, org.jabref.gui.AbstractViewModel, .DialogService, .StateManager, org.jabref.gui.externalfiles.EntryImportHandlerTracker, .ImportHandler, org.jabref.gui.preferences.GuiPreferences, org.jabref.logic.bibtex.BibEntryWriter, .FieldWriter, org.jabref.logic.database.DatabaseMerger, .DuplicateCheck, org.jabref.logic.exporter.BibWriter, org.jabref.logic.groups.GroupsHelper, org.jabref.logic.importer.PagedSearchBasedFetcher, .ParserResult, .SearchBasedFetcher, org.jabref.logic.l10n.Localization, org.jabref.logic.os.OS, org.jabref.logic.undo.UndoManager, org.jabref.logic.util.BackgroundTask, .TaskExecutor, org.jabref.logic.util.strings.StringUtil, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntry, .BibEntryTypesManager, org.jabref.model.util.FileUpdateMonitor, org.jspecify.annotations.Nullable, org.slf4j.Logger, .LoggerFactory

Field Summary

Modifier and TypeField and Description
private final ObservableList<BibEntry>
private final ObservableSet<BibEntry>
private final IntegerProperty
private final BibDatabaseContext
private final DialogService
private final ObservableList<BibEntry>
private final BibEntryTypesManager
private final Optional<SearchBasedFetcher>
private final FileUpdateMonitor
private final BooleanProperty
private final BooleanProperty
private static final Logger
private final StringProperty
private static final int
private final ObservableList<BibEntry>
private ParserResult
private final GuiPreferences
private final Optional<String>
private final ObjectProperty<BibDatabaseContext>
private final StateManager
private final TaskExecutor
private final IntegerProperty
private final UndoManager

Constructor Summary

AccessConstructor and Description
public
ImportEntriesViewModel(org.jabref.logic.util.BackgroundTask<ParserResult>
the task executed for parsing the selected files(s).
task
,
TaskExecutor taskExecutor, BibDatabaseContext
the database to import into
databaseContext
,
DialogService dialogService, UndoManager undoManager, GuiPreferences preferences, StateManager stateManager, BibEntryTypesManager entryTypesManager, FileUpdateMonitor fileUpdateMonitor, Optional<SearchBasedFetcher> fetcher, Optional<String> query)

Method Summary

Modifier and TypeMethod and Description
public IntegerProperty
public void
private Optional<BibEntry>

Returns:

A possible duplicate, if any, or null if none were found.
findInternalDuplicate
(BibEntry
The entry to search for duplicates of.
entry
)

Checks if there are duplicates to the given entry in the list of entries to be imported.

public ObservableList<BibEntry>
public ObservableSet<BibEntry>
public ObservableList<BibEntry>
public String
public BibDatabaseContext
public String
public void
public void
public boolean
public boolean
public boolean
public void
importEntries(List<BibEntry>
subset of the entries contained in parserResult
entriesToImport
,
boolean shouldDownloadFiles)

Called after the user selected the entries to import.

public void
importEntries(List<BibEntry> entriesToImport, boolean shouldDownloadFiles, @Nullable String
name of a group the imported entries are additionally assigned to. If it is non-blank and no group with that name exists yet, it is created as a top-level explicit group. A blank/null value assigns no group.
targetGroup
)

public BooleanProperty
private boolean
public void
public BooleanProperty
public StringProperty
public ObjectProperty<BibDatabaseContext>
public IntegerProperty
private void
public void

Field Detail

allEntriesback to summary
private final ObservableList<BibEntry> allEntries
checkedEntriesback to summary
private final ObservableSet<BibEntry> checkedEntries
currentPagePropertyback to summary
private final IntegerProperty currentPageProperty
databaseContextback to summary
private final BibDatabaseContext databaseContext
dialogServiceback to summary
private final DialogService dialogService
entriesback to summary
private final ObservableList<BibEntry> entries
entryTypesManagerback to summary
private final BibEntryTypesManager entryTypesManager
fetcherback to summary
private final Optional<SearchBasedFetcher> fetcher
fileUpdateMonitorback to summary
private final FileUpdateMonitor fileUpdateMonitor
initialLoadCompleteback to summary
private final BooleanProperty initialLoadComplete
loadingback to summary
private final BooleanProperty loading
LOGGERback to summary
private static final Logger LOGGER
messageback to summary
private final StringProperty message
PAGE_SIZEback to summary
private static final int PAGE_SIZE
pagedEntriesback to summary
private final ObservableList<BibEntry> pagedEntries
parserResultback to summary
private ParserResult parserResult
preferencesback to summary
private final GuiPreferences preferences
queryback to summary
private final Optional<String> query
selectedDbback to summary
private final ObjectProperty<BibDatabaseContext> selectedDb
stateManagerback to summary
private final StateManager stateManager
taskExecutorback to summary
private final TaskExecutor taskExecutor
totalPagesPropertyback to summary
private final IntegerProperty totalPagesProperty
undoManagerback to summary
private final UndoManager undoManager

Constructor Detail

ImportEntriesViewModelback to summary
public ImportEntriesViewModel(org.jabref.logic.util.BackgroundTask<ParserResult> task, TaskExecutor taskExecutor, BibDatabaseContext databaseContext, DialogService dialogService, UndoManager undoManager, GuiPreferences preferences, StateManager stateManager, BibEntryTypesManager entryTypesManager, FileUpdateMonitor fileUpdateMonitor, Optional<SearchBasedFetcher> fetcher, Optional<String> query)
Parameters
task:org.jabref.logic.util.BackgroundTask<ParserResult>

the task executed for parsing the selected files(s).

databaseContext:BibDatabaseContext

the database to import into

Method Detail

currentPagePropertyback to summary
public IntegerProperty currentPageProperty()
fetchMoreEntriesback to summary
public void fetchMoreEntries()
findInternalDuplicateback to summary
private Optional<BibEntry> findInternalDuplicate(BibEntry entry)

Checks if there are duplicates to the given entry in the list of entries to be imported.

Parameters
entry:BibEntry

The entry to search for duplicates of.

Returns:Optional<BibEntry>

A possible duplicate, if any, or null if none were found.

getAllEntriesback to summary
public ObservableList<BibEntry> getAllEntries()
getCheckedEntriesback to summary
public ObservableSet<BibEntry> getCheckedEntries()
getEntriesback to summary
public ObservableList<BibEntry> getEntries()
getMessageback to summary
public String getMessage()
getSelectedDbback to summary
public BibDatabaseContext getSelectedDb()
getSourceStringback to summary
public String getSourceString(BibEntry entry)
goToNextPageback to summary
public void goToNextPage()
goToPrevPageback to summary
public void goToPrevPage()
hasDuplicateback to summary
public boolean hasDuplicate(BibEntry entry)
hasNextPageback to summary
public boolean hasNextPage()
hasPrevPageback to summary
public boolean hasPrevPage()
importEntriesback to summary
public void importEntries(List<BibEntry> entriesToImport, boolean shouldDownloadFiles)

Called after the user selected the entries to import. Does the real import stuff.

Parameters
entriesToImport:List<BibEntry>

subset of the entries contained in parserResult

importEntriesback to summary
public void importEntries(List<BibEntry> entriesToImport, boolean shouldDownloadFiles, @Nullable String targetGroup)
Parameters
targetGroup:@Nullable String

name of a group the imported entries are additionally assigned to. If it is non-blank and no group with that name exists yet, it is created as a top-level explicit group. A blank/null value assigns no group.

initialLoadCompletePropertyback to summary
public BooleanProperty initialLoadCompleteProperty()
isFromWebSearchback to summary
private boolean isFromWebSearch()
loadEntriesback to summary
public void loadEntries(List<BibEntry> entries)
loadingPropertyback to summary
public BooleanProperty loadingProperty()
messagePropertyback to summary
public StringProperty messageProperty()
selectedDbPropertyback to summary
public ObjectProperty<BibDatabaseContext> selectedDbProperty()
totalPagesPropertyback to summary
public IntegerProperty totalPagesProperty()
updatePagedEntriesback to summary
private void updatePagedEntries()
updateTotalPagesback to summary
public void updateTotalPages()