edu.illinois.cs.cogcomp.nesim.data

Class NameParser

java.lang.Object

edu.illinois.cs.cogcomp.nesim.data.NameParser

public class NameParser
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static float	TYPOTHRES

Constructor Summary

Constructors

Constructor and Description
NameParser(String honorificFileName, String nicknameFileName, float nickThres) Constructor to initialize a NameParser object.

Method Summary

Modifier and Type	Method and Description
float	compare(NameParser nameParser) Compares two strings of type PER that are converted into NameParser objects.
ArrayList<String>	getArrNameTokens()
String	getExtraName()
String	getFirstName()
String	getHonorific()
String	getLastName()
String	getMiddleName()
ArrayList<String>	getNickNameMapping(String text) Finds all possible nicknames for the string parameter.
boolean	honorificMatching(String honorific) Checks if the string parameter is a valid honorific.
boolean	isNickName(String text) Checks if the string parameter is a valid nickname.
void	parsing(String name) Parses a given string of type PER, identifying the parts of the name - first name, last name, honorific, title, etc.
void	resetAll() Sets all variables to empty strings.

Methods inherited from class java.lang.Object

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

Field Detail

TYPOTHRES

public static final float TYPOTHRES

See Also:

Constant Field Values

Constructor Detail

NameParser

public NameParser(String honorificFileName,
                  String nicknameFileName,
                  float nickThres)
           throws IOException

Constructor to initialize a NameParser object. Used in scoring strings of type PER.

Parameters:

honorificFileName - File name to obtain list of name strings

nicknameFileName - File name to obtain list of nickname strings

nickThres - Threshold at which a name is considered a nickname

Throws:

IOException

Method Detail

resetAll

public void resetAll()

Sets all variables to empty strings.

parsing

public void parsing(String name)

Parses a given string of type PER, identifying the parts of the name - first name, last name, honorific, title, etc.

Parameters:

name - String to be parsed using type PER

getHonorific

public String getHonorific()

Returns:

THe honorific of the name

getFirstName

public String getFirstName()

Returns:

First name of the parsed string

getMiddleName

public String getMiddleName()

Returns:

Middle name of the parsed string

getLastName

public String getLastName()

Returns:

Last name of the parsed string

getExtraName

public String getExtraName()

Returns:

A second name, if one exists

compare

public float compare(NameParser nameParser)

Compares two strings of type PER that are converted into NameParser objects. Primary function called by EntityComparison.

Parameters:

nameParser - The other string of type PER to be compared with

Returns:

A float value between 0 and 1 inclusive as the score

getArrNameTokens

public ArrayList<String> getArrNameTokens()

honorificMatching

public boolean honorificMatching(String honorific)

Checks if the string parameter is a valid honorific.

Parameters:

honorific - String to be checked for honorific

Returns:

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

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