Nested and Inner Type Summary

Modifier and Type	Class and Description
private static record	ZbMATH.ScoredEntry

Field Summary

Modifier and Type	Field and Description
private static final double	AMBIGUITY_DELTA
private static final String	DOCUMENT_SEARCH_URL
private static final String	DOCUMENT_URL
private static final int	ENTRY_SEARCH_RESULT_COUNT
private static final double	MIN_AUTHOR_OVERLAP
private static final double	MIN_CONFIDENCE
private static final double	MIN_TITLE_SIMILARITY
private static final Pattern	NON_ALNUM_OR_SPACE_PATTERN
private final ImportFormatPreferences	preferences
private static final Pattern	WHITESPACE_PATTERN

Constructor Summary

Access	Constructor and Description
public	ZbMATH(ImportFormatPreferences preferences)

Method Summary

Modifier and Type	Method and Description
private void	addSearchNode(List<BaseQueryNode> searchNodes, StandardField field, String value)
private String	buildSearchQuery(BibEntry entry)
public void	doPostCleanup(BibEntry entry) Overrides default org.jabref.logic.importer.ParserFetcher.doPostCleanup. Performs a cleanup of the fetched entry.
private double	familyNameOverlap(String inputAuthors, String candidateAuthors)
private Optional<BibEntry>	findBestMatchingEntry(BibEntry inputEntry, List<BibEntry> candidates)
private List<BibEntry>	getBibEntries(URL urlForQuery) Redeclares private: org.jabref.logic.importer.SearchBasedParserFetcher.getBibEntries.
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, org.jabref.logic.importer.IdBasedParserFetcher.getParser, org.jabref.logic.importer.EntryBasedParserFetcher.getParser. Returns the parser used to convert the response to a list of `BibEntry`.
public URL	getURLForEntry(BibEntry entry) Implements org.jabref.logic.importer.EntryBasedParserFetcher.getURLForEntry. Constructs a URL based on the `BibEntry`.
public URL	getUrlForIdentifier(String identifier) Implements org.jabref.logic.importer.IdBasedParserFetcher.getUrlForIdentifier. Constructs a URL based on the query.
public URL	getURLForQuery(BaseQueryNode queryNode) Implements org.jabref.logic.importer.SearchBasedParserFetcher.getURLForQuery. Constructs a URL based on the lucene query.
private URL	getURLForSearchQuery(String searchQuery, String resultCount)
private static String	normalizeForTitleMatching(String title)
private List<BibEntry>	parseEntries(InputStream stream)
private void	parseSource(BibEntry entry, kong.unirest.core.json.JSONObject source)
public List<BibEntry>	performSearch(BibEntry entry) Implements org.jabref.logic.importer.EntryBasedFetcher.performSearch. Looks for hits which are matched by the given `BibEntry`.
private double	scoreCandidate(BibEntry inputEntry, BibEntry candidate)
private BibEntry	toBibEntry(kong.unirest.core.json.JSONObject entryJson)
private StandardEntryType	toEntryType(kong.unirest.core.json.JSONObject entryJson)

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

Field Detail

AMBIGUITY_DELTA	back to summary
private static final double AMBIGUITY_DELTA

DOCUMENT_SEARCH_URL	back to summary
private static final String DOCUMENT_SEARCH_URL

DOCUMENT_URL	back to summary
private static final String DOCUMENT_URL

ENTRY_SEARCH_RESULT_COUNT	back to summary
private static final int ENTRY_SEARCH_RESULT_COUNT

MIN_AUTHOR_OVERLAP	back to summary
private static final double MIN_AUTHOR_OVERLAP

MIN_CONFIDENCE	back to summary
private static final double MIN_CONFIDENCE

MIN_TITLE_SIMILARITY	back to summary
private static final double MIN_TITLE_SIMILARITY

NON_ALNUM_OR_SPACE_PATTERN	back to summary
private static final Pattern NON_ALNUM_OR_SPACE_PATTERN

preferences	back to summary
private final ImportFormatPreferences preferences

WHITESPACE_PATTERN	back to summary
private static final Pattern WHITESPACE_PATTERN

Constructor Detail

ZbMATH	back to summary
public ZbMATH(ImportFormatPreferences preferences)

Method Detail

addSearchNode	back to summary
private void addSearchNode(List<BaseQueryNode> searchNodes, StandardField field, String value)

buildSearchQuery	back to summary
private String buildSearchQuery(BibEntry entry)

doPostCleanup back to summary

doPostCleanup	back to summary
public void doPostCleanup(BibEntry entry) Overrides default org.jabref.logic.importer.ParserFetcher.doPostCleanup. Doc from org.jabref.logic.importer.ParserFetcher.doPostCleanup. Performs a cleanup of the fetched entry. Only systematic errors of the fetcher should be corrected here (i.e. if information is consistently contained in the wrong field or the wrong format) but not cosmetic issues which may depend on the user's taste (for example, LateX code vs HTML in the abstract). Try to reuse existing `org.jabref.logic.formatter.Formatter` for the cleanup. For example, `new FieldFormatterCleanup(StandardField.TITLE, new RemoveBracesFormatter()).cleanup(entry);` By default, no cleanup is done. Annotations @Override

public void doPostCleanup(BibEntry entry)

Overrides default org.jabref.logic.importer.ParserFetcher.doPostCleanup.

Doc from org.jabref.logic.importer.ParserFetcher.doPostCleanup.

Performs a cleanup of the fetched entry.

Only systematic errors of the fetcher should be corrected here (i.e. if information is consistently contained in the wrong field or the wrong format) but not cosmetic issues which may depend on the user's taste (for example, LateX code vs HTML in the abstract).

Try to reuse existing org.jabref.logic.formatter.Formatter for the cleanup. For example, new FieldFormatterCleanup(StandardField.TITLE, new RemoveBracesFormatter()).cleanup(entry);

By default, no cleanup is done.

Annotations

@Override

familyNameOverlap	back to summary
private double familyNameOverlap(String inputAuthors, String candidateAuthors)

findBestMatchingEntry	back to summary
private Optional<BibEntry> findBestMatchingEntry(BibEntry inputEntry, List<BibEntry> candidates)

getBibEntries	back to summary
private List<BibEntry> getBibEntries(URL urlForQuery) throws FetcherException Redeclares private: org.jabref.logic.importer.SearchBasedParserFetcher.getBibEntries.

getHelpPage	back 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. Annotations @Override

getHelpPage

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

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

getParser back to summary

getParser	back to summary
public Parser getParser() Implements org.jabref.logic.importer.SearchBasedParserFetcher.getParser, org.jabref.logic.importer.IdBasedParserFetcher.getParser, org.jabref.logic.importer.EntryBasedParserFetcher.getParser. Doc from org.jabref.logic.importer.SearchBasedParserFetcher.getParser. Returns the parser used to convert the response to a list of `BibEntry`. Annotations @Override

public Parser getParser()

Implements org.jabref.logic.importer.SearchBasedParserFetcher.getParser, org.jabref.logic.importer.IdBasedParserFetcher.getParser, org.jabref.logic.importer.EntryBasedParserFetcher.getParser.

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

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

Annotations

@Override

getURLForEntry back to summary

getURLForEntry	back to summary
public URL getURLForEntry(BibEntry entry) throws URISyntaxException, MalformedURLException, FetcherException Implements org.jabref.logic.importer.EntryBasedParserFetcher.getURLForEntry. Doc from org.jabref.logic.importer.EntryBasedParserFetcher.getURLForEntry. Constructs a URL based on the `BibEntry`. Annotations @Override

public URL getURLForEntry(BibEntry entry) throws URISyntaxException, MalformedURLException, FetcherException

Implements org.jabref.logic.importer.EntryBasedParserFetcher.getURLForEntry.

Doc from org.jabref.logic.importer.EntryBasedParserFetcher.getURLForEntry.

Constructs a URL based on the BibEntry.

Annotations

@Override

getUrlForIdentifier	back to summary
public URL getUrlForIdentifier(String identifier) throws URISyntaxException, MalformedURLException Implements org.jabref.logic.importer.IdBasedParserFetcher.getUrlForIdentifier. Doc from org.jabref.logic.importer.IdBasedParserFetcher.getUrlForIdentifier. Constructs a URL based on the query. Annotations @Override

getUrlForIdentifier

back to summary

public URL getUrlForIdentifier(String identifier) throws URISyntaxException, MalformedURLException

Implements org.jabref.logic.importer.IdBasedParserFetcher.getUrlForIdentifier.

Doc from org.jabref.logic.importer.IdBasedParserFetcher.getUrlForIdentifier.

Constructs a URL based on the query.

Annotations

@Override

getURLForQuery	back to summary
public 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

getURLForQuery

back to summary

public 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

getURLForSearchQuery	back to summary
private URL getURLForSearchQuery(String searchQuery, String resultCount) throws URISyntaxException, MalformedURLException

normalizeForTitleMatching	back to summary
private static String normalizeForTitleMatching(String title)

parseEntries	back to summary
private List<BibEntry> parseEntries(InputStream stream) throws ParseException

parseSource	back to summary
private void parseSource(BibEntry entry, kong.unirest.core.json.JSONObject source)

performSearch back to summary

performSearch	back to summary
public List<BibEntry> performSearch(BibEntry entry) throws FetcherException Implements org.jabref.logic.importer.EntryBasedFetcher.performSearch. Doc from org.jabref.logic.importer.EntryBasedFetcher.performSearch. Looks for hits which are matched by the given `BibEntry`. Annotations @Override

public List<BibEntry> performSearch(BibEntry entry) throws FetcherException

Implements org.jabref.logic.importer.EntryBasedFetcher.performSearch.

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

Looks for hits which are matched by the given BibEntry.

Annotations

@Override

scoreCandidate	back to summary
private double scoreCandidate(BibEntry inputEntry, BibEntry candidate)

toBibEntry	back to summary
private BibEntry toBibEntry(kong.unirest.core.json.JSONObject entryJson)

toEntryType	back to summary
private StandardEntryType toEntryType(kong.unirest.core.json.JSONObject entryJson)

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

private final Record ZbMATH.ScoredEntry

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.importer.fetcher.ZbMATH.ScoredEntry

Record Components

entry:BibEntry
score:double

Field Summary

Modifier and Type	Field and Description
private final BibEntry	entry Record Component accessed by entry().
private final double	score Record Component accessed by score().

Constructor Summary

Access	Constructor and Description
private	ScoredEntry(BibEntry entry, double score)

Method Summary

Modifier and Type	Method and Description
public BibEntry	entry() Record Component getter of entry.
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 double	score() Record Component getter of score.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

entry	back to summary
private final BibEntry entry Record Component accessed by entry().

score	back to summary
private final double score Record Component accessed by score().

Constructor Detail

ScoredEntry	back to summary
private ScoredEntry(BibEntry entry, double score)

Method Detail

entry	back to summary
public BibEntry entry() Record Component getter of entry.

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.

score	back to summary
public double score() Record Component getter of score.

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.

public Class ZbMATH

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record ZbMATH.ScoredEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail