Verified Owner
Top Inners Fields Constructors Methods
org.jabref.gui.preferences.websearch

public Class WebSearchTabViewModel

extends Object
implements PreferenceTabViewModel
Class Inheritance
All Implemented Interfaces
org.jabref.gui.preferences.PreferenceTabViewModel
Imports
java.util.Comparator, .HashSet, .List, .Map, .Set, java.util.concurrent.Callable, java.util.function.Consumer, java.util.stream.Collectors, javafx.beans.property.BooleanProperty, .IntegerProperty, .ListProperty, .ObjectProperty, .ReadOnlyBooleanProperty, .SimpleBooleanProperty, .SimpleIntegerProperty, .SimpleListProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, javafx.collections.FXCollections, .ObservableList, org.jabref.gui.preferences.PreferenceTabViewModel, org.jabref.logic.FilePreferences, .LibraryPreferences, org.jabref.logic.importer.ImportFormatPreferences, .ImporterPreferences, .SearchBasedFetcher, .WebFetcher, .WebFetchers, org.jabref.logic.importer.fetcher.CompositeSearchBasedFetcher, .CustomizableKeyFetcher, org.jabref.logic.importer.plaincitation.PlainCitationParserChoice, org.jabref.logic.importer.util.GrobidPreferences, org.jabref.logic.l10n.Localization, org.jabref.logic.os.OS, org.jabref.logic.preferences.DOIPreferences, .FetcherApiKey, org.jabref.logic.util.BackgroundTask, .TaskExecutor

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final BooleanProperty
private final StringProperty
private final BooleanProperty
private final BooleanProperty
private final IntegerProperty
private final ObjectProperty<PlainCitationParserChoice>
private final DOIPreferences
private final BooleanProperty
private final ObservableList<WebSearchTabViewModel.FetcherViewModel>
private final FilePreferences
private final BooleanProperty
private final GrobidPreferences
private final StringProperty
private final ImporterPreferences
private final ImportFormatPreferences
private final LibraryPreferences
private final ListProperty<PlainCitationParserChoice>
private final ReadOnlyBooleanProperty
private final ObservableList<SearchEngineItem>
private final BooleanProperty
private final BooleanProperty
private final TaskExecutor
private final StringProperty
private final BooleanProperty
private final BooleanProperty

Constructor Summary

AccessConstructor and Description
public
WebSearchTabViewModel(ImporterPreferences importerPreferences, GrobidPreferences grobidPreferences, DOIPreferences doiPreferences, FilePreferences filePreferences, ImportFormatPreferences importFormatPreferences, LibraryPreferences libraryPreferences, ReadOnlyBooleanProperty refAiEnabled, TaskExecutor taskExecutor)

Method Summary

Modifier and TypeMethod and Description
public ReadOnlyBooleanProperty
public void
public IntegerProperty
public ObjectProperty<PlainCitationParserChoice>
public BooleanProperty
public BooleanProperty
public StringProperty
public BooleanProperty
public ObservableList<WebSearchTabViewModel.FetcherViewModel>
public ObservableList<SearchEngineItem>
public BooleanProperty
public StringProperty
public ListProperty<PlainCitationParserChoice>
private void
private void
public void
setValues()

Implements org.jabref.gui.preferences.PreferenceTabViewModel.setValues.

This method is called when the dialog is opened, or if it is made visible after being hidden.

public BooleanProperty
public BooleanProperty
public void
storeSettings()

Implements org.jabref.gui.preferences.PreferenceTabViewModel.storeSettings.

This method is called when the user presses OK in the Preferences dialog.

public StringProperty
public BooleanProperty
public boolean
validateSettings()

Overrides default org.jabref.gui.preferences.PreferenceTabViewModel.validateSettings.

This method is called before the storeSettings() method, to check if there are illegal settings in the tab, or if is ready to be closed.

public BooleanProperty
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

addImportedEntriesback to summary
private final BooleanProperty addImportedEntries
addImportedEntriesGroupNameback to summary
private final StringProperty addImportedEntriesGroupName
apikeyPersistAvailablePropertyback to summary
private final BooleanProperty apikeyPersistAvailableProperty
apikeyPersistPropertyback to summary
private final BooleanProperty apikeyPersistProperty
citationsRelationStoreTTLback to summary
private final IntegerProperty citationsRelationStoreTTL
defaultPlainCitationParserback to summary
private final ObjectProperty<PlainCitationParserChoice> defaultPlainCitationParser
doiPreferencesback to summary
private final DOIPreferences doiPreferences
enableWebSearchPropertyback to summary
private final BooleanProperty enableWebSearchProperty
fetchersback to summary
private final ObservableList<WebSearchTabViewModel.FetcherViewModel> fetchers
filePreferencesback to summary
private final FilePreferences filePreferences
grobidEnabledPropertyback to summary
private final BooleanProperty grobidEnabledProperty
grobidPreferencesback to summary
private final GrobidPreferences grobidPreferences
grobidURLPropertyback to summary
private final StringProperty grobidURLProperty
importerPreferencesback to summary
private final ImporterPreferences importerPreferences
importFormatPreferencesback to summary
private final ImportFormatPreferences importFormatPreferences
libraryPreferencesback to summary
private final LibraryPreferences libraryPreferences
plainCitationParsersback to summary
private final ListProperty<PlainCitationParserChoice> plainCitationParsers
refAiEnabledback to summary
private final ReadOnlyBooleanProperty refAiEnabled
searchEnginesback to summary
private final ObservableList<SearchEngineItem> searchEngines
shouldDownloadLinkedOnlineFilesback to summary
private final BooleanProperty shouldDownloadLinkedOnlineFiles
shouldKeepDownloadUrlback to summary
private final BooleanProperty shouldKeepDownloadUrl
taskExecutorback to summary
private final TaskExecutor taskExecutor
useCustomDOINamePropertyback to summary
private final StringProperty useCustomDOINameProperty
useCustomDOIPropertyback to summary
private final BooleanProperty useCustomDOIProperty
warnAboutDuplicatesOnImportPropertyback to summary
private final BooleanProperty warnAboutDuplicatesOnImportProperty

Constructor Detail

WebSearchTabViewModelback to summary
public WebSearchTabViewModel(ImporterPreferences importerPreferences, GrobidPreferences grobidPreferences, DOIPreferences doiPreferences, FilePreferences filePreferences, ImportFormatPreferences importFormatPreferences, LibraryPreferences libraryPreferences, ReadOnlyBooleanProperty refAiEnabled, TaskExecutor taskExecutor)

Method Detail

apiKeyPersistAvailableback to summary
public ReadOnlyBooleanProperty apiKeyPersistAvailable()
checkApiKeyback to summary
public void checkApiKey(WebSearchTabViewModel.FetcherViewModel fetcherViewModel, String apiKey, Consumer<Boolean> onFinished)
citationsRelationsStoreTTLPropertyback to summary
public IntegerProperty citationsRelationsStoreTTLProperty()
defaultPlainCitationParserPropertyback to summary
public ObjectProperty<PlainCitationParserChoice> defaultPlainCitationParserProperty()
enableWebSearchPropertyback to summary
public BooleanProperty enableWebSearchProperty()
getAddImportedEntriesback to summary
public BooleanProperty getAddImportedEntries()
getAddImportedEntriesGroupNameback to summary
public StringProperty getAddImportedEntriesGroupName()
getApikeyPersistPropertyback to summary
public BooleanProperty getApikeyPersistProperty()
getFetchersback to summary
public ObservableList<WebSearchTabViewModel.FetcherViewModel> getFetchers()
getSearchEnginesback to summary
public ObservableList<SearchEngineItem> getSearchEngines()
grobidEnabledPropertyback to summary
public BooleanProperty grobidEnabledProperty()
grobidURLPropertyback to summary
public StringProperty grobidURLProperty()
plainCitationParsersback to summary
public ListProperty<PlainCitationParserChoice> plainCitationParsers()
setupPlainCitationParsersback to summary
private void setupPlainCitationParsers()
setupSearchEnginesback to summary
private void setupSearchEngines()
setValuesback to summary
public void setValues()

Implements org.jabref.gui.preferences.PreferenceTabViewModel.setValues.

Doc from org.jabref.gui.preferences.PreferenceTabViewModel.setValues.

This method is called when the dialog is opened, or if it is made visible after being hidden. The tab should update all its values.

This is the ONLY PLACE to set values for the fields in the tab. It is ILLEGAL to set values only at construction time, because the dialog will be reused and updated.

Annotations
@Override
shouldDownloadLinkedOnlineFilesback to summary
public BooleanProperty shouldDownloadLinkedOnlineFiles()
shouldKeepDownloadUrlback to summary
public BooleanProperty shouldKeepDownloadUrl()
storeSettingsback to summary
public void storeSettings()

Implements org.jabref.gui.preferences.PreferenceTabViewModel.storeSettings.

Doc from org.jabref.gui.preferences.PreferenceTabViewModel.storeSettings.

This method is called when the user presses OK in the Preferences dialog. Implementing classes must make sure all settings presented get stored in PreferencesService.

Annotations
@Override
useCustomDOINamePropertyback to summary
public StringProperty useCustomDOINameProperty()
useCustomDOIPropertyback to summary
public BooleanProperty useCustomDOIProperty()
validateSettingsback to summary
public boolean validateSettings()

Overrides default org.jabref.gui.preferences.PreferenceTabViewModel.validateSettings.

Doc from org.jabref.gui.preferences.PreferenceTabViewModel.validateSettings.

This method is called before the storeSettings() method, to check if there are illegal settings in the tab, or if is ready to be closed. If the tab is not ready, it should display a message to the user informing about the illegal setting.

Annotations
@Override
warnAboutDuplicatesOnImportPropertyback to summary
public BooleanProperty warnAboutDuplicatesOnImportProperty()
org.jabref.gui.preferences.websearch back to summary

public Class WebSearchTabViewModel.FetcherViewModel

extends Object
Class Inheritance
  • java.lang.Object
  • org.jabref.gui.preferences.websearch.WebSearchTabViewModel.FetcherViewModel

Field Summary

Modifier and TypeField and Description
private final StringProperty
private final BooleanProperty
private final BooleanProperty
private final WebFetcher
private final StringProperty
private final BooleanProperty

Constructor Summary

AccessConstructor and Description
public
FetcherViewModel(WebFetcher fetcher, boolean enabled, boolean customizable)

Method Summary

Modifier and TypeMethod and Description
public StringProperty
public BooleanProperty
public BooleanProperty
public String
public WebFetcher
public String
public boolean
public boolean
public StringProperty
public boolean
public BooleanProperty
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

apiKeyback to summary
private final StringProperty apiKey
customizableback to summary
private final BooleanProperty customizable
enabledback to summary
private final BooleanProperty enabled
fetcherback to summary
private final WebFetcher fetcher
nameback to summary
private final StringProperty name
useCustomApiKeyback to summary
private final BooleanProperty useCustomApiKey

Constructor Detail

FetcherViewModelback to summary
public FetcherViewModel(WebFetcher fetcher, boolean enabled, boolean customizable)

Method Detail

apiKeyPropertyback to summary
public StringProperty apiKeyProperty()
customizablePropertyback to summary
public BooleanProperty customizableProperty()
enabledPropertyback to summary
public BooleanProperty enabledProperty()
getApiKeyback to summary
public String getApiKey()
getFetcherback to summary
public WebFetcher getFetcher()
getNameback to summary
public String getName()
isCustomizableback to summary
public boolean isCustomizable()
isEnabledback to summary
public boolean isEnabled()
namePropertyback to summary
public StringProperty nameProperty()
shouldUseCustomApiKeyback to summary
public boolean shouldUseCustomApiKey()
useCustomApiKeyPropertyback to summary
public BooleanProperty useCustomApiKeyProperty()