Verified Owner
Top Description Methods
org.jabref.logic.importer

public Interface SearchBasedFetcher

extends WebFetcher
Known Direct Subinterfaces
org.jabref.logic.importer.SearchBasedParserFetcher, org.jabref.logic.importer.PagedSearchBasedFetcher
Known Direct Implementers
org.jabref.logic.importer.fetcher.CompositeSearchBasedFetcher, org.jabref.logic.importer.fetcher.MedlineFetcher, org.jabref.logic.importer.fetcher.ResearchGate, org.jabref.logic.importer.fetcher.UnpaywallFetcher
Annotations
@NullMarked
Imports
java.util.List, .Optional, org.jabref.logic.search.query.SearchQueryVisitor, org.jabref.model.entry.BibEntry, org.jabref.model.search.query.BaseQueryNode, .SearchQuery, .SearchQueryNode, org.antlr.v4.runtime.misc.ParseCancellationException, org.jspecify.annotations.NullMarked, org.slf4j.Logger, .LoggerFactory
Searches web resources for bibliographic information based on a free-text query. May return multiple search hits.

This interface is used for web resources which directly return BibTeX data (BibEntry)

Method Summary

Modifier and TypeMethod and Description
public static BaseQueryNode
getQueryNode(String searchQuery)

This method provides a BaseQueryNode for performSearch/performSearchPaged method

public default List<BibEntry>
performRawSearchQuery(String rawQuery)

public List<BibEntry>

Returns:

a list of BibEntry, which are matched by the query (may be empty)
performSearch(BaseQueryNode
the list that contains the parsed nodes
queryList)

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

public default List<BibEntry>

Returns:

a list of BibEntry, which are matched by the query (may be empty)
performSearch(String
query string that can be parsed into a search query
searchQuery)

Looks for hits which are matched by the given free-text query.

Inherited from org.jabref.logic.importer.WebFetcher:
getHelpPagegetNamegetUrlDownload

Method Detail

getQueryNodeback to summary
public static BaseQueryNode getQueryNode(String searchQuery)

This method provides a BaseQueryNode for performSearch/performSearchPaged method

performRawSearchQueryback to summary
public default List<BibEntry> performRawSearchQuery(String rawQuery) throws FetcherException
performSearchback to summary
public List<BibEntry> performSearch(BaseQueryNode queryList) throws FetcherException

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

Parameters
queryList:BaseQueryNode

the list that contains the parsed nodes

Returns:List<BibEntry>

a list of BibEntry, which are matched by the query (may be empty)

performSearchback to summary
public default List<BibEntry> performSearch(String searchQuery) throws FetcherException

Looks for hits which are matched by the given free-text query.

Parameters
searchQuery:String

query string that can be parsed into a search query

Returns:List<BibEntry>

a list of BibEntry, which are matched by the query (may be empty)