edu.illinois.cs.cogcomp.nesim.data

Class AcronymManager

java.lang.Object

edu.illinois.cs.cogcomp.nesim.data.AcronymManager

public class AcronymManager
extends Object

Constructor Summary

Constructors

Constructor and Description
AcronymManager(String acronymFileName) Constructor to initialize an AcronymManager object, which is used to determine if a string or a pair of strings should be assigned type ORG.

Method Summary

Modifier and Type	Method and Description
float	acronymScoring(ArrayList<String> candidates1, ArrayList<String> candidates2) Helper scoring function used to score strings designated ORG.
float	acronymScoring(String name1, String name2) Helper scoring function used to score strings designated ORG.
String	findAcronym(String longName) Finds the possible acronyms of a long string (presumably multiple words) with and without words like "of, at, the" included in the abbreviated form.
List<String>	getLongForm(String acronym)
List<String>	getShortForm(String longform)
boolean	isAcronymFirstLetters(String shortName, String longName) Returns true if the shorter string is an abbreviation, or a variant of acceptable ones, of the longer string.
boolean	isAcronymPair(String acronym, String fullName) More rigorously defined than isAcronymFirstLetters; returns true if the shorter string is exactly an acronym of the longer string.
boolean	isSpecificCase()
void	readAcronymFile()
float	scoring(NameInfo name1Info, NameInfo name2Info) Primary scoring function called by EntityComparison.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AcronymManager

public AcronymManager(String acronymFileName)
               throws IOException

Constructor to initialize an AcronymManager object, which is used to determine if a string or a pair of strings should be assigned type ORG.

Parameters:

acronymFileName - File name to obtain list of acronyms

Throws:

IOException

Method Detail

acronymScoring

public float acronymScoring(String name1,
                            String name2)

Helper scoring function used to score strings designated ORG.

Parameters:

name1 - First of two type ORG strings to be compared

name2 - Second of two type ORG strings to be compared

Returns:

Float value between 0 and 1 inclusive as the score

isSpecificCase

public boolean isSpecificCase()

acronymScoring

public float acronymScoring(ArrayList<String> candidates1,
                            ArrayList<String> candidates2)

Helper scoring function used to score strings designated ORG.

Parameters:

candidates1 - ArrayList for first string

candidates2 - ArrayList for second string

Returns:

Float value between 0 and 1 inclusive as the score

scoring

public float scoring(NameInfo name1Info,
                     NameInfo name2Info)

Primary scoring function called by EntityComparison. It scores pairs of strings of type ORG.

Parameters:

name1Info - First NameInfo object to be compared

name2Info - Second NameInfo object to be compared

Returns:

Float value between 0 and 1 inclusive as the score

findAcronym

public String findAcronym(String longName)

Finds the possible acronyms of a long string (presumably multiple words) with and without words like "of, at, the" included in the abbreviated form.

Parameters:

longName - The longer of two strings being compared

Returns:

A string representation of the possible acronym(s) that longName could be

isAcronymFirstLetters

public boolean isAcronymFirstLetters(String shortName,
                                     String longName)

Returns true if the shorter string is an abbreviation, or a variant of acceptable ones, of the longer string.

Parameters:

shortName - Shorter of two strings being compared

longName - Longer of two strings being compared

Returns:

A boolean value (true/false) determining whether shortName is a possible acronym of longName

isAcronymPair

public boolean isAcronymPair(String acronym,
                             String fullName)

More rigorously defined than isAcronymFirstLetters; returns true if the shorter string is exactly an acronym of the longer string.

Parameters:

acronym - Shorter of the two strings

fullName - Longer of the two strings

Returns:

A boolean value (true/false) determining whether the acronym is an exactly acceptable abbreviation for the longer string

readAcronymFile

public void readAcronymFile()
                     throws IOException

Throws:

IOException

getLongForm

public List<String> getLongForm(String acronym)

getShortForm

public List<String> getShortForm(String longform)