EntityComparison (illinois-cogcomp-nlp 3.1.29 API)

java.lang.Object
- edu.illinois.cs.cogcomp.nesim.compare.EntityComparison

public class EntityComparison
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACRONYMS_LIST`
`static String`	`COUNTRYLANG_LIST`
`static String`	`HONORIFIC_LIST`
`static String`	`LOCATION_LIST`
`static String`	`NICKNAMES_LIST`
`static float`	`NICKNAMES_THRES`
`static String`	`PEOPLE_LIST`
`static float`	`RATIO_THRES`
`static String`	`REASON`
`static String`	`SCORE`
`static String`	`SHORTCUTS_LIST`
`static String`	`TERMINATION`

Constructor Summary

Constructors
Constructor and Description

EntityComparison()
No-arg constructor that initializes all helper classes with appropriate files and sets the default values for score and reason.

Constructors
Constructor and Description
`EntityComparison()` No-arg constructor that initializes all helper classes with appropriate files and sets the default values for score and reason.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HashMap<String,String>`	`compare(HashMap<String,String> mapNames)` Primary method invoked by the user to initiate comparison of two strings.
`void`	`compare(String name1, String name2)` Primary helper compare function that converts the comparable strings into NameInfo objects.
`HashMap<String,String>`	`compareNames(String name1, String name2)` Helper function invoked by HashMap compare.
`List<String>`	`getAbbreviations(String longName)`
`List<String>`	`getLongForms(String acronym)`
`String`	`getReason()` Gets reason of the two strings currently being compared.
`float`	`getScore()` Gets score of the two strings currently being compared.
`static void`	`main(String[] args)`
`static String[]`	`parseInput(String str)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCORE
```
public static final String SCORE
```
    See Also:
    
    Constant Field Values
  - REASON
```
public static final String REASON
```
    See Also:
    
    Constant Field Values
  - TERMINATION
```
public static final String TERMINATION
```
    See Also:
    
    Constant Field Values
  - NICKNAMES_THRES
```
public static final float NICKNAMES_THRES
```
    See Also:
    
    Constant Field Values
  - RATIO_THRES
```
public static final float RATIO_THRES
```
    See Also:
    
    Constant Field Values
  - NICKNAMES_LIST
```
public static final String NICKNAMES_LIST
```
    See Also:
    
    Constant Field Values
  - ACRONYMS_LIST
```
public static final String ACRONYMS_LIST
```
    See Also:
    
    Constant Field Values
  - SHORTCUTS_LIST
```
public static final String SHORTCUTS_LIST
```
    See Also:
    
    Constant Field Values
  - HONORIFIC_LIST
```
public static final String HONORIFIC_LIST
```
    See Also:
    
    Constant Field Values
  - COUNTRYLANG_LIST
```
public static final String COUNTRYLANG_LIST
```
    See Also:
    
    Constant Field Values
  - PEOPLE_LIST
```
public static final String PEOPLE_LIST
```
    See Also:
    
    Constant Field Values
  - LOCATION_LIST
```
public static final String LOCATION_LIST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EntityComparison
```
public EntityComparison()
                 throws IOException
```
    No-arg constructor that initializes all helper classes with appropriate files and sets the default values for score and reason.
    
    Throws:
    
    IOException
- Method Detail
  - compareNames
```
public HashMap<String,String> compareNames(String name1,
                                           String name2)
```
    Helper function invoked by HashMap compare. It maps the score (0-1) to "SCORE" and the reason to "REASON". Scoring based on the shingling method is mapped to "SHINGLE," although this has been merged to limited extent into the original scoring methods.
    
    Parameters:
    
    name1 - First of the two names being compared
    
    name2 - Second of the two names being compared
    
    Returns:
    
    HashMap with corresponding scores and reasons mapped
  - compare
```
public void compare(String name1,
                    String name2)
```
    Primary helper compare function that converts the comparable strings into NameInfo objects. If no type if given by the user, the type (LOC/PER/ORG/GEN) is inferred without context and scored based on the inferred type. Types that are not GEN and are different are not considered comparable and given a score of 0.
    
    Parameters:
    
    name1 - First of the two names being compared
    
    name2 - Second of the two names being compared
  - compare
```
public HashMap<String,String> compare(HashMap<String,String> mapNames)
```
    Primary method invoked by the user to initiate comparison of two strings. Invokes other helper functions for comparison task.
    
    Parameters:
    
    mapNames - HashMap passed in by the wrapper to access the strings
    
    Returns:
    
    HashMap containing score and reason for the strings being compared
  - getScore
```
public float getScore()
```
    Gets score of the two strings currently being compared.
    
    Returns:
    
    Score from comparing two strings
  - getReason
```
public String getReason()
```
    Gets reason of the two strings currently being compared.
    
    Returns:
    
    Reason for scoring two strings
  - main
```
public static void main(String[] args)
```
  - parseInput
```
public static String[] parseInput(String str)
```
  - getLongForms
```
public List<String> getLongForms(String acronym)
```
  - getAbbreviations
```
public List<String> getAbbreviations(String longName)
```

Class EntityComparison

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCORE

REASON

TERMINATION

NICKNAMES_THRES

RATIO_THRES

NICKNAMES_LIST

ACRONYMS_LIST

SHORTCUTS_LIST

HONORIFIC_LIST

COUNTRYLANG_LIST

PEOPLE_LIST

LOCATION_LIST

Constructor Detail

EntityComparison

Method Detail

compareNames

compare

compare

getScore

getReason

main

parseInput

getLongForms

getAbbreviations