edu.illinois.cs.cogcomp.nesim.data

Class ShortcutManager

java.lang.Object

edu.illinois.cs.cogcomp.nesim.data.ShortcutManager

public class ShortcutManager
extends Object

Constructor Summary

Constructors

Constructor and Description
ShortcutManager(String shortcutFileName) Constructor to initialize a ShortcutManager object.

Method Summary

Modifier and Type	Method and Description
List<String>	getLongForm(String shortcut) Finds all possible long forms for a given shortcut.
List<String>	getShortForm(String longform) Finds all possible shortcuts for a given long form.
void	readShortcutFile() Reads the given file.
float	scoring(String name1, String name2) Primary scoring function invoked by EntityComparison.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortcutManager

public ShortcutManager(String shortcutFileName)
                throws IOException

Constructor to initialize a ShortcutManager object. Used to score strings of type LOC that may be shortcuts.

Parameters:

shortcutFileName - File name to obtain list of shortcut strings

Throws:

IOException

Method Detail

readShortcutFile

public void readShortcutFile()
                      throws IOException

Reads the given file.

Throws:

IOException

scoring

public float scoring(String name1,
                     String name2)

Primary scoring function invoked by EntityComparison. Used to score strings of type LOC where one string may be a shortcut of the other string.

Parameters:

name1 - First of the two strings to be scored

name2 - Second of the two strings to be scored

Returns:

A float value between 0 and 1 inclusive as the score

getLongForm

public List<String> getLongForm(String shortcut)

Finds all possible long forms for a given shortcut.

Parameters:

shortcut - The string that may be a shortcut

Returns:

A list containing the possible long forms for the given shortcut

getShortForm

public List<String> getShortForm(String longform)

Finds all possible shortcuts for a given long form.

Parameters:

longform - The string that may be a long form

Returns:

A list containing the possible shortcuts for the given long form