Package org.predict4all.nlp.words.model

Class UserWord

java.lang.Object

org.predict4all.nlp.words.model.AbstractWord

org.predict4all.nlp.words.model.SimpleWord

org.predict4all.nlp.words.model.UserWord

All Implemented Interfaces:

Word

public class UserWord
extends SimpleWord

Field Summary

Fields inherited from class org.predict4all.nlp.words.model.SimpleWord

forceInvalid, forceValid, modifiedBySystem, modifiedByUser, probFactor, word

Fields inherited from interface org.predict4all.nlp.words.model.Word

TYPE_EQUIVALENCE_CLASS, TYPE_NGRAM_TAG, TYPE_SIMPLE, TYPE_USER_WORD

Constructor Summary

Constructors

Constructor	Description
UserWord(int id, String word)
UserWord(int id, String word, double probFactor, boolean forceInvalid, boolean forceValid, long updateDate, int count)

Method Summary

Modifier and Type	Method	Description
Word	clone(int newId)	Create a clone of this word. This allow duplication existing word, an new id should be provided.
static UserWord	create(int id, String word)
static UserWord	create(int id, String word, double probFactor, boolean forceInvalid, boolean forceValid, long updateDate, int count)
long	getLastUseDate()
byte	getType()
int	getUsageCount()
void	incrementUsageCount()	To increase the "usage" count of this word
boolean	isUserWord()
boolean	isValidToBePredicted(PredictionParameter predictionParameter)	To check if this word can be displayed as a prediction result. This typically return true for original words, but can be sensible to computation for user words. This can also return true/false regarding Word.isForceInvalid() or Word.isForceValid() Also, user word are valid for prediction regarding PredictionParameter.getMinUseCountToValidateNewWord()
String	toString()

Methods inherited from class org.predict4all.nlp.words.model.SimpleWord

createModified, getProbFactor, getWord, isForceInvalid, isForceValid, isModifiedBySystem, isModifiedByUser, isModifiedByUserOrSystem, setForceInvalid, setForceValid, setModifiedByUser, setProbFactor

Methods inherited from class org.predict4all.nlp.words.model.AbstractWord

getEquivalenceClass, getEquivalenceClassId, getID, getNGramTag, getNGramTagId, isEquivalenceClass, isNGramTag, isValidForSaving, setModifiedBySystem

Methods inherited from class java.lang.Object

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

Constructor Detail

UserWord

public UserWord(int id,
                String word)

UserWord

public UserWord(int id,
                String word,
                double probFactor,
                boolean forceInvalid,
                boolean forceValid,
                long updateDate,
                int count)

Method Detail

getUsageCount

public int getUsageCount()

Specified by:

getUsageCount in interface Word

Overrides:

getUsageCount in class AbstractWord

Returns:

the number of times this word was seen "used" in user text.
This count is update by WordPredictor when training the dynamic model.

incrementUsageCount

public void incrementUsageCount()

Description copied from interface: Word

To increase the "usage" count of this word

Specified by:

incrementUsageCount in interface Word

Overrides:

incrementUsageCount in class AbstractWord

getLastUseDate

public long getLastUseDate()

Specified by:

getLastUseDate in interface Word

Overrides:

getLastUseDate in class AbstractWord

Returns:

the timestamp of the last usage (typically the last call to Word.incrementUsageCount())

isUserWord

public boolean isUserWord()

Specified by:

isUserWord in interface Word

Overrides:

isUserWord in class AbstractWord

Returns:

true if this word is UserWord instance

isValidToBePredicted

public boolean isValidToBePredicted(PredictionParameter predictionParameter)

Description copied from interface: Word

To check if this word can be displayed as a prediction result.
This typically return true for original words, but can be sensible to computation for user words.
This can also return true/false regarding Word.isForceInvalid() or Word.isForceValid() Also, user word are valid for prediction regarding PredictionParameter.getMinUseCountToValidateNewWord()

Specified by:

isValidToBePredicted in interface Word

Overrides:

isValidToBePredicted in class SimpleWord

Parameters:

predictionParameter - the prediction parameter, could be use to validate the word

Returns:

true if the word can be displayed in prediction result

toString

public String toString()

Overrides:

toString in class AbstractWord

getType

public byte getType()

Specified by:

getType in interface Word

Overrides:

getType in class SimpleWord

Returns:

the byte to save this word type (using TYPE_EQUIVALENCE_CLASS, TYPE_NGRAM_TAG, etc...)
Used in WordFileInputStream and WordFileOutputStream

create

public static UserWord create(int id,
                              String word)

create

public static UserWord create(int id,
                              String word,
                              double probFactor,
                              boolean forceInvalid,
                              boolean forceValid,
                              long updateDate,
                              int count)

clone

public Word clone(int newId)

Description copied from interface: Word

Create a clone of this word.
This allow duplication existing word, an new id should be provided.

Specified by:

clone in interface Word

Overrides:

clone in class SimpleWord

Parameters:

newId - the word new id

Returns:

a clone of this word, with the new id