edu.illinois.cs.cogcomp.nesim.data

Class NickNameManager

java.lang.Object

edu.illinois.cs.cogcomp.nesim.data.NickNameManager

public class NickNameManager
extends Object

Constructor Summary

Constructors

Constructor and Description
NickNameManager(String nicknameFileName, float confThres) Constructor to initialize a NickNameManager object.

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	getNickNameMapping(String text) Finds all possible nicknames for the string parameter.
boolean	isNickName(String text) Checks if the string parameter is a valid nickname.
void	readNicknameFile() Reads the given file and stores nicknames in a HashMap.
ArrayList<String>	replaceNickNames(String text) Adds a new nickname or replaces an old one.

Methods inherited from class java.lang.Object

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

Constructor Detail

NickNameManager

public NickNameManager(String nicknameFileName,
                       float confThres)
                throws NumberFormatException,
                       IOException

Constructor to initialize a NickNameManager object. Utilized as a helper class in NameParser to score string of type PER whenever nicknames may apply.

Parameters:

nicknameFileName - File name to obtain list of nickname strings

confThres - Threshold for confidence of whether a string is a nickname

Throws:

NumberFormatException

IOException

Method Detail

readNicknameFile

public void readNicknameFile()
                      throws NumberFormatException,
                             IOException

Reads the given file and stores nicknames in a HashMap.

Throws:

NumberFormatException

IOException

isNickName

public boolean isNickName(String text)

Checks if the string parameter is a valid nickname.

Parameters:

text - String to be checked for nickname

Returns:

A boolean value (true/false) determining whether the string is a nickname

getNickNameMapping

public ArrayList<String> getNickNameMapping(String text)

Finds all possible nicknames for the string parameter.

Parameters:

text - String to find the nickname mapping for from the HashMap

Returns:

An ArrayList of all possible nicknames for a certain name

replaceNickNames

public ArrayList<String> replaceNickNames(String text)

Adds a new nickname or replaces an old one.

Parameters:

text - String for which the nickname will be replaced

Returns:

An ArrayList containing the new nickname for the given formal name