JabRef 6.0-beta.1 · org.jabref.logic.icore.ConferenceRepository

Field Summary

Modifier and Type	Field and Description
private final Map<String, ConferenceEntry>	acronymToConference
private static final double	COMBINED_LCS_LEV_THRESHOLD
private static final double	EPSILON
private static final String	ICORE_RANK_DATA_FILE
private static final StringSimilarity	LEVENSHTEIN_MATCHER
private static final double	LEVENSHTEIN_THRESHOLD
private static final Logger	LOGGER
private int	maxAcronymLength
private final Map<String, ConferenceEntry>	normalizedTitleToConference
private final Map<String, ConferenceEntry>	titleToConference

Constructor Summary

Access	Constructor and Description
public	ConferenceRepository()
public	ConferenceRepository(InputStream testFileInputStream) Constructor to allow loading in test data

Method Summary

Modifier and Type	Method and Description
private Optional<ConferenceEntry>	Returns: an `Optional` conference entry, if found or `Optional.empty()` if no conference entry is found fuzzySearchConferenceTitles(String The query string to be searched query) Searches the conference data for the given query string using a combination of Levenshtein similarity `StringSimilarity#similarity` and Longest Common Substring (LCS) similarity `StringSimilarity#LCSSimilarity`.
private Optional<ConferenceEntry>	getConferenceFromAcronym(String query)
public Optional<ConferenceEntry>	Returns: an `Optional` conference entry, if found or `Optional.empty()` if no conference entry is found getConferenceFromBookTitle(@NonNull String the string to search, must not be `null` bookTitle) Searches the given query against the ICORE conference ranking data and returns a match, if found.
private void	loadConferenceDataFromInputStream(InputStream inputStream)

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

Field Detail

acronymToConference	back to summary
private final Map<String, ConferenceEntry> acronymToConference

COMBINED_LCS_LEV_THRESHOLD	back to summary
private static final double COMBINED_LCS_LEV_THRESHOLD

EPSILON	back to summary
private static final double EPSILON

ICORE_RANK_DATA_FILE	back to summary
private static final String ICORE_RANK_DATA_FILE

LEVENSHTEIN_MATCHER	back to summary
private static final StringSimilarity LEVENSHTEIN_MATCHER

LEVENSHTEIN_THRESHOLD	back to summary
private static final double LEVENSHTEIN_THRESHOLD

LOGGER	back to summary
private static final Logger LOGGER

maxAcronymLength	back to summary
private int maxAcronymLength

normalizedTitleToConference	back to summary
private final Map<String, ConferenceEntry> normalizedTitleToConference

titleToConference	back to summary
private final Map<String, ConferenceEntry> titleToConference

Constructor Detail

ConferenceRepository	back to summary
public ConferenceRepository() throws JabRefException

ConferenceRepository	back to summary
public ConferenceRepository(InputStream testFileInputStream) throws JabRefException Constructor to allow loading in test data

Method Detail

fuzzySearchConferenceTitles back to summary

fuzzySearchConferenceTitles	back to summary
private Optional<ConferenceEntry> fuzzySearchConferenceTitles(String query) Searches the conference data for the given query string using a combination of Levenshtein similarity `StringSimilarity#similarity` and Longest Common Substring (LCS) similarity `StringSimilarity#LCSSimilarity`. The input query is first fed through the normalizer at `ConferenceUtils#normalize` which strips away much of the noise. While searching, the function computes Levenshtein similarity and LCS similarity between the query and the current conference title (also normalized) and prioritizes them in the following order: Whenever LCS similarity returns `1.0`, i.e., a conference title is found entirely as a substring in the query. Whenever Levenshtein similarity exceeds the threshold defined by the `LEVENSHTEIN_THRESHOLD` constant. The combined weighted score of both LCS and Levenshtein similarities exceeds the `COMBINED_LCS_LEV_THRESHOLD`. The combined score is calculated as follows: `(0.6 * Levenshtein similarity) + (0.4 * LCS similarity)` Parameters query:String The query string to be searched Returns:Optional<ConferenceEntry> an `Optional` conference entry, if found or `Optional.empty()` if no conference entry is found

private Optional<ConferenceEntry> fuzzySearchConferenceTitles(String query)

Searches the conference data for the given query string using a combination of Levenshtein similarity StringSimilarity#similarity and Longest Common Substring (LCS) similarity StringSimilarity#LCSSimilarity.

The input query is first fed through the normalizer at ConferenceUtils#normalize which strips away much of the noise.

While searching, the function computes Levenshtein similarity and LCS similarity between the query and the current conference title (also normalized) and prioritizes them in the following order:

Whenever LCS similarity returns 1.0, i.e., a conference title is found entirely as a substring in the query.
Whenever Levenshtein similarity exceeds the threshold defined by the LEVENSHTEIN_THRESHOLD constant.
The combined weighted score of both LCS and Levenshtein similarities exceeds the COMBINED_LCS_LEV_THRESHOLD.

The combined score is calculated as follows: (0.6 * Levenshtein similarity) + (0.4 * LCS similarity)

Parameters

query:String: The query string to be searched

Returns:Optional<ConferenceEntry>

an Optional conference entry, if found or Optional.empty() if no conference entry is found

getConferenceFromAcronym	back to summary
private Optional<ConferenceEntry> getConferenceFromAcronym(String query)

getConferenceFromBookTitle back to summary

getConferenceFromBookTitle	back to summary
public Optional<ConferenceEntry> getConferenceFromBookTitle(@NonNull String bookTitle) Searches the given query against the ICORE conference ranking data and returns a match, if found. While searching, we first look for a conference acronym present inside parentheses, like `(ICSE)` or `(ICSE 2022)`. If acronym lookup fails, the query is processed further and matched against the list of conference titles. Implementation Note see `ConferenceRepository#fuzzySearchConferenceTitles` for more details on matching Parameters bookTitle:@NonNull String the string to search, must not be `null` Returns:Optional<ConferenceEntry> an `Optional` conference entry, if found or `Optional.empty()` if no conference entry is found

public Optional<ConferenceEntry> getConferenceFromBookTitle(@NonNull String bookTitle)

Searches the given query against the ICORE conference ranking data and returns a match, if found.

While searching, we first look for a conference acronym present inside parentheses, like (ICSE) or (ICSE 2022). If acronym lookup fails, the query is processed further and matched against the list of conference titles.

Implementation Note

see ConferenceRepository#fuzzySearchConferenceTitles for more details on matching

Parameters

bookTitle:@NonNull String: the string to search, must not be null

Returns:Optional<ConferenceEntry>

an Optional conference entry, if found or Optional.empty() if no conference entry is found

loadConferenceDataFromInputStream	back to summary
private void loadConferenceDataFromInputStream(InputStream inputStream) throws JabRefException

public Class ConferenceRepository

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail