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

public Class CompositeSearchBasedFetcher

extends Object
implements SearchBasedFetcher
Class Inheritance
All Implemented Interfaces
org.jabref.logic.importer.SearchBasedFetcher, org.jabref.logic.importer.WebFetcher
Imports
java.util.Collection, .List, .Optional, .Set, java.util.stream.Stream, org.jabref.logic.help.HelpFile, org.jabref.logic.importer.FetcherException, .ImporterPreferences, .SearchBasedFetcher, org.jabref.model.entry.BibEntry, org.jabref.model.search.query.BaseQueryNode, org.jspecify.annotations.NullMarked, org.slf4j.Logger, .LoggerFactory
Implements "search-pre configured"

Field Summary

Modifier and TypeField and Description
public static final String
FETCHER_NAME

private final ImporterPreferences
importerPreferences

private static final Logger
LOGGER

private final int
maximumNumberOfReturnedResults

private final Set<SearchBasedFetcher>
searchBasedFetchers

Constructor Summary

AccessConstructor and Description
public
CompositeSearchBasedFetcher(Set<SearchBasedFetcher>
all available search-based fetchers
searchBasedFetchers, ImporterPreferences importerPreferences, int maximumNumberOfReturnedResults)

Method Summary

Modifier and TypeMethod and Description
public Optional<HelpFile>
getHelpPage()

Overrides default org.jabref.logic.importer.WebFetcher.getHelpPage.

Returns the help page for this fetcher.

public String
getName()

Implements org.jabref.logic.importer.WebFetcher.getName.

Returns the localized name of this fetcher.

public List<BibEntry>
performSearch(BaseQueryNode queryList)

Implements org.jabref.logic.importer.SearchBasedFetcher.performSearch.

This method is used to send complex queries using fielded search.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

FETCHER_NAMEback to summary
public static final String FETCHER_NAME
importerPreferencesback to summary
private final ImporterPreferences importerPreferences
LOGGERback to summary
private static final Logger LOGGER
maximumNumberOfReturnedResultsback to summary
private final int maximumNumberOfReturnedResults
searchBasedFetchersback to summary
private final Set<SearchBasedFetcher> searchBasedFetchers

Constructor Detail

CompositeSearchBasedFetcherback to summary
public CompositeSearchBasedFetcher(Set<SearchBasedFetcher> searchBasedFetchers, ImporterPreferences importerPreferences, int maximumNumberOfReturnedResults)
Parameters
searchBasedFetchers:Set<SearchBasedFetcher>

all available search-based fetchers

Annotations
@NullMarked

Method Detail

getHelpPageback to summary
public Optional<HelpFile> getHelpPage()

Overrides default org.jabref.logic.importer.WebFetcher.getHelpPage.

Doc from org.jabref.logic.importer.WebFetcher.getHelpPage.

Returns the help page for this fetcher.

Annotations
@Override
getNameback to summary
public String getName()

Implements org.jabref.logic.importer.WebFetcher.getName.

Doc from org.jabref.logic.importer.WebFetcher.getName.

Returns the localized name of this fetcher. The title can be used to display the fetcher in the menu and in the side pane.

Todo

This name is also used for identifying the fetcher in preferences for API keys. Thus, any switch of the language will "remove" API keys.

Annotations
@Override
performSearchback to summary
public List<BibEntry> performSearch(BaseQueryNode queryList) throws FetcherException

Implements org.jabref.logic.importer.SearchBasedFetcher.performSearch.

Doc from org.jabref.logic.importer.SearchBasedFetcher.performSearch.

This method is used to send complex queries using fielded search.

Annotations
@Override