com.exalead.mot.components

Class SpellChecker

java.lang.Object

com.exalead.gni.GNIObject

com.exalead.mot.core.Processor

com.exalead.mot.components.SpellChecker

public class SpellChecker
extends Processor

Spell checker

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	resource The processor resource
java.lang.String	secondResource Spell checker second resource (optional)
SpellCheckParameters	spellCheckParameters Spell checker parameters
java.lang.String	tokenizerResource Tokenizer resource name

Fields inherited from class com.exalead.mot.core.Processor

fields, name

Constructor Summary

Constructors

Constructor and Description
SpellChecker(java.lang.String name, java.lang.String resource, java.lang.String fields) Initialize a spell checker
SpellChecker(java.lang.String name, java.lang.String resource, java.lang.String fields, java.lang.String tokenizerResource, SpellCheckParameters spellCheckParameters, java.lang.String secondResource) Initialize a spell checker

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
static java.lang.String	getBlackListTag()
static java.lang.String	getFreqTag()
static java.lang.String	getPhonTag()
static java.lang.String	getTag()
static java.lang.String	getWhiteListTag()
boolean	hasTimedout() Has the last document processing been aborted due to a timeout?
void	init(java.lang.String name, java.lang.String[] fields) Initialize the processor
protected void	init(java.lang.String name, java.lang.String resource, java.lang.String tokenizerResource, java.lang.String[] fields, int maxApprox, double insertion, double deletion, double substitution, double transposition, double first, double blank, double phoneticDist, double precision, int minLengthCandidate, int minLengthCandidate2, int minLengthMultiWordCandidate, int minLengthMultiWordCandidate2, int minLengthInsideMultiWordCandidate, int minLengthInsideMultiWordCandidate2, int minNGramLengthForDist2, boolean filterWhiteList, boolean filterPhonetic, boolean tokenizeResults, int maxSuggestions, boolean allSuggestionsMustAlwaysBeRetrieved, java.lang.String secondResource, int timeout)
void	reconfigure(int maxApprox, double insertion, double deletion, double substitution, double transposition, double first, double blank, double phoneticDist, double precision, int minLengthCandidate, int minLengthCandidate2, int minLengthMultiWordCandidate, int minLengthMultiWordCandidate2, int minLengthInsideMultiWordCandidate, int minLengthInsideMultiWordCandidate2, int minNGramLengthForDist2, boolean filterWhiteList, boolean filterPhonetic, boolean tokenizeResults, int maxSuggestions, boolean allSuggestionsMustAlwaysBeRetrieved, int timeout) Reconfigure the spell checking parameters

Methods inherited from class com.exalead.mot.core.Processor

checkResource, destroy, getName, init

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

Field Detail

resource

public java.lang.String resource

The processor resource

tokenizerResource

public java.lang.String tokenizerResource

Tokenizer resource name

spellCheckParameters

public SpellCheckParameters spellCheckParameters

Spell checker parameters

secondResource

public java.lang.String secondResource

Spell checker second resource (optional)

Constructor Detail

SpellChecker

public SpellChecker(java.lang.String name,
                    java.lang.String resource,
                    java.lang.String fields,
                    java.lang.String tokenizerResource,
                    SpellCheckParameters spellCheckParameters,
                    java.lang.String secondResource)

Initialize a spell checker

Parameters:

name - Its name

resource - The associated resource name

fields - The list of fields on which it's active

tokenizerResource - Tokenizer resource name

spellCheckParameters - Spell checker parameters

secondResource - Spell checker second resource (optional)

SpellChecker

public SpellChecker(java.lang.String name,
                    java.lang.String resource,
                    java.lang.String fields)

Initialize a spell checker

Parameters:

name - Its name

resource - The associated resource name

fields - The list of fields on which it's active

Method Detail

init

public void init(java.lang.String name,
                 java.lang.String[] fields)

Initialize the processor

Specified by:

init in class Processor

Parameters:

name - Its name

fields - The list of fields on which it's active

init

protected void init(java.lang.String name,
                    java.lang.String resource,
                    java.lang.String tokenizerResource,
                    java.lang.String[] fields,
                    int maxApprox,
                    double insertion,
                    double deletion,
                    double substitution,
                    double transposition,
                    double first,
                    double blank,
                    double phoneticDist,
                    double precision,
                    int minLengthCandidate,
                    int minLengthCandidate2,
                    int minLengthMultiWordCandidate,
                    int minLengthMultiWordCandidate2,
                    int minLengthInsideMultiWordCandidate,
                    int minLengthInsideMultiWordCandidate2,
                    int minNGramLengthForDist2,
                    boolean filterWhiteList,
                    boolean filterPhonetic,
                    boolean tokenizeResults,
                    int maxSuggestions,
                    boolean allSuggestionsMustAlwaysBeRetrieved,
                    java.lang.String secondResource,
                    int timeout)

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

reconfigure

public void reconfigure(int maxApprox,
                        double insertion,
                        double deletion,
                        double substitution,
                        double transposition,
                        double first,
                        double blank,
                        double phoneticDist,
                        double precision,
                        int minLengthCandidate,
                        int minLengthCandidate2,
                        int minLengthMultiWordCandidate,
                        int minLengthMultiWordCandidate2,
                        int minLengthInsideMultiWordCandidate,
                        int minLengthInsideMultiWordCandidate2,
                        int minNGramLengthForDist2,
                        boolean filterWhiteList,
                        boolean filterPhonetic,
                        boolean tokenizeResults,
                        int maxSuggestions,
                        boolean allSuggestionsMustAlwaysBeRetrieved,
                        int timeout)

Reconfigure the spell checking parameters

hasTimedout

public boolean hasTimedout()

Has the last document processing been aborted due to a timeout?

getTag

public static java.lang.String getTag()

getFreqTag

public static java.lang.String getFreqTag()

getWhiteListTag

public static java.lang.String getWhiteListTag()

getBlackListTag

public static java.lang.String getBlackListTag()

getPhonTag

public static java.lang.String getPhonTag()