Verified Owner
Top Methods
org.jabref.logic.importer

public Interface PagedSearchBasedParserFetcher

extends SearchBasedParserFetcher, PagedSearchBasedFetcher, ParserFetcher
Known Direct Implementers
org.jabref.logic.importer.fetcher.AstrophysicsDataSystem, org.jabref.logic.importer.fetcher.BaseSearchFetcher, org.jabref.logic.importer.fetcher.DnbFetcher, org.jabref.logic.importer.fetcher.IEEE, org.jabref.logic.importer.fetcher.ISIDOREFetcher, org.jabref.logic.importer.fetcher.LOBIDFetcher, org.jabref.logic.importer.fetcher.ScholarArchiveFetcher, org.jabref.logic.importer.fetcher.Scopus, org.jabref.logic.importer.fetcher.SemanticScholar, org.jabref.logic.importer.fetcher.SpringerNatureWebFetcher
Imports
java.io.IOException, .InputStream, java.net.MalformedURLException, .URISyntaxException, .URL, java.util.List, org.jabref.model.entry.BibEntry, org.jabref.model.paging.Page, org.jabref.model.search.query.BaseQueryNode

Method Summary

Modifier and TypeMethod and Description
private List<BibEntry>
getBibEntries(URL urlForQuery)

Redeclares private: org.jabref.logic.importer.SearchBasedParserFetcher.getBibEntries.

public URL
getURLForQuery(BaseQueryNode
the first search node
queryNode, int
the number of the page indexed from 0
pageNumber)

Constructs a URL based on the query, size and page number.

public default URL
getURLForQuery(BaseQueryNode queryNode)

Implements org.jabref.logic.importer.SearchBasedParserFetcher.getURLForQuery.

Constructs a URL based on the lucene query.

public default URL
getURLForRawQuery(String
catalog-native query string sent verbatim to the catalog
rawQuery, int
requested page number indexed from 0
pageNumber)

Constructs a URL that sends the raw, catalog-native query verbatim to the catalog (bypassing the query transformer).

public default List<BibEntry>
performRawSearchQuery(String rawQuery)

Overrides default org.jabref.logic.importer.SearchBasedParserFetcher.performRawSearchQuery, org.jabref.logic.importer.PagedSearchBasedFetcher.performRawSearchQuery.

Resolves the diamond inheritance of performRawSearchQuery: this interface inherits one default from SearchBasedParserFetcher (single-page, via getURLForRawQuery) and another from PagedSearchBasedFetcher (paged, via performRawSearchQueryPaged).

public default Page<BibEntry>
performRawSearchQueryPaged(String rawQuery, int pageNumber)

Overrides default org.jabref.logic.importer.PagedSearchBasedFetcher.performRawSearchQueryPaged.

Default implementation: builds the URL via getURLForRawQuery(String, int), then downloads, parses, and post-cleans the result.

public default List<BibEntry>
performSearch(BaseQueryNode queryNode)

Overrides default org.jabref.logic.importer.SearchBasedParserFetcher.performSearch, org.jabref.logic.importer.PagedSearchBasedFetcher.performSearch.

This method is used to send queries with advanced URL parameters.

public default Page<BibEntry>
performSearchPaged(BaseQueryNode queryNode, int pageNumber)

Implements org.jabref.logic.importer.PagedSearchBasedFetcher.performSearchPaged.

Inherited from org.jabref.logic.importer.PagedSearchBasedFetcher:
getPageSizeperformSearchPaged
Inherited from org.jabref.logic.importer.ParserFetcher:
doPostCleanup
Inherited from org.jabref.logic.importer.SearchBasedParserFetcher:
getParsergetURLForRawQuery

Method Detail

getBibEntriesback to summary
private List<BibEntry> getBibEntries(URL urlForQuery) throws FetcherException

Redeclares private: org.jabref.logic.importer.SearchBasedParserFetcher.getBibEntries.

getURLForQueryback to summary
public URL getURLForQuery(BaseQueryNode queryNode, int pageNumber) throws URISyntaxException, MalformedURLException

Constructs a URL based on the query, size and page number.

Parameters
queryNode:BaseQueryNode

the first search node

pageNumber:int

the number of the page indexed from 0

getURLForQueryback to summary
public default URL getURLForQuery(BaseQueryNode queryNode) throws URISyntaxException, MalformedURLException

Implements org.jabref.logic.importer.SearchBasedParserFetcher.getURLForQuery.

Doc from org.jabref.logic.importer.SearchBasedParserFetcher.getURLForQuery.

Constructs a URL based on the lucene query.

Annotations
@Override
getURLForRawQueryback to summary
public default URL getURLForRawQuery(String rawQuery, int pageNumber) throws URISyntaxException, MalformedURLException, FetcherException

Constructs a URL that sends the raw, catalog-native query verbatim to the catalog (bypassing the query transformer).

Parameters
rawQuery:String

catalog-native query string sent verbatim to the catalog

pageNumber:int

requested page number indexed from 0

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

Overrides default org.jabref.logic.importer.SearchBasedParserFetcher.performRawSearchQuery, org.jabref.logic.importer.PagedSearchBasedFetcher.performRawSearchQuery.

Resolves the diamond inheritance of performRawSearchQuery: this interface inherits one default from SearchBasedParserFetcher (single-page, via getURLForRawQuery) and another from PagedSearchBasedFetcher (paged, via performRawSearchQueryPaged). Paged fetchers implement the paged hook, so we route through the paged default.

Annotations
@Override
performRawSearchQueryPagedback to summary
public default Page<BibEntry> performRawSearchQueryPaged(String rawQuery, int pageNumber) throws FetcherException

Overrides default org.jabref.logic.importer.PagedSearchBasedFetcher.performRawSearchQueryPaged.

Default implementation: builds the URL via getURLForRawQuery(String, int), then downloads, parses, and post-cleans the result.

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

Overrides default org.jabref.logic.importer.SearchBasedParserFetcher.performSearch, org.jabref.logic.importer.PagedSearchBasedFetcher.performSearch.

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

This method is used to send queries with advanced URL parameters. This method is necessary as the performSearch method does not support certain URL parameters that are used for fielded search, such as a title, author, or year parameter.

Annotations
@Override
performSearchPagedback to summary
public default Page<BibEntry> performSearchPaged(BaseQueryNode queryNode, int pageNumber) throws FetcherException

Implements org.jabref.logic.importer.PagedSearchBasedFetcher.performSearchPaged.

Annotations
@Override