Package org.predict4all.nlp.words.model

Class AbstractWord

java.lang.Object

org.predict4all.nlp.words.model.AbstractWord

All Implemented Interfaces:

Word

Direct Known Subclasses:

EquivalenceClassWord, SimpleWord, TagWord

public abstract class AbstractWord
extends Object
implements Word

Field Summary

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
AbstractWord(int id)

Method Summary

Modifier and Type	Method	Description
EquivalenceClass	getEquivalenceClass()
byte	getEquivalenceClassId()
int	getID()
long	getLastUseDate()
Tag	getNGramTag()
byte	getNGramTagId()
double	getProbFactor()	This factor can be used to modify final probabilities of the predictions. It will be applied once probabilities are computed to influence result list. It is mainly used in a multiplication with the original probability (and then the result list is normalized). To only rely on probabilities, the value should be 1.0
int	getUsageCount()
void	incrementUsageCount()	To increase the "usage" count of this word
boolean	isEquivalenceClass()
boolean	isForceInvalid()	To force that this word is invalid. In fact, this method allow removal of a word from prediction result : words can't be removed from dictionary as they can be used in ngrams, but having forceInvalid true has the same effect than removing a word.
boolean	isForceValid()	To force that this word become valid, mostly use on UserWord to ignore validation.
boolean	isModifiedBySystem()	Indicate that this word was modified by the system (e.g. calling a modification method with modificationByUser parameter to false)
boolean	isModifiedByUser()	Indicate that this word was modified by the user (e.g. calling a modification method with modificationByUser parameter to true)
boolean	isModifiedByUserOrSystem()
boolean	isNGramTag()
boolean	isUserWord()
boolean	isValidForSaving()
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()
void	setForceInvalid(boolean forceInvalid, boolean modificationByUser)	To force that this word is invalid. In fact, this method allow removal of a word from prediction result : words can't be removed from dictionary as they can be used in ngrams, but having forceInvalid true has the same effect than removing a word.
void	setForceValid(boolean forceValid, boolean modificationByUser)	To force that this word become valid, mostly use on UserWord to ignore validation.
void	setModifiedBySystem(boolean modifiedBySystem)	To manually set modification by system flag
void	setModifiedByUser(boolean modified)	To manually set modification by user flag
void	setProbFactor(double factor, boolean modificationByUser)	This factor can be used to modify final probabilities of the predictions. It will be applied once probabilities are computed to influence result list. It is mainly used in a multiplication with the original probability (and then the result list is normalized). To only rely on probabilities, the value should be 1.0
String	toString()

Methods inherited from class java.lang.Object

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

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

clone, getType, getWord

Constructor Detail

AbstractWord

public AbstractWord(int id)

Method Detail

getID

public int getID()

Specified by:

getID in interface Word

Returns:

this word ID : use int as it's the lowest memory foot print primitive to store enough word

getEquivalenceClass

public EquivalenceClass getEquivalenceClass()

Specified by:

getEquivalenceClass in interface Word

Returns:

the equivalence class represented by this word (only if Word.isEquivalenceClass())

isEquivalenceClass

public boolean isEquivalenceClass()

Specified by:

isEquivalenceClass in interface Word

Returns:

true if this word is EquivalenceClassWord instance

getEquivalenceClassId

public byte getEquivalenceClassId()

Specified by:

getEquivalenceClassId in interface Word

Returns:

the equivalence class id represented by this word (only if Word.isEquivalenceClass())

isNGramTag

public boolean isNGramTag()

Specified by:

isNGramTag in interface Word

Returns:

true if this word is TagWord instance

getNGramTagId

public byte getNGramTagId()

Specified by:

getNGramTagId in interface Word

Returns:

the ngram tag id represented by this word (only if Word.isNGramTag())

getNGramTag

public Tag getNGramTag()

Specified by:

getNGramTag in interface Word

Returns:

the ngram tag represented by this word (only if Word.isNGramTag())

toString

public String toString()

Overrides:

toString in class Object

isUserWord

public boolean isUserWord()

Specified by:

isUserWord in interface Word

Returns:

true if this word is UserWord instance

isValidForSaving

public boolean isValidForSaving()

Specified by:

isValidForSaving in interface Word

Returns:

true if this world should be saved (in both original and user dictionary)

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

Parameters:

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

Returns:

true if the word can be displayed in prediction result

getProbFactor

public double getProbFactor()

Description copied from interface: Word

This factor can be used to modify final probabilities of the predictions.
It will be applied once probabilities are computed to influence result list.
It is mainly used in a multiplication with the original probability (and then the result list is normalized).
To only rely on probabilities, the value should be 1.0

Specified by:

getProbFactor in interface Word

Returns:

the prob factor

setProbFactor

public void setProbFactor(double factor,
                          boolean modificationByUser)

Description copied from interface: Word

This factor can be used to modify final probabilities of the predictions.
It will be applied once probabilities are computed to influence result list.
It is mainly used in a multiplication with the original probability (and then the result list is normalized).
To only rely on probabilities, the value should be 1.0

Specified by:

setProbFactor in interface Word

Parameters:

factor - the prob factor

modificationByUser - true indicates that the modification was done by the user and not the system

isModifiedByUser

public boolean isModifiedByUser()

Description copied from interface: Word

Indicate that this word was modified by the user (e.g. calling a modification method with modificationByUser parameter to true)

Specified by:

isModifiedByUser in interface Word

Returns:

modification by user flag

setModifiedByUser

public void setModifiedByUser(boolean modified)

Description copied from interface: Word

To manually set modification by user flag

Specified by:

setModifiedByUser in interface Word

Parameters:

modified - modification by user flag

isModifiedBySystem

public boolean isModifiedBySystem()

Description copied from interface: Word

Indicate that this word was modified by the system (e.g. calling a modification method with modificationByUser parameter to false)

Specified by:

isModifiedBySystem in interface Word

Returns:

modification by system flag

setModifiedBySystem

public void setModifiedBySystem(boolean modifiedBySystem)

Description copied from interface: Word

To manually set modification by system flag

Specified by:

setModifiedBySystem in interface Word

Parameters:

modifiedBySystem - modification by system flag

isModifiedByUserOrSystem

public boolean isModifiedByUserOrSystem()

Specified by:

isModifiedByUserOrSystem in interface Word

Returns:

true if Word.isModifiedByUser() or Word.isModifiedBySystem()

isForceValid

public boolean isForceValid()

Description copied from interface: Word

To force that this word become valid, mostly use on UserWord to ignore validation.

Specified by:

isForceValid in interface Word

Returns:

force valid enabled

setForceValid

public void setForceValid(boolean forceValid,
                          boolean modificationByUser)

Description copied from interface: Word

To force that this word become valid, mostly use on UserWord to ignore validation.

Specified by:

setForceValid in interface Word

Parameters:

forceValid - force valid enabled

modificationByUser - true indicates that the modification was done by the user and not the system

isForceInvalid

public boolean isForceInvalid()

Description copied from interface: Word

To force that this word is invalid.
In fact, this method allow removal of a word from prediction result : words can't be removed from dictionary as they can be used in ngrams, but having forceInvalid true has the same effect than removing a word.

Specified by:

isForceInvalid in interface Word

Returns:

force invalid enabled

setForceInvalid

public void setForceInvalid(boolean forceInvalid,
                            boolean modificationByUser)

Description copied from interface: Word

To force that this word is invalid.
In fact, this method allow removal of a word from prediction result : words can't be removed from dictionary as they can be used in ngrams, but having forceInvalid true has the same effect than removing a word.

Specified by:

setForceInvalid in interface Word

Parameters:

forceInvalid - force invalid enabled

modificationByUser - true indicates that the modification was done by the user and not the system

getUsageCount

public int getUsageCount()

Specified by:

getUsageCount in interface Word

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

getLastUseDate

public long getLastUseDate()

Specified by:

getLastUseDate in interface Word

Returns:

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