Modifier and Type	Class and Description
pack-priv static record	ImportHandler.AutoDetectionImportOutcome
private static record	ImportHandler.DuplicateDecisionRequest

Modifier and Type	Field and Description
private final ExternalFilesContentImporter	contentImporter
private final DialogService	dialogService
private boolean	duplicateDecisionDialogInProgress
private final Deque<ImportHandler.DuplicateDecisionRequest>	duplicateDecisionRequests
private static final Set<String>	EXCLUDED_CENTER_DROP_EXTENSIONS
private final ExternalFilesEntryLinker	fileLinker
private static final String	FILENAME_FALLBACK
private final FilePreferences	filePreferences
private final FileUpdateMonitor	fileUpdateMonitor
private final ImportFormatReader	importFormatReader
private static final Logger	LOGGER
private final GuiPreferences	preferences
private DuplicateResolverDialog.DuplicateResolverResult	rememberedBatchDuplicateDecision
private final StateManager	stateManager
private final BibDatabaseContext	targetBibDatabaseContext
private final TaskExecutor	taskExecutor
private final UndoManager	undoManager

Access	Constructor and Description
public	ImportHandler(BibDatabaseContext targetBibDatabaseContext, GuiPreferences preferences, FileUpdateMonitor fileupdateMonitor, UndoManager undoManager, StateManager stateManager, DialogService dialogService, TaskExecutor taskExecutor)

Method Summary

Modifier and Type	Method and Description
private void	addToGroups(List<BibEntry> entries, Collection<GroupTreeNode> groups)
private void	addToImportEntriesGroup(List<BibEntry> entriesToInsert)
private BibEntry	adjustLinkedFilesForTargetIfRequired(@Nullable TransferInformation transferInformation, BibEntry entry)
public boolean	canImportAsBibEntry(Path file) Checks whether the given file should be imported as bibliographic entries rather than attached as a file to an existing entry.
pack-priv BibEntry	cleanUpEntry(BibEntry entry)
private void	continueImportAfterDuplicateHandling(@Nullable TransferInformation transferInformation, BibEntry entryForImport, EntryImportHandlerTracker tracker)
pack-priv ImportHandler.AutoDetectionImportOutcome	createAutoDetectionImportOutcome(Path file, ImportResult importResult)
private BibEntry	createEmptyEntryWithLink(Path file)
public void	downloadLinkedFiles(BibEntry entry)
private void	enqueueDuplicateDecisionRequest(ImportHandler.DuplicateDecisionRequest request)
public Optional<BibEntry>	findDuplicate(BibEntry entryToCheck)
private void	generateKeys(List<BibEntry> entries to generate keys for entries) Generate keys for given entries if globally configured - or citation key is empty
public CompletableFuture<DuplicateDecisionResult>	getDuplicateDecision(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision)
public ExternalFilesEntryLinker	getFileLinker()
public @NonNull List<@NonNull BibEntry>	handleBibTeXData(@NonNull String entries)
private @NonNull Optional<BibEntry>	handleDecisionResult(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateDecisionResult decisionResult)
public CompletableFuture<Optional<BibEntry>>	handleDuplicates(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision)
private List<BibEntry>	handlePdfUrl(String pdfUrl)
public List<BibEntry>	handleStringData(String data)
public void	importCleanedEntries(@Nullable TransferInformation transferInformation, List<BibEntry> entries) Adds already cleaned entries to the library, as one undo step.
public void	importEntries(List<BibEntry> entries) Cleans up the given entries and adds them to the library.
public void	importEntriesWithDuplicateCheck(@Nullable TransferInformation transferInformation, List<BibEntry> entriesToAdd)
public void	importEntriesWithDuplicateCheck(@Nullable TransferInformation transferInformation, List<BibEntry> entriesToAdd, EntryImportHandlerTracker tracker)
public void	importEntryWithDuplicateCheck(@Nullable TransferInformation transferInformation, BibEntry entry)
private void	importEntryWithDuplicateCheck(@Nullable TransferInformation transferInformation, BibEntry the entry to import (original will not be modified) entry, DuplicateResolverDialog.DuplicateResolverResult the duplicate resolution strategy to apply decision, EntryImportHandlerTracker tracks the import status of the entry tracker) Imports an entry into the database with duplicate checking and handling.
public org.jabref.logic.util.BackgroundTask<List<ImportFilesResultItemViewModel>>	importFilesInBackground(final List<Path> files, TransferMode transferMode)
public void	importStringConstantsWithDuplicateCheck(Collection<BibtexString> stringConstants)
private void	insertImported(List<BibEntry> entriesToAdd, UndoSuspension suspended) Inserts the imported entries and releases the library the import held.
private void	processDuplicateDecisionQueue()
private void	removeReplacedDuplicate(BibEntry duplicateEntry) Removes the entry that the import replaces or merges into, recording it.
private void	resetBatchDuplicateDecisionState()
private DuplicateDecisionResult	resolveDuplicateDecision(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision)
public void	setAutomaticFields(List<BibEntry> entries)
private List<BibEntry>	tryImportFormats(String data)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

contentImporter	back to summary
private final ExternalFilesContentImporter contentImporter

dialogService	back to summary
private final DialogService dialogService

duplicateDecisionDialogInProgress	back to summary
private boolean duplicateDecisionDialogInProgress

duplicateDecisionRequests	back to summary
private final Deque<ImportHandler.DuplicateDecisionRequest> duplicateDecisionRequests

EXCLUDED_CENTER_DROP_EXTENSIONS	back to summary
private static final Set<String> EXCLUDED_CENTER_DROP_EXTENSIONS

fileLinker	back to summary
private final ExternalFilesEntryLinker fileLinker

FILENAME_FALLBACK	back to summary
private static final String FILENAME_FALLBACK

filePreferences	back to summary
private final FilePreferences filePreferences

fileUpdateMonitor	back to summary
private final FileUpdateMonitor fileUpdateMonitor

importFormatReader	back to summary
private final ImportFormatReader importFormatReader

LOGGER	back to summary
private static final Logger LOGGER

preferences	back to summary
private final GuiPreferences preferences

rememberedBatchDuplicateDecision	back to summary
private DuplicateResolverDialog.DuplicateResolverResult rememberedBatchDuplicateDecision

stateManager	back to summary
private final StateManager stateManager

targetBibDatabaseContext	back to summary
private final BibDatabaseContext targetBibDatabaseContext

taskExecutor	back to summary
private final TaskExecutor taskExecutor

undoManager	back to summary
private final UndoManager undoManager

ImportHandler	back to summary
public ImportHandler(BibDatabaseContext targetBibDatabaseContext, GuiPreferences preferences, FileUpdateMonitor fileupdateMonitor, UndoManager undoManager, StateManager stateManager, DialogService dialogService, TaskExecutor taskExecutor)

Method Detail

addToGroups	back to summary
private void addToGroups(List<BibEntry> entries, Collection<GroupTreeNode> groups)

addToImportEntriesGroup	back to summary
private void addToImportEntriesGroup(List<BibEntry> entriesToInsert)

adjustLinkedFilesForTargetIfRequired	back to summary
private BibEntry adjustLinkedFilesForTargetIfRequired(@Nullable TransferInformation transferInformation, BibEntry entry)

canImportAsBibEntry	back to summary
public boolean canImportAsBibEntry(Path file) Checks whether the given file should be imported as bibliographic entries rather than attached as a file to an existing entry. Excludes PDFs and generic document/data file extensions (.txt, .xml, .yml, .yaml) which are intended to be attached as files.

cleanUpEntry	back to summary
pack-priv BibEntry cleanUpEntry(BibEntry entry) Annotations @VisibleForTesting

continueImportAfterDuplicateHandling	back to summary
private void continueImportAfterDuplicateHandling(@Nullable TransferInformation transferInformation, BibEntry entryForImport, EntryImportHandlerTracker tracker)

createAutoDetectionImportOutcome	back to summary
pack-priv ImportHandler.AutoDetectionImportOutcome createAutoDetectionImportOutcome(Path file, ImportResult importResult)

createEmptyEntryWithLink	back to summary
private BibEntry createEmptyEntryWithLink(Path file)

downloadLinkedFiles	back to summary
public void downloadLinkedFiles(BibEntry entry)

enqueueDuplicateDecisionRequest	back to summary
private void enqueueDuplicateDecisionRequest(ImportHandler.DuplicateDecisionRequest request)

findDuplicate	back to summary
public Optional<BibEntry> findDuplicate(BibEntry entryToCheck)

generateKeys	back to summary
private void generateKeys(List<BibEntry> entries) Generate keys for given entries if globally configured - or citation key is empty Parameters entries:List<BibEntry> entries to generate keys for

generateKeys

back to summary

private void generateKeys(List<BibEntry> entries)

Generate keys for given entries if globally configured - or citation key is empty

Parameters

entries:List<BibEntry>: entries to generate keys for

getDuplicateDecision	back to summary
public CompletableFuture<DuplicateDecisionResult> getDuplicateDecision(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision)

getFileLinker	back to summary
public ExternalFilesEntryLinker getFileLinker()

handleBibTeXData	back to summary
public @NonNull List<@NonNull BibEntry> handleBibTeXData(@NonNull String entries)

handleDecisionResult	back to summary
private @NonNull Optional<BibEntry> handleDecisionResult(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateDecisionResult decisionResult)

handleDuplicates	back to summary
public CompletableFuture<Optional<BibEntry>> handleDuplicates(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision)

handlePdfUrl	back to summary
private List<BibEntry> handlePdfUrl(String pdfUrl) throws IOException

handleStringData	back to summary
public List<BibEntry> handleStringData(String data) throws org.jabref.logic.importer.FetcherException

importCleanedEntries	back to summary
public void importCleanedEntries(@Nullable TransferInformation transferInformation, List<BibEntry> entries) Adds already cleaned entries to the library, as one undo step. The step is opened here rather than left to the caller, because this is where the entries reach the library: a caller that forgot would insert entries the journal knows nothing about, which is a library that says it needs no saving. The group assignment this sets off joins the same step, so taking the import back takes the assignments with it.

importCleanedEntries

back to summary

public void importCleanedEntries(@Nullable TransferInformation transferInformation, List<BibEntry> entries)

Adds already cleaned entries to the library, as one undo step.

The step is opened here rather than left to the caller, because this is where the entries reach the library: a caller that forgot would insert entries the journal knows nothing about, which is a library that says it needs no saving. The group assignment this sets off joins the same step, so taking the import back takes the assignments with it.

importEntries	back to summary
public void importEntries(List<BibEntry> entries) Cleans up the given entries and adds them to the library. Actions include generating a citation key if configured

importEntries

back to summary

public void importEntries(List<BibEntry> entries)

Cleans up the given entries and adds them to the library.

Actions include generating a citation key if configured

importEntriesWithDuplicateCheck	back to summary
public void importEntriesWithDuplicateCheck(@Nullable TransferInformation transferInformation, List<BibEntry> entriesToAdd)

importEntriesWithDuplicateCheck	back to summary
public void importEntriesWithDuplicateCheck(@Nullable TransferInformation transferInformation, List<BibEntry> entriesToAdd, EntryImportHandlerTracker tracker)

importEntryWithDuplicateCheck	back to summary
public void importEntryWithDuplicateCheck(@Nullable TransferInformation transferInformation, BibEntry entry)

importEntryWithDuplicateCheck	back to summary
private void importEntryWithDuplicateCheck(@Nullable TransferInformation transferInformation, BibEntry entry, DuplicateResolverDialog.DuplicateResolverResult decision, EntryImportHandlerTracker tracker) Imports an entry into the database with duplicate checking and handling. Creates a copy of the entry for processing - the original entry parameter is not modified. The copied entry may be modified during cleanup and duplicate handling. Parameters entry:BibEntry the entry to import (original will not be modified) decision:DuplicateResolverDialog.DuplicateResolverResult the duplicate resolution strategy to apply tracker:EntryImportHandlerTracker tracks the import status of the entry

importEntryWithDuplicateCheck

back to summary

private void importEntryWithDuplicateCheck(@Nullable TransferInformation transferInformation, BibEntry entry, DuplicateResolverDialog.DuplicateResolverResult decision, EntryImportHandlerTracker tracker)

Imports an entry into the database with duplicate checking and handling. Creates a copy of the entry for processing - the original entry parameter is not modified. The copied entry may be modified during cleanup and duplicate handling.

Parameters

entry:BibEntry: the entry to import (original will not be modified)
decision:DuplicateResolverDialog.DuplicateResolverResult: the duplicate resolution strategy to apply
tracker:EntryImportHandlerTracker: tracks the import status of the entry

importFilesInBackground	back to summary
public org.jabref.logic.util.BackgroundTask<List<ImportFilesResultItemViewModel>> importFilesInBackground(final List<Path> files, TransferMode transferMode)

importStringConstantsWithDuplicateCheck	back to summary
public void importStringConstantsWithDuplicateCheck(Collection<BibtexString> stringConstants)

insertImported back to summary

insertImported	back to summary
private void insertImported(List<BibEntry> entriesToAdd, UndoSuspension suspended) Inserts the imported entries and releases the library the import held. `importCleanedEntries` records the insert as one step, so the files imported together are one Ctrl+Z, and what the insert sets off — group assignment, and the tab's automatic assignment to the selected groups — is recorded inside that step rather than after it.

private void insertImported(List<BibEntry> entriesToAdd, UndoSuspension suspended)

Inserts the imported entries and releases the library the import held.

importCleanedEntries records the insert as one step, so the files imported together are one Ctrl+Z, and what the insert sets off — group assignment, and the tab's automatic assignment to the selected groups — is recorded inside that step rather than after it.

processDuplicateDecisionQueue	back to summary
private void processDuplicateDecisionQueue()

removeReplacedDuplicate

back to summary

private void removeReplacedDuplicate(BibEntry duplicateEntry)

Removes the entry that the import replaces or merges into, recording it.

Its own step, because it happens well before the import it makes room for — the decision is asked of the user asynchronously. Undoing the import therefore takes the imported entry back out, and undoing once more brings the replaced entry back, rather than leaving the library without either.

resetBatchDuplicateDecisionState	back to summary
private void resetBatchDuplicateDecisionState()

resolveDuplicateDecision	back to summary
private DuplicateDecisionResult resolveDuplicateDecision(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision)

setAutomaticFields	back to summary
public void setAutomaticFields(List<BibEntry> entries)

tryImportFormats	back to summary
private List<BibEntry> tryImportFormats(String data)

org.jabref.gui.externalfiles back to summary

pack-priv final Record ImportHandler.AutoDetectionImportOutcome

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.gui.externalfiles.ImportHandler.AutoDetectionImportOutcome

Record Components

entriesToAdd:List<BibEntry>
success:boolean
message:String

Field Summary

Modifier and Type	Field and Description
private final List<BibEntry>	entriesToAdd Record Component accessed by entriesToAdd().
private final String	message Record Component accessed by message().
private final boolean	success Record Component accessed by success().

Constructor Summary

Access	Constructor and Description
pack-priv	AutoDetectionImportOutcome(List<BibEntry> entriesToAdd, boolean success, String message)

Method Summary

Modifier and Type	Method and Description
public List<BibEntry>	entriesToAdd() Record Component getter of entriesToAdd.
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 String	message() Record Component getter of message.
public boolean	success() Record Component getter of success.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

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

message	back to summary
private final String message Record Component accessed by message().

success	back to summary
private final boolean success Record Component accessed by success().

Constructor Detail

AutoDetectionImportOutcome	back to summary
pack-priv AutoDetectionImportOutcome(List<BibEntry> entriesToAdd, boolean success, String message)

Method Detail

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

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.

message	back to summary
public String message() Record Component getter of message.

success	back to summary
public boolean success() Record Component getter of success.

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.

org.jabref.gui.externalfiles back to summary

private final Record ImportHandler.DuplicateDecisionRequest

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.gui.externalfiles.ImportHandler.DuplicateDecisionRequest

Record Components

originalEntry:BibEntry
duplicateEntry:BibEntry
decision:DuplicateResolverDialog.DuplicateResolverResult
result:CompletableFuture<DuplicateDecisionResult>

Field Summary

Modifier and Type	Field and Description
private final DuplicateResolverDialog.DuplicateResolverResult	decision Record Component accessed by decision().
private final BibEntry	duplicateEntry Record Component accessed by duplicateEntry().
private final BibEntry	originalEntry Record Component accessed by originalEntry().
private final CompletableFuture<DuplicateDecisionResult>	result Record Component accessed by result().

Constructor Summary

Access	Constructor and Description
private	DuplicateDecisionRequest(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision)
private	DuplicateDecisionRequest(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision, CompletableFuture<DuplicateDecisionResult> result)

Method Summary

Modifier and Type	Method and Description
public DuplicateResolverDialog.DuplicateResolverResult	decision() Record Component getter of decision.
public BibEntry	duplicateEntry() Record Component getter of duplicateEntry.
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 BibEntry	originalEntry() Record Component getter of originalEntry.
public CompletableFuture<DuplicateDecisionResult>	result() Record Component getter of result.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

decision	back to summary
private final DuplicateResolverDialog.DuplicateResolverResult decision Record Component accessed by decision().

duplicateEntry	back to summary
private final BibEntry duplicateEntry Record Component accessed by duplicateEntry().

originalEntry	back to summary
private final BibEntry originalEntry Record Component accessed by originalEntry().

result	back to summary
private final CompletableFuture<DuplicateDecisionResult> result Record Component accessed by result().

Constructor Detail

DuplicateDecisionRequest	back to summary
private DuplicateDecisionRequest(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision)

DuplicateDecisionRequest	back to summary
private DuplicateDecisionRequest(BibEntry originalEntry, BibEntry duplicateEntry, DuplicateResolverDialog.DuplicateResolverResult decision, CompletableFuture<DuplicateDecisionResult> result)

Method Detail

decision	back to summary
public DuplicateResolverDialog.DuplicateResolverResult decision() Record Component getter of decision.

duplicateEntry	back to summary
public BibEntry duplicateEntry() Record Component getter of duplicateEntry.

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    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.

originalEntry	back to summary
public BibEntry originalEntry() Record Component getter of originalEntry.

result	back to summary
public CompletableFuture<DuplicateDecisionResult> result() Record Component getter of result.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

public Class ImportHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Record ImportHandler.AutoDetectionImportOutcome

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record ImportHandler.DuplicateDecisionRequest

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail