Modifier and Type	Class and Description
public static class	AutoSetFileLinksUtil.LinkFilesResult

Modifier and Type

Class and Description

public static class

AutoSetFileLinksUtil.LinkFilesResult

Modifier and Type	Field and Description
private final AutoLinkPreferences	autoLinkPreferences
private final FileFinder	brokenLinkedFileNameBasedFileFinder
private final List<Path>	directories
private final ExternalApplicationsPreferences	externalApplicationsPreferences
private static final Logger	LOGGER
private final FileFinder	preConfiguredFileFinder

Modifier and Type

Field and Description

private final AutoLinkPreferences

autoLinkPreferences

private final FileFinder

brokenLinkedFileNameBasedFileFinder

private final List<Path>

directories

private final ExternalApplicationsPreferences

externalApplicationsPreferences

private static final Logger

LOGGER

private final FileFinder

preConfiguredFileFinder

Access	Constructor and Description
public	AutoSetFileLinksUtil(BibDatabaseContext databaseContext, ExternalApplicationsPreferences externalApplicationsPreferences, FilePreferences filePreferences, AutoLinkPreferences autoLinkPreferences)
private	AutoSetFileLinksUtil(List<Path> directories, ExternalApplicationsPreferences externalApplicationsPreferences, AutoLinkPreferences autoLinkPreferences)

Access

Constructor and Description

public

AutoSetFileLinksUtil(BibDatabaseContext databaseContext, ExternalApplicationsPreferences externalApplicationsPreferences, FilePreferences filePreferences, AutoLinkPreferences autoLinkPreferences)

private

AutoSetFileLinksUtil(List<Path> directories, ExternalApplicationsPreferences externalApplicationsPreferences, AutoLinkPreferences autoLinkPreferences)

Modifier and Type	Method and Description
private List<LinkedFile>	autoLinkBrokenLinkedFiles(List<LinkedFile> linkedFiles, Map<String, LinkedFile> files)
private LinkedFile	buildLinkedFileFromPath(Path associatedFile)
private String	checkAndGetFileType(Path associatedFile)
private void	doLinkAssociatedFiles(BibEntry entry, BiConsumer<List<LinkedFile>, BibEntry> onAddLinkedFile, AutoSetFileLinksUtil.LinkFilesResult result) Source of associated not linked files: Part A. match file name with CitationKey, (START, EXACT, REGEX) configured by user Part B. match file name with broken linked file names, currently silently happen
private boolean	filesChanged(List<LinkedFile> newLinkedFiles, List<LinkedFile> files)
public Collection<LinkedFile>	findAssociatedNotLinkedFiles(BibEntry entry) Scans for missing files which should be linked to the given entry.
public Collection<LinkedFile>	findAssociatedNotLinkedFilesWithFinder(BibEntry entry, FileFinder finder, List<String> extensions)
private Map<String, LinkedFile>	findAssociatedNotLinkedFilesWithUniqueName(BibEntry entry, FileFinder finder)
private Map<String, LinkedFile>	getAssociatedFiles(BibEntry entry, AutoSetFileLinksUtil.LinkFilesResult result, FileFinder finder)
private List<String>	getConfiguredExtensions()
private boolean	isBrokenLinkedFile(LinkedFile file)
private static boolean	isFileAlreadyLinked(Path foundFile, List<Path> linkedFiles)
public AutoSetFileLinksUtil.LinkFilesResult	linkAssociatedFiles(List<BibEntry> entries, BiConsumer<List<LinkedFile>, BibEntry> onAddLinkedFile) `impl->req~logic.externalfiles.file-transfer.auto-link~1`

Modifier and Type

Method and Description

private List<LinkedFile>

autoLinkBrokenLinkedFiles(List<LinkedFile> linkedFiles, Map<String, LinkedFile> files)

private LinkedFile

buildLinkedFileFromPath(Path associatedFile)

private String

checkAndGetFileType(Path associatedFile)

private void

doLinkAssociatedFiles(BibEntry entry, BiConsumer<List<LinkedFile>, BibEntry> onAddLinkedFile, AutoSetFileLinksUtil.LinkFilesResult result)

Source of associated not linked files:

Part A. match file name with CitationKey, (START, EXACT, REGEX) configured by user
Part B. match file name with broken linked file names, currently silently happen

private boolean

filesChanged(List<LinkedFile> newLinkedFiles, List<LinkedFile> files)

public Collection<LinkedFile>

findAssociatedNotLinkedFiles(BibEntry entry)

Scans for missing files which should be linked to the given entry.

public Collection<LinkedFile>

findAssociatedNotLinkedFilesWithFinder(BibEntry entry, FileFinder finder, List<String> extensions)

private Map<String, LinkedFile>

findAssociatedNotLinkedFilesWithUniqueName(BibEntry entry, FileFinder finder)

private Map<String, LinkedFile>

getAssociatedFiles(BibEntry entry, AutoSetFileLinksUtil.LinkFilesResult result, FileFinder finder)

private List<String>

getConfiguredExtensions()

private boolean

isBrokenLinkedFile(LinkedFile file)

private static boolean

isFileAlreadyLinked(Path foundFile, List<Path> linkedFiles)

public AutoSetFileLinksUtil.LinkFilesResult

linkAssociatedFiles(List<BibEntry> entries, BiConsumer<List<LinkedFile>, BibEntry> onAddLinkedFile)

impl->req~logic.externalfiles.file-transfer.auto-link~1

Field Detail

autoLinkPreferences	back to summary
private final AutoLinkPreferences autoLinkPreferences

autoLinkPreferences

back to summary

private final AutoLinkPreferences autoLinkPreferences

brokenLinkedFileNameBasedFileFinder	back to summary
private final FileFinder brokenLinkedFileNameBasedFileFinder

brokenLinkedFileNameBasedFileFinder

back to summary

private final FileFinder brokenLinkedFileNameBasedFileFinder

directories	back to summary
private final List<Path> directories

directories

back to summary

private final List<Path> directories

externalApplicationsPreferences	back to summary
private final ExternalApplicationsPreferences externalApplicationsPreferences

externalApplicationsPreferences

back to summary

private final ExternalApplicationsPreferences externalApplicationsPreferences

LOGGER	back to summary
private static final Logger LOGGER

LOGGER

back to summary

private static final Logger LOGGER

preConfiguredFileFinder	back to summary
private final FileFinder preConfiguredFileFinder

preConfiguredFileFinder

back to summary

private final FileFinder preConfiguredFileFinder

Constructor Detail

AutoSetFileLinksUtil	back to summary
public AutoSetFileLinksUtil(BibDatabaseContext databaseContext, ExternalApplicationsPreferences externalApplicationsPreferences, FilePreferences filePreferences, AutoLinkPreferences autoLinkPreferences)

AutoSetFileLinksUtil

back to summary

public AutoSetFileLinksUtil(BibDatabaseContext databaseContext, ExternalApplicationsPreferences externalApplicationsPreferences, FilePreferences filePreferences, AutoLinkPreferences autoLinkPreferences)

AutoSetFileLinksUtil	back to summary
private AutoSetFileLinksUtil(List<Path> directories, ExternalApplicationsPreferences externalApplicationsPreferences, AutoLinkPreferences autoLinkPreferences)

AutoSetFileLinksUtil

back to summary

private AutoSetFileLinksUtil(List<Path> directories, ExternalApplicationsPreferences externalApplicationsPreferences, AutoLinkPreferences autoLinkPreferences)

Method Detail

autoLinkBrokenLinkedFiles	back to summary
private List<LinkedFile> autoLinkBrokenLinkedFiles(List<LinkedFile> linkedFiles, Map<String, LinkedFile> files)

buildLinkedFileFromPath	back to summary
private LinkedFile buildLinkedFileFromPath(Path associatedFile)

checkAndGetFileType	back to summary
private String checkAndGetFileType(Path associatedFile)

doLinkAssociatedFiles back to summary

doLinkAssociatedFiles	back to summary
private void doLinkAssociatedFiles(BibEntry entry, BiConsumer<List<LinkedFile>, BibEntry> onAddLinkedFile, AutoSetFileLinksUtil.LinkFilesResult result) Source of associated not linked files: Part A. match file name with CitationKey, (START, EXACT, REGEX) configured by user Part B. match file name with broken linked file names, currently silently happen The auto-link process: Prolog: we only consider the file with a unique name if a file's name is found multiple times in Part A, we do not consider it in Step 1 if a file's name is found multiple times in Part B, we do not consider it in Step 2 Step 1. try to auto link each broken linked file with Part A at first. For unlinked files left in Part A, if no linked file with same name exists, add them why `add`: Part A are found mainly by CitationKey, which has strong connection to the entry, so we are confident that we should add them automatically Step 2. try to auto link each broken linked file with Part B. how about `unlinked files left in Part B`: those files have the same name with one broken linked file but different extension. We skip those files. one trick: we accumulate Part B after Step 1, so Part A does not affect those broken linked files we use to query Part B

private void doLinkAssociatedFiles(BibEntry entry, BiConsumer<List<LinkedFile>, BibEntry> onAddLinkedFile, AutoSetFileLinksUtil.LinkFilesResult result)

Source of associated not linked files:

Part A. match file name with CitationKey, (START, EXACT, REGEX) configured by user
Part B. match file name with broken linked file names, currently silently happen

The auto-link process:

Prolog: we only consider the file with a unique name
- if a file's name is found multiple times in Part A, we do not consider it in Step 1
- if a file's name is found multiple times in Part B, we do not consider it in Step 2
Step 1. try to auto link each broken linked file with Part A at first. For unlinked files left in Part A, if no linked file with same name exists, add them
- why add: Part A are found mainly by CitationKey, which has strong connection to the entry, so we are confident that we should add them automatically
Step 2. try to auto link each broken linked file with Part B.
- how about unlinked files left in Part B: those files have the same name with one broken linked file but different extension. We skip those files.
- one trick: we accumulate Part B after Step 1, so Part A does not affect those broken linked files we use to query Part B

filesChanged	back to summary
private boolean filesChanged(List<LinkedFile> newLinkedFiles, List<LinkedFile> files)

findAssociatedNotLinkedFiles back to summary

findAssociatedNotLinkedFiles	back to summary
public Collection<LinkedFile> findAssociatedNotLinkedFiles(BibEntry entry) throws IOException Scans for missing files which should be linked to the given entry. Related: `org.jabref.gui.externalfiles.UnlinkedFilesCrawler` for scanning files missing at all entries NOTE: This method does not check if the file is already linked to another entry. This method does not guarantee how the returned files are ordered. Order by how they appear in BibEntry does not work since findAssociatedFilesByBrokenLinkedFile may return multiple files (with the same name) for one broken linked file in the entry.

public Collection<LinkedFile> findAssociatedNotLinkedFiles(BibEntry entry) throws IOException

Scans for missing files which should be linked to the given entry.

Related: org.jabref.gui.externalfiles.UnlinkedFilesCrawler for scanning files missing at all entries

NOTE:

This method does not check if the file is already linked to another entry.
This method does not guarantee how the returned files are ordered. Order by how they appear in BibEntry does not work since findAssociatedFilesByBrokenLinkedFile may return multiple files (with the same name) for one broken linked file in the entry.

findAssociatedNotLinkedFilesWithFinder	back to summary
public Collection<LinkedFile> findAssociatedNotLinkedFilesWithFinder(BibEntry entry, FileFinder finder, List<String> extensions) throws IOException

findAssociatedNotLinkedFilesWithUniqueName	back to summary
private Map<String, LinkedFile> findAssociatedNotLinkedFilesWithUniqueName(BibEntry entry, FileFinder finder) throws IOException

getAssociatedFiles	back to summary
private Map<String, LinkedFile> getAssociatedFiles(BibEntry entry, AutoSetFileLinksUtil.LinkFilesResult result, FileFinder finder)

getConfiguredExtensions	back to summary
private List<String> getConfiguredExtensions()

isBrokenLinkedFile	back to summary
private boolean isBrokenLinkedFile(LinkedFile file)

isFileAlreadyLinked	back to summary
private static boolean isFileAlreadyLinked(Path foundFile, List<Path> linkedFiles)

linkAssociatedFiles	back to summary
public AutoSetFileLinksUtil.LinkFilesResult linkAssociatedFiles(List<BibEntry> entries, BiConsumer<List<LinkedFile>, BibEntry> onAddLinkedFile) `impl->req~logic.externalfiles.file-transfer.auto-link~1`

org.jabref.gui.externalfiles back to summary

public Class AutoSetFileLinksUtil.LinkFilesResult

Class Inheritance

extends Object

java.lang.Object
org.jabref.gui.externalfiles.AutoSetFileLinksUtil.LinkFilesResult

Field Summary

Modifier and Type	Field and Description
private final List<BibEntry>	changedEntries
private final List<IOException>	fileExceptions

Constructor Summary

Access	Constructor and Description
public	LinkFilesResult()

Method Summary

Modifier and Type	Method and Description
protected void	addBibEntry(BibEntry bibEntry)
protected void	addFileException(IOException exception)
public List<BibEntry>	getChangedEntries()
public List<IOException>	getFileExceptions()

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

Field Detail

changedEntries	back to summary
private final List<BibEntry> changedEntries

fileExceptions	back to summary
private final List<IOException> fileExceptions

Constructor Detail

LinkFilesResult	back to summary
public LinkFilesResult()

Method Detail

addBibEntry	back to summary
protected void addBibEntry(BibEntry bibEntry)

addFileException	back to summary
protected void addFileException(IOException exception)

getChangedEntries	back to summary
public List<BibEntry> getChangedEntries()

getFileExceptions	back to summary
public List<IOException> getFileExceptions()

public Class AutoSetFileLinksUtil

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AutoSetFileLinksUtil.LinkFilesResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail