JabRef 6.0-beta.1 · org.jabref.gui.externalfiles.UnlinkedFilesCrawler

Util class for searching files on the file system which are not linked to a provided org.jabref.model.database.BibDatabase.

The result is used to determine whether to link the files to an existing related entry or to create a new entry, according to the user's choice.

Field Summary

Modifier and Type	Field and Description
private final AutoLinkPreferences	autoLinkPreferences
private final BibDatabaseContext	databaseContext
private final DateRange	dateFilter
private final Path	directory
private final ExternalApplicationsPreferences	externalApplicationsPreferences
private final DirectoryStream.Filter<Path>	fileFilter
private final FilePreferences	filePreferences
private static final Logger	LOGGER
private final ExternalFileSorter	sorter

Constructor Summary

Access	Constructor and Description
public	UnlinkedFilesCrawler(Path directory, DirectoryStream.Filter<Path> fileFilter, DateRange dateFilter, ExternalFileSorter sorter, BibDatabaseContext databaseContext, FilePreferences filePreferences, ExternalApplicationsPreferences externalApplicationsPreferences, AutoLinkPreferences autoLinkPreferences)

Method Summary

Modifier and Type	Method and Description
public UnlinkedFilesSearchResult	call() `impl->req~jabgui.externalfiles.unlinked-files.search.non-blocking-results~1`
private Map<Path, List<BibEntry>>	findRelatedEntriesByFile()
pack-priv FileNodeViewModel	Returns: FileNodeViewModel containing the data of the current directory and all subdirectories searchDirectory(Path directory, UnlinkedPDFFileFilter contains a BibDatabaseContext which is used to determine whether the file is linked unlinkedPDFFileFilter) Searches recursively all files in the specified directory.

Field Detail

autoLinkPreferences	back to summary
private final AutoLinkPreferences autoLinkPreferences

databaseContext	back to summary
private final BibDatabaseContext databaseContext

dateFilter	back to summary
private final DateRange dateFilter

directory	back to summary
private final Path directory

externalApplicationsPreferences	back to summary
private final ExternalApplicationsPreferences externalApplicationsPreferences

fileFilter	back to summary
private final DirectoryStream.Filter<Path> fileFilter

filePreferences	back to summary
private final FilePreferences filePreferences

LOGGER	back to summary
private static final Logger LOGGER

sorter	back to summary
private final ExternalFileSorter sorter

Constructor Detail

UnlinkedFilesCrawler	back to summary
public UnlinkedFilesCrawler(Path directory, DirectoryStream.Filter<Path> fileFilter, DateRange dateFilter, ExternalFileSorter sorter, BibDatabaseContext databaseContext, FilePreferences filePreferences, ExternalApplicationsPreferences externalApplicationsPreferences, AutoLinkPreferences autoLinkPreferences)

Method Detail

call back to summary

call	back to summary
public UnlinkedFilesSearchResult call() throws IOException `impl->req~jabgui.externalfiles.unlinked-files.search.non-blocking-results~1` Annotations @Override

public UnlinkedFilesSearchResult call() throws IOException

impl->req~jabgui.externalfiles.unlinked-files.search.non-blocking-results~1

Annotations

@Override

findRelatedEntriesByFile	back to summary
private Map<Path, List<BibEntry>> findRelatedEntriesByFile()

searchDirectory back to summary

searchDirectory	back to summary
pack-priv FileNodeViewModel searchDirectory(Path directory, UnlinkedPDFFileFilter unlinkedPDFFileFilter) throws IOException Searches recursively all files in the specified directory. All files matched by the given `UnlinkedPDFFileFilter` are taken into the resulting tree. The result will be a tree structure of nodes of the type `javafx.scene.control.CheckBoxTreeItem`. The user objects that are attached to the nodes is the `FileNodeViewModel`, which wraps the `java.io.File`-Object. For ensuring the capability to cancel the work of this recursive method, the first position in the integer array 'state' must be set to 1, to keep the recursion running. When the states value changes, the method will resolve its recursion and return what it has saved so far. The files are filtered according to the `DateRange` filter value and then sorted according to the `ExternalFileSorter` value. Parameters unlinkedPDFFileFilter:UnlinkedPDFFileFilter contains a BibDatabaseContext which is used to determine whether the file is linked Returns:FileNodeViewModel FileNodeViewModel containing the data of the current directory and all subdirectories Exceptions IOException: if directory is not a directory or empty

pack-priv FileNodeViewModel searchDirectory(Path directory, UnlinkedPDFFileFilter unlinkedPDFFileFilter) throws IOException

Searches recursively all files in the specified directory.

All files matched by the given UnlinkedPDFFileFilter are taken into the resulting tree.

The result will be a tree structure of nodes of the type javafx.scene.control.CheckBoxTreeItem.

The user objects that are attached to the nodes is the FileNodeViewModel, which wraps the java.io.File-Object.

For ensuring the capability to cancel the work of this recursive method, the first position in the integer array 'state' must be set to 1, to keep the recursion running. When the states value changes, the method will resolve its recursion and return what it has saved so far.

The files are filtered according to the DateRange filter value and then sorted according to the ExternalFileSorter value.

Parameters

unlinkedPDFFileFilter:UnlinkedPDFFileFilter: contains a BibDatabaseContext which is used to determine whether the file is linked

Returns:FileNodeViewModel

FileNodeViewModel containing the data of the current directory and all subdirectories

Exceptions