Package com.gengoai.hermes.lexicon

Class LexiconEntry

java.lang.Object

com.gengoai.hermes.lexicon.LexiconEntry

All Implemented Interfaces:

Serializable, Comparable<LexiconEntry>

public class LexiconEntry
extends Object
implements Serializable, Comparable<LexiconEntry>

An entry in a lexicon defining the lemma, probability, tag, and any constraints on matching

Author:

David B. Bracewell

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static int	calculateTokenLength(@NonNull String phrase, @NonNull Language language)	Helper method for calculating the length in tokens of a phrase for a given language.
int	compareTo(LexiconEntry o)
static LexiconEntry	empty()	Empty lexicon entry.
static LexiconEntry	of(@NonNull String lemma, double probability, int tokenLength)	Constructs a LexiconEntry for the given lemma which has the given probability and token length.
static LexiconEntry	of(@NonNull String lemma, double probability, String tag, int tokenLength)	Constructs a LexiconEntry for the given lemma which has the given probability, tag, and token length.
static LexiconEntry	of(@NonNull String lemma, double probability, String tag, LyreExpression constraint, int tokenLength)	Constructs a LexiconEntry for the given lemma which has the given probability, tag, constraint, and token length.
static LexiconEntry	of(@NonNull String lemma, int tokenLength)	Constructs a LexiconEntry for the given lemma which has the given token length.
static LexiconEntry	of(@NonNull String lemma, String tag, int tokenLength)	Constructs a LexiconEntry for the given lemma which has the given tag and token length.

Methods inherited from class java.lang.Object

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

Method Detail

calculateTokenLength

public static int calculateTokenLength(@NonNull
                                       @NonNull String phrase,
                                       @NonNull
                                       @NonNull Language language)

Helper method for calculating the length in tokens of a phrase for a given language.

Parameters:

phrase - the phrase

language - the language

Returns:

the number of tokens in the phrase.

empty

public static LexiconEntry empty()

Empty lexicon entry.

Returns:

the lexicon entry

of

public static LexiconEntry of(@NonNull
                              @NonNull String lemma,
                              int tokenLength)

Constructs a LexiconEntry for the given lemma which has the given token length.

Parameters:

lemma - the lemma

tokenLength - the token length

Returns:

the lexicon entry

of

public static LexiconEntry of(@NonNull
                              @NonNull String lemma,
                              double probability,
                              String tag,
                              int tokenLength)

Constructs a LexiconEntry for the given lemma which has the given probability, tag, and token length.

Parameters:

lemma - the lemma

probability - the probability

tag - the tag

tokenLength - the token length

Returns:

the lexicon entry

of

public static LexiconEntry of(@NonNull
                              @NonNull String lemma,
                              double probability,
                              String tag,
                              LyreExpression constraint,
                              int tokenLength)

Constructs a LexiconEntry for the given lemma which has the given probability, tag, constraint, and token length.

Parameters:

lemma - the lemma

probability - the probability

tag - the tag

constraint - the constraint

tokenLength - the token length

Returns:

the lexicon entry

of

public static LexiconEntry of(@NonNull
                              @NonNull String lemma,
                              double probability,
                              int tokenLength)

Constructs a LexiconEntry for the given lemma which has the given probability and token length.

Parameters:

lemma - the lemma

probability - the probability

tokenLength - the token length

Returns:

the lexicon entry

of

public static LexiconEntry of(@NonNull
                              @NonNull String lemma,
                              String tag,
                              int tokenLength)

Constructs a LexiconEntry for the given lemma which has the given tag and token length.

Parameters:

lemma - the lemma

tag - the tag

tokenLength - the token length

Returns:

the lexicon entry

compareTo

public int compareTo(LexiconEntry o)

Specified by:

compareTo in interface Comparable<LexiconEntry>