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

public Class IEEE

extends Object
implements FulltextFetcher, PagedSearchBasedParserFetcher, CustomizableKeyFetcher
Class Inheritance
All Implemented Interfaces
org.jabref.logic.importer.fetcher.CustomizableKeyFetcher, org.jabref.logic.importer.WebFetcher, org.jabref.logic.importer.PagedSearchBasedParserFetcher, org.jabref.logic.importer.ParserFetcher, org.jabref.logic.importer.PagedSearchBasedFetcher, org.jabref.logic.importer.SearchBasedFetcher, org.jabref.logic.importer.SearchBasedParserFetcher, org.jabref.logic.importer.FulltextFetcher
Imports
java.io.BufferedReader, .IOException, .InputStreamReader, java.net.MalformedURLException, .URISyntaxException, .URL, java.util.ArrayList, .List, .Objects, .Optional, java.util.regex.Matcher, .Pattern, java.util.stream.Collectors, org.jabref.logic.help.HelpFile, org.jabref.logic.importer.FetcherException, .FulltextFetcher, .ImportFormatPreferences, .ImporterPreferences, .PagedSearchBasedParserFetcher, .Parser, org.jabref.logic.importer.fetcher.transformers.IEEEQueryTransformer, org.jabref.logic.net.URLDownload, org.jabref.logic.util.BuildInfo, .OS, org.jabref.model.entry.BibEntry, .LinkedFile, org.jabref.model.entry.field.StandardField, org.jabref.model.entry.identifier.DOI, org.jabref.model.entry.types.StandardEntryType, kong.unirest.core.json.JSONArray, kong.unirest.core.json.JSONObject, org.apache.hc.core5.net.URIBuilder, org.apache.lucene.queryparser.flexible.core.nodes.QueryNode, org.slf4j.Logger, .LoggerFactory
Class for finding PDF URLs for entries on IEEE. Will first look for URLs of the type https://ieeexplore.ieee.org/stamp/stamp.jsp?[tp=&]arnumber=.... If not found, will resolve the DOI, if it starts with 10.1109, and try to find a similar link on the HTML page.
See Also
API documentation

Field Summary

Modifier and TypeField and Description
private static final String
API_KEY

private static final String
BASE_URL

private static final Pattern
DOCUMENT_PATTERN

public static final String
FETCHER_NAME

private static final String
IEEE_DOI

private final ImporterPreferences
importerPreferences

private final ImportFormatPreferences
importFormatPreferences

private static final Logger
LOGGER

private static final Pattern
PDF_PATTERN

private static final String
STAMP_BASE_STRING_DOCUMENT

private static final Pattern
STAMP_PATTERN

private static final String
TEST_URL_WITHOUT_API_KEY

private IEEEQueryTransformer
transformer

Constructor Summary

AccessConstructor and Description
public
IEEE(ImportFormatPreferences importFormatPreferences, ImporterPreferences importerPreferences)

Method Summary

Modifier and TypeMethod and Description
public Optional<URL>
findFullText(BibEntry
The Bibtex entry
entry)

Implements org.jabref.logic.importer.FulltextFetcher.findFullText.

Tries to find a fulltext URL for a given BibTex entry.

private String
getApiKey()

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 Parser
getParser()

Implements org.jabref.logic.importer.SearchBasedParserFetcher.getParser.

Returns the parser used to convert the response to a list of BibEntry.

public String
getTestUrl()

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

public TrustLevel
getTrustLevel()

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

Returns the level of trust for this fetcher.

public URL
getURLForQuery(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode
the search query
luceneQuery, int
the number of the page indexed from 0
pageNumber)

Implements org.jabref.logic.importer.PagedSearchBasedParserFetcher.getURLForQuery.

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

private static BibEntry
parseJsonResponse(kong.unirest.core.json.JSONObject jsonEntry, Character keywordSeparator)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

API_KEYback to summary
private static final String API_KEY
BASE_URLback to summary
private static final String BASE_URL
DOCUMENT_PATTERNback to summary
private static final Pattern DOCUMENT_PATTERN
FETCHER_NAMEback to summary
public static final String FETCHER_NAME
IEEE_DOIback to summary
private static final String IEEE_DOI
importerPreferencesback to summary
private final ImporterPreferences importerPreferences
importFormatPreferencesback to summary
private final ImportFormatPreferences importFormatPreferences
LOGGERback to summary
private static final Logger LOGGER
PDF_PATTERNback to summary
private static final Pattern PDF_PATTERN
STAMP_BASE_STRING_DOCUMENTback to summary
private static final String STAMP_BASE_STRING_DOCUMENT
STAMP_PATTERNback to summary
private static final Pattern STAMP_PATTERN
TEST_URL_WITHOUT_API_KEYback to summary
private static final String TEST_URL_WITHOUT_API_KEY
transformerback to summary
private IEEEQueryTransformer transformer

Constructor Detail

IEEEback to summary
public IEEE(ImportFormatPreferences importFormatPreferences, ImporterPreferences importerPreferences)

Method Detail

findFullTextback to summary
public Optional<URL> findFullText(BibEntry entry) throws IOException

Implements org.jabref.logic.importer.FulltextFetcher.findFullText.

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

Tries to find a fulltext URL for a given BibTex entry.

Parameters
entry:BibEntry

The Bibtex entry

Returns:Optional<URL>

The fulltext PDF URL Optional, if found, or an empty Optional if not found.

Annotations
@Override
Exceptions
IOException:
if an IO operation has failed
getApiKeyback to summary
private String getApiKey()
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.

Returns:Optional<HelpFile>

the HelpFile enum constant for the help page

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.

Returns:String

the localized name

Annotations
@Override
getParserback to summary
public Parser getParser()

Implements org.jabref.logic.importer.SearchBasedParserFetcher.getParser.

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

Returns the parser used to convert the response to a list of BibEntry.

Annotations
@Override
getTestUrlback to summary
public String getTestUrl()

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

Annotations
@Override
getTrustLevelback to summary
public TrustLevel getTrustLevel()

Overrides default 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.

Returns:TrustLevel

The trust level of the fetcher, the higher the better

Annotations
@Override
getURLForQueryback to summary
public URL getURLForQuery(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode luceneQuery, int pageNumber) throws URISyntaxException, MalformedURLException, FetcherException

Implements org.jabref.logic.importer.PagedSearchBasedParserFetcher.getURLForQuery.

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

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

Parameters
luceneQuery:org.apache.lucene.queryparser.flexible.core.nodes.QueryNode

the search query

pageNumber:int

the number of the page indexed from 0

Annotations
@Override
parseJsonResponseback to summary
private static BibEntry parseJsonResponse(kong.unirest.core.json.JSONObject jsonEntry, Character keywordSeparator)

Implementation Note

documentation