Modifier and Type	Class and Description
private static record	ScholarFetcher.PageKey
private static enum	ScholarFetcher.SearchEndpoint

Modifier and Type	Field and Description
private final Map<ScholarFetcher.PageKey, String>	cursorCacheMap
public static final String	FETCHER_NAME
private final ImporterPreferences	importerPreferences
private static final Pattern	JOURNAL_ISSUE_NUMBER
private static final Pattern	JOURNAL_VOLUME
private static final String	LIST_URL
private static final Logger	LOGGER
private static final int	NO_YEAR_BOUND
private static final String	PDF_URL
private static final String	SEARCH_URL

Access	Constructor and Description
public	ScholarFetcher(ImporterPreferences importerPreferences)

Method Summary

Modifier and Type	Method and Description
private URL	buildSearchUrl(ScholarFetcher.SearchEndpoint endpoint, String query, int pageNumber, Optional<Integer> startYear, Optional<Integer> endYear)
private kong.unirest.core.json.JSONObject	callApi(URL url)
private Page<BibEntry>	fetchPage(String query, int pageNumber, Optional<Integer> startYear, Optional<Integer> endYear)
public Optional<URL>	findFullText(BibEntry entry)
private Optional<String>	getApiKey()
public Map<String, String>	getDownloadHeaders() Overrides default org.jabref.logic.importer.FulltextFetcher.getDownloadHeaders. Returns HTTP headers required for downloading the PDF returned by `findFullText`.
public String	getName() Implements org.jabref.logic.importer.WebFetcher.getName. Returns the localized name of this fetcher.
private URL	getTestUrl()
public TrustLevel	getTrustLevel() Implements org.jabref.logic.importer.FulltextFetcher.getTrustLevel. Returns the level of trust for this fetcher.
public boolean	isValidKey(String apiKey) Overrides default org.jabref.logic.importer.fetcher.CustomizableKeyFetcher.isValidKey. Returns whether the API key is valid
public static BibEntry	Returns: the converted BibEntry jsonItemToBibEntry(kong.unirest.core.json.JSONObject the JSONObject from search results scholarJsonEntry) Convert a JSONObject obtained from the Scholar API to a BibEntry
public Page<BibEntry>	performRawSearchQueryPaged(String rawQuery, int pageNumber) Overrides default org.jabref.logic.importer.PagedSearchBasedFetcher.performRawSearchQueryPaged.
public Page<BibEntry>	performSearchPaged(BaseQueryNode queryNode, int pageNumber) Implements org.jabref.logic.importer.PagedSearchBasedFetcher.performSearchPaged.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cursorCacheMap	back to summary
private final Map<ScholarFetcher.PageKey, String> cursorCacheMap

FETCHER_NAME	back to summary
public static final String FETCHER_NAME

importerPreferences	back to summary
private final ImporterPreferences importerPreferences

JOURNAL_ISSUE_NUMBER	back to summary
private static final Pattern JOURNAL_ISSUE_NUMBER

JOURNAL_VOLUME	back to summary
private static final Pattern JOURNAL_VOLUME

LIST_URL	back to summary
private static final String LIST_URL

LOGGER	back to summary
private static final Logger LOGGER

NO_YEAR_BOUND	back to summary
private static final int NO_YEAR_BOUND

PDF_URL	back to summary
private static final String PDF_URL

SEARCH_URL	back to summary
private static final String SEARCH_URL

ScholarFetcher	back to summary
public ScholarFetcher(ImporterPreferences importerPreferences)

Method Detail

buildSearchUrl	back to summary
private URL buildSearchUrl(ScholarFetcher.SearchEndpoint endpoint, String query, int pageNumber, Optional<Integer> startYear, Optional<Integer> endYear) throws URISyntaxException, MalformedURLException, FetcherException

callApi	back to summary
private kong.unirest.core.json.JSONObject callApi(URL url) throws FetcherException

fetchPage	back to summary
private Page<BibEntry> fetchPage(String query, int pageNumber, Optional<Integer> startYear, Optional<Integer> endYear) throws FetcherException

findFullText	back to summary
public Optional<URL> findFullText(BibEntry entry) throws IOException, FetcherException Annotations @Override

getApiKey	back to summary
private Optional<String> getApiKey()

getDownloadHeaders back to summary

getDownloadHeaders	back to summary
public Map<String, String> getDownloadHeaders() Overrides default org.jabref.logic.importer.FulltextFetcher.getDownloadHeaders. Doc from org.jabref.logic.importer.FulltextFetcher.getDownloadHeaders. Returns HTTP headers required for downloading the PDF returned by `findFullText`. Fetchers that require authentication (for ex: API tokens) should override this method. Annotations @Override

public Map<String, String> getDownloadHeaders()

Overrides default org.jabref.logic.importer.FulltextFetcher.getDownloadHeaders.

Doc from org.jabref.logic.importer.FulltextFetcher.getDownloadHeaders.

Returns HTTP headers required for downloading the PDF returned by findFullText. Fetchers that require authentication (for ex: API tokens) should override this method.

Annotations

@Override

getName	back 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

getName

back 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

getTestUrl	back to summary
private URL getTestUrl() throws MalformedURLException

getTrustLevel	back to summary
public TrustLevel getTrustLevel() Implements org.jabref.logic.importer.FulltextFetcher.getTrustLevel. Doc from org.jabref.logic.importer.FulltextFetcher.getTrustLevel. Returns the level of trust for this fetcher. We distinguish between publishers and meta search engines for example. Annotations @Override

getTrustLevel

back to summary

public TrustLevel getTrustLevel()

Implements org.jabref.logic.importer.FulltextFetcher.getTrustLevel.

Doc from org.jabref.logic.importer.FulltextFetcher.getTrustLevel.

Returns the level of trust for this fetcher. We distinguish between publishers and meta search engines for example.

Annotations

@Override

isValidKey	back to summary
public boolean isValidKey(String apiKey) Overrides default org.jabref.logic.importer.fetcher.CustomizableKeyFetcher.isValidKey. Doc from org.jabref.logic.importer.fetcher.CustomizableKeyFetcher.isValidKey. Returns whether the API key is valid Annotations @Override

isValidKey

back to summary

public boolean isValidKey(String apiKey)

Overrides default org.jabref.logic.importer.fetcher.CustomizableKeyFetcher.isValidKey.

Doc from org.jabref.logic.importer.fetcher.CustomizableKeyFetcher.isValidKey.

Returns whether the API key is valid

Annotations

@Override

jsonItemToBibEntry	back to summary
public static BibEntry jsonItemToBibEntry(kong.unirest.core.json.JSONObject scholarJsonEntry) throws ParseException Convert a JSONObject obtained from the Scholar API to a BibEntry Parameters scholarJsonEntry:kong.unirest.core.json.JSONObject the JSONObject from search results Returns:BibEntry the converted BibEntry

jsonItemToBibEntry

back to summary

public static BibEntry jsonItemToBibEntry(kong.unirest.core.json.JSONObject scholarJsonEntry) throws ParseException

Convert a JSONObject obtained from the Scholar API to a BibEntry

Parameters

scholarJsonEntry:kong.unirest.core.json.JSONObject: the JSONObject from search results

Returns:BibEntry

the converted BibEntry

performRawSearchQueryPaged	back to summary
public Page<BibEntry> performRawSearchQueryPaged(String rawQuery, int pageNumber) throws FetcherException Overrides default org.jabref.logic.importer.PagedSearchBasedFetcher.performRawSearchQueryPaged. Annotations @Override

performRawSearchQueryPaged

back to summary

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

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

Annotations

@Override

performSearchPaged	back to summary
public Page<BibEntry> performSearchPaged(BaseQueryNode queryNode, int pageNumber) throws FetcherException Implements org.jabref.logic.importer.PagedSearchBasedFetcher.performSearchPaged. Annotations @Override

performSearchPaged

back to summary

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

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

Annotations

@Override

org.jabref.logic.importer.fetcher back to summary

private final Record ScholarFetcher.PageKey

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.importer.fetcher.ScholarFetcher.PageKey

Record Components

endpoint:ScholarFetcher.SearchEndpoint
query:String
startYear:int
endYear:int
pageNumber:int

Field Summary

Modifier and Type	Field and Description
private final ScholarFetcher.SearchEndpoint	endpoint Record Component accessed by endpoint().
private final int	endYear Record Component accessed by endYear().
private final int	pageNumber Record Component accessed by pageNumber().
private final String	query Record Component accessed by query().
private final int	startYear Record Component accessed by startYear().

Constructor Summary

Access	Constructor and Description
private	PageKey(ScholarFetcher.SearchEndpoint endpoint, String query, int startYear, int endYear, int pageNumber)

Method Summary

Modifier and Type	Method and Description
public ScholarFetcher.SearchEndpoint	endpoint() Record Component getter of endpoint.
public int	endYear() Record Component getter of endYear.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public int	pageNumber() Record Component getter of pageNumber.
public String	query() Record Component getter of query.
public int	startYear() Record Component getter of startYear.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

endpoint	back to summary
private final ScholarFetcher.SearchEndpoint endpoint Record Component accessed by endpoint().

endYear	back to summary
private final int endYear Record Component accessed by endYear().

pageNumber	back to summary
private final int pageNumber Record Component accessed by pageNumber().

query	back to summary
private final String query Record Component accessed by query().

startYear	back to summary
private final int startYear Record Component accessed by startYear().

Constructor Detail

PageKey	back to summary
private PageKey(ScholarFetcher.SearchEndpoint endpoint, String query, int startYear, int endYear, int pageNumber)

Method Detail

endpoint	back to summary
public ScholarFetcher.SearchEndpoint endpoint() Record Component getter of endpoint.

endYear	back to summary
public int endYear() Record Component getter of endYear.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

pageNumber	back to summary
public int pageNumber() Record Component getter of pageNumber.

query	back to summary
public String query() Record Component getter of query.

startYear	back to summary
public int startYear() Record Component getter of startYear.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

org.jabref.logic.importer.fetcher back to summary

private final Enum ScholarFetcher.SearchEndpoint

Class Inheritance

extends Enum<ScholarFetcher.SearchEndpoint>

java.lang.Object
java.lang.Enum
org.jabref.logic.importer.fetcher.ScholarFetcher.SearchEndpoint

Field Summary

Modifier and Type	Field and Description
private final String	cursorRequestParameter
public static final ScholarFetcher.SearchEndpoint	LIST
private final String	nextCursorResponseParameter
public static final ScholarFetcher.SearchEndpoint	SEARCH
private final String	url

Constructor Summary

Access	Constructor and Description
private	SearchEndpoint(String url, String cursorRequestParameter, String nextCursorResponseParameter)

Method Summary

Modifier and Type	Method and Description
pack-priv String	cursorRequestParameter()
pack-priv String	nextCursorResponseParameter()
pack-priv String	url()
public static ScholarFetcher.SearchEndpoint	valueOf(String name)
public static ScholarFetcher.SearchEndpoint[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

cursorRequestParameter	back to summary
private final String cursorRequestParameter

LIST	back to summary
public static final ScholarFetcher.SearchEndpoint LIST

nextCursorResponseParameter	back to summary
private final String nextCursorResponseParameter

SEARCH	back to summary
public static final ScholarFetcher.SearchEndpoint SEARCH

url	back to summary
private final String url

Constructor Detail

SearchEndpoint	back to summary
private SearchEndpoint(String url, String cursorRequestParameter, String nextCursorResponseParameter)

Method Detail

cursorRequestParameter	back to summary
pack-priv String cursorRequestParameter()

nextCursorResponseParameter	back to summary
pack-priv String nextCursorResponseParameter()

url	back to summary
pack-priv String url()

valueOf	back to summary
public static ScholarFetcher.SearchEndpoint valueOf(String name)

values	back to summary
public static ScholarFetcher.SearchEndpoint[] values()

public Class ScholarFetcher

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record ScholarFetcher.PageKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum ScholarFetcher.SearchEndpoint

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail