com.exalead.mot.components

Class WordDictionaryLookup

java.lang.Object

com.exalead.gni.GNIObject

com.exalead.gni.GNINativeObject

com.exalead.mot.components.WordDictionaryLookup

public class WordDictionaryLookup
extends com.exalead.gni.GNINativeObject

Accessor for a WordDictionary

Constructor Summary

Constructors

Constructor and Description
WordDictionaryLookup(WordDictionaryResource resource)
WordDictionaryLookup(WordDictionaryResource resource, boolean useBloomFilter)
WordDictionaryLookup(WordDictionaryResource resource, boolean useBloomFilter, boolean prefix)

Method Summary

Modifier and Type	Method and Description
WordDictionaryEntry[]	approximate(java.lang.String word, int nbElements, int maxDist, int timeoutMS, boolean malusOnFirstLetter) Retrieve each entry whose word is at a maximum edition distance from a specific word
void	destroy()
long	getEntry(java.lang.String word) Retrieve the frequency associated to a word
long	getEntry(java.lang.String word, int lang) Retrieve the frequency associated to a word in a specific language
long	getEntryFromByteArray(byte[] word, int lang) Retrieve the frequency associated to a word in a specific language
FreqDForm	getEntryWithDisplayForm(java.lang.String word) Retrieve the frequency and the unique display form associated to a word
FreqDForm	getEntryWithDisplayForm(java.lang.String word, int lang) Retrieve the frequency and the unique display form associated to a word in a specific language
FreqDForm[]	getEntryWithMultipleDisplayForms(java.lang.String word) Retrieve frequency and the display forms associated to a word
FreqDForm[]	getEntryWithMultipleDisplayForms(java.lang.String word, int lang) Retrieve frequency and the display forms associated to a word
boolean	hasEntry(java.lang.String word) Check if a word is part of the dictionary
boolean	hasEntry(java.lang.String word, int lang) Check if a word in a specific language is part of the dictionary
protected void	init(WordDictionaryResource resource, boolean useBloomFilter, boolean prefix)
WordDictionaryEntry[]	match(java.lang.String word, int nbElements, int timeoutMS) Retrieve each entry whose word matches exactly the input word

Methods inherited from class com.exalead.gni.GNINativeObject

finalize, isNativeNull, nativeFinalize

Methods inherited from class com.exalead.gni.GNIObject

printInternalCppPointer

Methods inherited from class java.lang.Object

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

Constructor Detail

WordDictionaryLookup

public WordDictionaryLookup(WordDictionaryResource resource,
                            boolean useBloomFilter,
                            boolean prefix)

WordDictionaryLookup

public WordDictionaryLookup(WordDictionaryResource resource,
                            boolean useBloomFilter)

WordDictionaryLookup

public WordDictionaryLookup(WordDictionaryResource resource)

Method Detail

hasEntry

public boolean hasEntry(java.lang.String word)

Check if a word is part of the dictionary

Parameters:

word - the word to be tested

Returns:

true if an entry with word and language XX exists

getEntry

public long getEntry(java.lang.String word)

Retrieve the frequency associated to a word

Parameters:

word - the entry to be found

Returns:

the frequency associated to the word

getEntryWithDisplayForm

public FreqDForm getEntryWithDisplayForm(java.lang.String word)

Retrieve the frequency and the unique display form associated to a word

Parameters:

word - the entry to be found

Returns:

an object containing the frequency and the display form associated to the word

getEntryWithMultipleDisplayForms

public FreqDForm[] getEntryWithMultipleDisplayForms(java.lang.String word)

Retrieve frequency and the display forms associated to a word

Parameters:

word - the entry to be found

Returns:

an array of object containing the frequency and the display forms associated to the word

hasEntry

public boolean hasEntry(java.lang.String word,
                        int lang)

Check if a word in a specific language is part of the dictionary

Parameters:

word - the word to be tested

lang - the language of the word

Returns:

true if an entry with word and language lang exists

getEntry

public long getEntry(java.lang.String word,
                     int lang)

Retrieve the frequency associated to a word in a specific language

Parameters:

word - the word to be found

lang - the language of the word

Returns:

the frequency associated to the entry

getEntryFromByteArray

public long getEntryFromByteArray(byte[] word,
                                  int lang)

Retrieve the frequency associated to a word in a specific language

Parameters:

word - the word to be found (as a byte[])

lang - the language of the word

Returns:

the frequency associated to the entry

getEntryWithDisplayForm

public FreqDForm getEntryWithDisplayForm(java.lang.String word,
                                         int lang)

Retrieve the frequency and the unique display form associated to a word in a specific language

Parameters:

word - the entry to be found

lang - the language of the word

Returns:

an object containing the frequency and the display form associated to the word

getEntryWithMultipleDisplayForms

public FreqDForm[] getEntryWithMultipleDisplayForms(java.lang.String word,
                                                    int lang)

Retrieve frequency and the display forms associated to a word

Parameters:

word - the entry to be found

lang - the language of the word

Returns:

an array of object containing the frequency and the display forms associated to the word

approximate

public WordDictionaryEntry[] approximate(java.lang.String word,
                                         int nbElements,
                                         int maxDist,
                                         int timeoutMS,
                                         boolean malusOnFirstLetter)

Retrieve each entry whose word is at a maximum edition distance from a specific word

Parameters:

word - the reference word

nbElements - maximum number of returned entries

maxDist - maximum edition distance

timeoutMS - timeout in milliseconds

malusOnFirstLetter - if true, edition operations on the first letter of the reference word are more expensive

Returns:

match

public WordDictionaryEntry[] match(java.lang.String word,
                                   int nbElements,
                                   int timeoutMS)

Retrieve each entry whose word matches exactly the input word

Parameters:

word - the input word

nbElements - maximum number of returned entries

timeoutMS - timeout in milliseconds

Returns:

an array of matching entries

init

protected void init(WordDictionaryResource resource,
                    boolean useBloomFilter,
                    boolean prefix)

destroy

public void destroy()