SoftDictionary (SecondString 0.1 API)

java.lang.Object
- com.wcohen.ss.lookup.SoftDictionary

public class SoftDictionary
extends Object

Looks up nearly-matching strings in a dictionary, using a string distance. A typical use:

 SoftDictionary softDict = new SoftDictionary(new SimpleTokenizer(true,true));
 String alias[] = new String[]{"william cohen", "wwcohen", "einat minkov", "eminkov", .... };
 for (int i=0; i

Constructor Summary

Constructors
Constructor and Description
`SoftDictionary()`
`SoftDictionary(StringDistanceLearner distanceLearner)`
`SoftDictionary(StringDistanceLearner distanceLearner, Tokenizer tokenizer)`
`SoftDictionary(Tokenizer tokenizer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringDistanceTeacher`	`getTeacher()` Return a teacher that can 'train' a distance metric from the information in the dictionary.
`void`	`load(File file)` Insert all lines in a file as items mapping to themselves.
`void`	`load(File file, boolean ids)` Insert all lines in a file as items mapping to themselves.
`void`	`loadAliases(File file)` Load a file of identifiers, each of which has multiple aliases.
`Object`	`lookup(String toFind)` Lookup a string in the dictionary.
`Object`	`lookup(String id, String toFind)` Lookup a string in the dictionary.
`Object`	`lookup(String id, StringWrapper toFind)` Lookup a prepared string in the dictionary.
`Object`	`lookup(StringWrapper toFind)` Lookup a prepared string in the dictionary.
`double`	`lookupDistance(String toFind)` Return the distance to the best match.
`double`	`lookupDistance(String id, String toFind)` Return the distance to the best match.
`double`	`lookupDistance(String id, StringWrapper toFind)` Return the distance to the best match.
`double`	`lookupDistance(StringWrapper toFind)` Return the distance to the best match.
`static void`	`main(String[] argv)` Simple main for testing.
`StringWrapper`	`prepare(String s)` Prepare a string for quicker lookup.
`void`	`put(String string, Object value)` Insert a string into the dictionary.
`void`	`put(String id, String string, Object value)` Insert a string into the dictionary.
`void`	`put(String id, StringWrapper toInsert, Object value)` Insert a prepared string into the dictionary.
`int`	`size()` Return the number of entries in the dictionary.

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

- Constructor Detail
  - SoftDictionary
```
public SoftDictionary()
```
  - SoftDictionary
```
public SoftDictionary(StringDistanceLearner distanceLearner)
```
  - SoftDictionary
```
public SoftDictionary(Tokenizer tokenizer)
```
  - SoftDictionary
```
public SoftDictionary(StringDistanceLearner distanceLearner,
                      Tokenizer tokenizer)
```
- Method Detail
  - size
```
public int size()
```
    Return the number of entries in the dictionary.
  - prepare
```
public StringWrapper prepare(String s)
```
    Prepare a string for quicker lookup.
  - load
```
public void load(File file)
          throws IOException,
                 FileNotFoundException
```
    Insert all lines in a file as items mapping to themselves.
    
    Throws:
    
    IOException
    
    FileNotFoundException
  - load
```
public void load(File file,
                 boolean ids)
          throws IOException,
                 FileNotFoundException
```
    Insert all lines in a file as items mapping to themselves. If 'ids' is true, then make the line number of an item its id.
    This is mostly for testing the id feature.
    
    Throws:
    
    IOException
    
    FileNotFoundException
  - loadAliases
```
public void loadAliases(File file)
                 throws IOException,
                        FileNotFoundException
```
    Load a file of identifiers, each of which has multiple aliases. Each line is a list of tab-separated strings, the first of which is the identifier, the remainder of which are aliases.
    
    Throws:
    
    IOException
    
    FileNotFoundException
  - put
```
public void put(String id,
                String string,
                Object value)
```
    Insert a string into the dictionary.
    Id is a special tag used to handle 'leave one out' lookups. If you do a lookup on a string with a non-null id, you get the closest matches that do not have the same id.
  - put
```
public void put(String string,
                Object value)
```
    Insert a string into the dictionary.
  - put
```
public void put(String id,
                StringWrapper toInsert,
                Object value)
```
    Insert a prepared string into the dictionary.
    Id is a special tag used to handle 'leave one out' lookups. If you do a lookup on a string with a non-null id, you get the closest matches that do not have the same id.
  - lookup
```
public Object lookup(String id,
                     String toFind)
```
    Lookup a string in the dictionary.
    If id is non-null, then consider only strings with different ids (or null ids).
  - lookup
```
public Object lookup(String id,
                     StringWrapper toFind)
```
    Lookup a prepared string in the dictionary.
    If id is non-null, then consider only strings with different ids (or null ids).
  - lookupDistance
```
public double lookupDistance(String id,
                             String toFind)
```
    Return the distance to the best match.
    If id is non-null, then consider only strings with different ids (or null ids).
  - lookupDistance
```
public double lookupDistance(String id,
                             StringWrapper toFind)
```
    Return the distance to the best match.
    If id is non-null, then consider only strings with different ids (or null ids).
  - lookup
```
public Object lookup(String toFind)
```
    Lookup a string in the dictionary.
  - lookup
```
public Object lookup(StringWrapper toFind)
```
    Lookup a prepared string in the dictionary.
  - lookupDistance
```
public double lookupDistance(String toFind)
```
    Return the distance to the best match.
  - lookupDistance
```
public double lookupDistance(StringWrapper toFind)
```
    Return the distance to the best match.
  - getTeacher
```
public StringDistanceTeacher getTeacher()
```
    Return a teacher that can 'train' a distance metric from the information in the dictionary. Since there are no known distances, this means unsupervised training, e.g. accumulating TFIDF weights, etc.
  - main
```
public static void main(String[] argv)
                 throws IOException,
                        FileNotFoundException
```
    Simple main for testing.
    
    Throws:
    
    IOException
    
    FileNotFoundException

Class SoftDictionary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SoftDictionary

SoftDictionary

SoftDictionary

SoftDictionary

Method Detail

size

prepare

load

load

loadAliases

put

put

put

lookup

lookup

lookupDistance

lookupDistance

lookup

lookup

lookupDistance

lookupDistance

getTeacher

main