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

public Class ImporterPreferences

extends Object
Class Inheritance
Imports
java.nio.file.Path, java.util.HashMap, .HashSet, .List, .Map, .Optional, .Set, javafx.beans.property.BooleanProperty, .IntegerProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleIntegerProperty, .SimpleObjectProperty, javafx.collections.FXCollections, .ObservableList, .ObservableSet, org.jabref.logic.importer.fetcher.ACMPortalFetcher, .AstrophysicsDataSystem, .BiodiversityLibrary, .CrossRef, .DBLPFetcher, .IEEE, .ScholarFetcher, .Scopus, .SpringerNatureWebFetcher, .WileyFetcher, org.jabref.logic.importer.fetcher.citation.semanticscholar.SemanticScholarCitationFetcher, org.jabref.logic.importer.fileformat.CustomImporter, org.jabref.logic.importer.plaincitation.PlainCitationParserChoice, org.jabref.logic.preferences.FetcherApiKey, org.jabref.logic.util.BuildInfo, .Directories, org.jabref.logic.util.strings.StringUtil

Field Summary

Modifier and TypeField and Description
private final ObservableSet<FetcherApiKey>
apiKeys

private final ObservableList<String>
catalogs

private final IntegerProperty
citationsRelationsStoreTTL

private final ObservableSet<CustomImporter>
customImporters

private final ObjectProperty<PlainCitationParserChoice>
defaultPlainCitationParser

private final BooleanProperty
generateNewKeyOnImport

private final BooleanProperty
importerEnabled

private final ObjectProperty<Path>
importWorkingDirectory

private final BooleanProperty
persistCustomKeys

private final Map<String, String>
searchEngineUrlTemplates

private final BooleanProperty
warnAboutDuplicatesOnImport

Constructor Summary

AccessConstructor and Description
private
ImporterPreferences()

public
ImporterPreferences(boolean importerEnabled, boolean generateNewKeyOnImport, Path importWorkingDirectory, boolean warnAboutDuplicatesOnImport, Set<CustomImporter> customImporters, Set<FetcherApiKey> apiKeys, boolean persistCustomKeys, List<String> catalogs, PlainCitationParserChoice defaultPlainCitationParser, int citationsRelationsStoreTTL, Map<String, String> searchEngineUrlTemplates)

Method Summary

Modifier and TypeMethod and Description
public boolean
areImporterEnabled()

public IntegerProperty
citationsRelationsStoreTTLProperty()

public ObjectProperty<PlainCitationParserChoice>
defaultPlainCitationParserProperty()

public BooleanProperty
generateNewKeyOnImportProperty()

public Optional<String>
getApiKey(String
of the fetcher
name)

Returns: the configured or default API key; a blank key is treated as absent.

public ObservableSet<FetcherApiKey>
getApiKeys()

public ObservableList<String>
getCatalogs()

public int
getCitationsRelationsStoreTTL()

public ObservableSet<CustomImporter>
getCustomImporters()

public static ImporterPreferences
getDefault()

private static Map<String, String>
getDefaultFetcherKeys()

public PlainCitationParserChoice
getDefaultPlainCitationParser()

public Path
getImportWorkingDirectory()

public Map<String, String>
getSearchEngineUrlTemplates()

public BooleanProperty
importerEnabledProperty()

public ObjectProperty<Path>
importWorkingDirectoryProperty()

public BooleanProperty
persistCustomKeysProperty()

public void
setApiKeys(Set<FetcherApiKey> apiKeys)

public void
setCatalogs(List<String> catalogs)

public void
setCitationsRelationsStoreTTL(int citationsRelationsStoreTTL)

public void
setCustomImporters(Set<CustomImporter> importers)

public void
setDefaultPlainCitationParser(PlainCitationParserChoice defaultPlainCitationParser)

public void
setGenerateNewKeyOnImport(boolean generateNewKeyOnImport)

public void
setImporterEnabled(boolean importerEnabled)

public void
setImportWorkingDirectory(Path importWorkingDirectory)

public void
setPersistCustomKeys(boolean persistCustomKeys)

public void
setSearchEngineUrlTemplates(Map<String, String> templates)

public void
setWarnAboutDuplicatesOnImport(boolean warnAboutDuplicatesOnImport)

public boolean
shouldGenerateNewKeyOnImport()

public boolean
shouldPersistCustomKeys()

public boolean
shouldWarnAboutDuplicatesOnImport()

public BooleanProperty
warnAboutDuplicatesOnImportProperty()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

apiKeysback to summary
private final ObservableSet<FetcherApiKey> apiKeys
catalogsback to summary
private final ObservableList<String> catalogs
citationsRelationsStoreTTLback to summary
private final IntegerProperty citationsRelationsStoreTTL
customImportersback to summary
private final ObservableSet<CustomImporter> customImporters
defaultPlainCitationParserback to summary
private final ObjectProperty<PlainCitationParserChoice> defaultPlainCitationParser
generateNewKeyOnImportback to summary
private final BooleanProperty generateNewKeyOnImport
importerEnabledback to summary
private final BooleanProperty importerEnabled
importWorkingDirectoryback to summary
private final ObjectProperty<Path> importWorkingDirectory
persistCustomKeysback to summary
private final BooleanProperty persistCustomKeys
searchEngineUrlTemplatesback to summary
private final Map<String, String> searchEngineUrlTemplates
warnAboutDuplicatesOnImportback to summary
private final BooleanProperty warnAboutDuplicatesOnImport

Constructor Detail

ImporterPreferencesback to summary
private ImporterPreferences()
ImporterPreferencesback to summary
public ImporterPreferences(boolean importerEnabled, boolean generateNewKeyOnImport, Path importWorkingDirectory, boolean warnAboutDuplicatesOnImport, Set<CustomImporter> customImporters, Set<FetcherApiKey> apiKeys, boolean persistCustomKeys, List<String> catalogs, PlainCitationParserChoice defaultPlainCitationParser, int citationsRelationsStoreTTL, Map<String, String> searchEngineUrlTemplates)

Method Detail

areImporterEnabledback to summary
public boolean areImporterEnabled()
citationsRelationsStoreTTLPropertyback to summary
public IntegerProperty citationsRelationsStoreTTLProperty()
defaultPlainCitationParserPropertyback to summary
public ObjectProperty<PlainCitationParserChoice> defaultPlainCitationParserProperty()
generateNewKeyOnImportPropertyback to summary
public BooleanProperty generateNewKeyOnImportProperty()
getApiKeyback to summary
public Optional<String> getApiKey(String name)

Implementation Note

See fetchers.md for general information on fetchers.

Parameters
name:String

of the fetcher

Returns:Optional<String>

the configured or default API key; a blank key is treated as absent.

getApiKeysback to summary
public ObservableSet<FetcherApiKey> getApiKeys()
getCatalogsback to summary
public ObservableList<String> getCatalogs()
getCitationsRelationsStoreTTLback to summary
public int getCitationsRelationsStoreTTL()
getCustomImportersback to summary
public ObservableSet<CustomImporter> getCustomImporters()
getDefaultback to summary
public static ImporterPreferences getDefault()
getDefaultFetcherKeysback to summary
private static Map<String, String> getDefaultFetcherKeys()
getDefaultPlainCitationParserback to summary
public PlainCitationParserChoice getDefaultPlainCitationParser()
getImportWorkingDirectoryback to summary
public Path getImportWorkingDirectory()
getSearchEngineUrlTemplatesback to summary
public Map<String, String> getSearchEngineUrlTemplates()
importerEnabledPropertyback to summary
public BooleanProperty importerEnabledProperty()
importWorkingDirectoryPropertyback to summary
public ObjectProperty<Path> importWorkingDirectoryProperty()
persistCustomKeysPropertyback to summary
public BooleanProperty persistCustomKeysProperty()
setApiKeysback to summary
public void setApiKeys(Set<FetcherApiKey> apiKeys)
setCatalogsback to summary
public void setCatalogs(List<String> catalogs)
setCitationsRelationsStoreTTLback to summary
public void setCitationsRelationsStoreTTL(int citationsRelationsStoreTTL)
setCustomImportersback to summary
public void setCustomImporters(Set<CustomImporter> importers)
setDefaultPlainCitationParserback to summary
public void setDefaultPlainCitationParser(PlainCitationParserChoice defaultPlainCitationParser)
setGenerateNewKeyOnImportback to summary
public void setGenerateNewKeyOnImport(boolean generateNewKeyOnImport)
setImporterEnabledback to summary
public void setImporterEnabled(boolean importerEnabled)
setImportWorkingDirectoryback to summary
public void setImportWorkingDirectory(Path importWorkingDirectory)
setPersistCustomKeysback to summary
public void setPersistCustomKeys(boolean persistCustomKeys)
setSearchEngineUrlTemplatesback to summary
public void setSearchEngineUrlTemplates(Map<String, String> templates)
setWarnAboutDuplicatesOnImportback to summary
public void setWarnAboutDuplicatesOnImport(boolean warnAboutDuplicatesOnImport)
shouldGenerateNewKeyOnImportback to summary
public boolean shouldGenerateNewKeyOnImport()
shouldPersistCustomKeysback to summary
public boolean shouldPersistCustomKeys()
shouldWarnAboutDuplicatesOnImportback to summary
public boolean shouldWarnAboutDuplicatesOnImport()
warnAboutDuplicatesOnImportPropertyback to summary
public BooleanProperty warnAboutDuplicatesOnImportProperty()