Top Description Fields Constructors Methods

org.jabref.logic.journals

public Class JournalAbbreviationRepository

Class Inheritance

extends Object

java.lang.Object
org.jabref.logic.journals.JournalAbbreviationRepository

Imports

java.nio.file.Path, java.util.Collection, .HashMap, .Map, .Objects, .Optional, .Set, .TreeSet, java.util.regex.Matcher, .Pattern, org.h2.mvstore.MVMap, org.h2.mvstore.MVStore

A repository for all journal abbreviations, including add and find methods.

Field Summary

Modifier and Type	Field and Description
private final Map<String, Abbreviation>	abbreviationToAbbreviationObject
private final TreeSet<Abbreviation>	customAbbreviations
private final Map<String, Abbreviation>	dotlessToAbbreviationObject
private final Map<String, Abbreviation>	fullToAbbreviationObject
pack-priv static final Pattern	QUESTION_MARK
private final Map<String, Abbreviation>	shortestUniqueToAbbreviationObject

Constructor Summary

Access	Constructor and Description
public	JournalAbbreviationRepository(Path journalList) Initializes the internal data based on the abbreviations found in the given MV file
public	JournalAbbreviationRepository() Initializes the repository with demonstration data.

Method Summary

Modifier and Type	Method and Description
public void	addCustomAbbreviation(Abbreviation abbreviation)
public void	addCustomAbbreviations(Collection<Abbreviation> abbreviationsToAdd)
public Optional<Abbreviation>	get(String The journal name (either full name or abbreviated name). input) Attempts to get the abbreviation of the journal given.
public Collection<Abbreviation>	getAllLoaded()
public Collection<Abbreviation>	getCustomAbbreviations()
public Optional<String>	getDefaultAbbreviation(String text)
public Optional<String>	getDotless(String text)
public Set<String>	getFullNames()
public Optional<String>	getNextAbbreviation(String text)
public Optional<String>	getShortestUniqueAbbreviation(String text)
public boolean	isAbbreviatedName(String journalName) Returns true if the given journal name is in its abbreviated form (e.g. Phys.
public boolean	isKnownName(String journalName) Returns true if the given journal name is contained in the list either in its full form (e.g., Physical Review Letters) or its abbreviated form (e.g., Phys.
private static boolean	isMatched(String name, Abbreviation abbreviation)
private static boolean	isMatchedAbbreviated(String name, Abbreviation abbreviation)

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

Field Detail

abbreviationToAbbreviationObject	back to summary
private final Map<String, Abbreviation> abbreviationToAbbreviationObject

customAbbreviations	back to summary
private final TreeSet<Abbreviation> customAbbreviations

dotlessToAbbreviationObject	back to summary
private final Map<String, Abbreviation> dotlessToAbbreviationObject

fullToAbbreviationObject	back to summary
private final Map<String, Abbreviation> fullToAbbreviationObject

QUESTION_MARK	back to summary
pack-priv static final Pattern QUESTION_MARK

shortestUniqueToAbbreviationObject	back to summary
private final Map<String, Abbreviation> shortestUniqueToAbbreviationObject

Constructor Detail

JournalAbbreviationRepository	back to summary
public JournalAbbreviationRepository(Path journalList) Initializes the internal data based on the abbreviations found in the given MV file

JournalAbbreviationRepository	back to summary
public JournalAbbreviationRepository() Initializes the repository with demonstration data. Used if no abbreviation file is found.

Method Detail

addCustomAbbreviation	back to summary
public void addCustomAbbreviation(Abbreviation abbreviation)

addCustomAbbreviations	back to summary
public void addCustomAbbreviations(Collection<Abbreviation> abbreviationsToAdd)

get

back to summary

public Optional<Abbreviation> get(String input)

Attempts to get the abbreviation of the journal given.

Parameters

input:String: The journal name (either full name or abbreviated name).

getAllLoaded	back to summary
public Collection<Abbreviation> getAllLoaded()

getCustomAbbreviations	back to summary
public Collection<Abbreviation> getCustomAbbreviations()

getDefaultAbbreviation	back to summary
public Optional<String> getDefaultAbbreviation(String text)

getDotless	back to summary
public Optional<String> getDotless(String text)

getFullNames	back to summary
public Set<String> getFullNames()

getNextAbbreviation	back to summary
public Optional<String> getNextAbbreviation(String text)

getShortestUniqueAbbreviation	back to summary
public Optional<String> getShortestUniqueAbbreviation(String text)

isAbbreviatedName	back to summary
public boolean isAbbreviatedName(String journalName) Returns true if the given journal name is in its abbreviated form (e.g. Phys. Rev. Lett.). The test is strict, i.e., journals whose abbreviation is the same as the full name are not considered

isKnownName	back to summary
public boolean isKnownName(String journalName) Returns true if the given journal name is contained in the list either in its full form (e.g., Physical Review Letters) or its abbreviated form (e.g., Phys. Rev. Lett.).

isMatched	back to summary
private static boolean isMatched(String name, Abbreviation abbreviation)

isMatchedAbbreviated	back to summary
private static boolean isMatchedAbbreviated(String name, Abbreviation abbreviation)