Verified Owner
Top Description Inners Methods
org.jabref.logic.importer.fetcher.citation

public Interface CitationFetcher

extends CitationCountFetcher
Known Direct Implementers
org.jabref.logic.importer.fetcher.citation.crossref.CrossRefCitationFetcher, org.jabref.logic.importer.fetcher.citation.semanticscholar.SemanticScholarCitationFetcher, org.jabref.logic.importer.fetcher.citation.opencitations.OpenCitationsFetcher, org.jabref.logic.importer.fetcher.OpenAlex, org.jabref.logic.importer.fetcher.citation.AllCitationFetcher
Annotations
@NullMarked
Imports
java.net.URI, java.util.List, .Optional, org.jabref.logic.importer.FetcherException, org.jabref.model.entry.BibEntry, org.jspecify.annotations.NullMarked
Searches web resources for citing related articles based on a BibEntry.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
CitationFetcher.SearchType

Possible search methods

Method Summary

Modifier and TypeMethod and Description
public List<BibEntry>

Returns:

a list of BibEntry, which are matched by the query (may be empty)
getCitations(BibEntry
entry to search articles for
entry)

Looks for hits which are citing the given BibEntry.

public default Optional<URI>

Returns:

the URI for the citations API, or empty if not supported
getCitationsApiUri(BibEntry
the entry to get citations for
entry)

Returns the API URL for fetching citations

public String

Returns:

the localized name
getName()

Returns the localized name of this fetcher.

public List<BibEntry>

Returns:

a list of BibEntry, which are matched by the query (may be empty)
getReferences(BibEntry
entry to search articles for
entry)

Looks for hits which are cited by the given BibEntry.

public default Optional<URI>

Returns:

the URI for the references API, or empty if not supported
getReferencesApiUri(BibEntry
the entry to get references for
entry)

Returns the API URL for fetching references

Inherited from org.jabref.logic.importer.fetcher.citation.CitationCountFetcher:
getCitationCount

Method Detail

getCitationsback to summary
public List<BibEntry> getCitations(BibEntry entry) throws FetcherException

Looks for hits which are citing the given BibEntry.

Parameters
entry:BibEntry

entry to search articles for

Returns:List<BibEntry>

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

getCitationsApiUriback to summary
public default Optional<URI> getCitationsApiUri(BibEntry entry)

Returns the API URL for fetching citations

Parameters
entry:BibEntry

the entry to get citations for

Returns:Optional<URI>

the URI for the citations API, or empty if not supported

getNameback to summary
public String 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

getReferencesback to summary
public List<BibEntry> getReferences(BibEntry entry) throws FetcherException

Looks for hits which are cited by the given BibEntry. This typically is the "References" (or "Bibliography" or "Literature") section of a paper.

Parameters
entry:BibEntry

entry to search articles for

Returns:List<BibEntry>

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

getReferencesApiUriback to summary
public default Optional<URI> getReferencesApiUri(BibEntry entry)

Returns the API URL for fetching references

Parameters
entry:BibEntry

the entry to get references for

Returns:Optional<URI>

the URI for the references API, or empty if not supported

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

public final Enum CitationFetcher.SearchType

extends Enum<CitationFetcher.SearchType>
Class Inheritance
Possible search methods

Field Summary

Modifier and TypeField and Description
public static final CitationFetcher.SearchType
CITED_BY

public static final CitationFetcher.SearchType
CITES

public final String
label

Constructor Summary

AccessConstructor and Description
private
SearchType(String label)

Method Summary

Modifier and TypeMethod and Description
public static CitationFetcher.SearchType
valueOf(String name)

public static CitationFetcher.SearchType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CITED_BYback to summary
public static final CitationFetcher.SearchType CITED_BY
CITESback to summary
public static final CitationFetcher.SearchType CITES
labelback to summary
public final String label

Constructor Detail

SearchTypeback to summary
private SearchType(String label)

Method Detail

valueOfback to summary
public static CitationFetcher.SearchType valueOf(String name)
valuesback to summary
public static CitationFetcher.SearchType[] values()