Package org.predict4all.nlp.words.model

Class SimpleWord

java.lang.Object

org.predict4all.nlp.words.model.AbstractWord

org.predict4all.nlp.words.model.SimpleWord

All Implemented Interfaces:

Word

Direct Known Subclasses:

UserWord

public class SimpleWord
extends AbstractWord

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	forceInvalid
protected boolean	forceValid
protected boolean	modifiedBySystem
protected boolean	modifiedByUser
protected double	probFactor
protected String	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

Modifier	Constructor	Description
protected	SimpleWord(int id, String word)
protected	SimpleWord(int id, String word, boolean modifiedByUser, boolean modifiedBySystem, double probFactor, boolean forceInvalid, boolean forceValid)

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 SimpleWord	create(int id, String word)
static SimpleWord	createModified(int id, String word, boolean modifiedByUser, boolean modifiedBySystem, double probFactor, boolean forceInvalid, boolean forceValid)
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
byte	getType()
String	getWord()
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	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	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

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

getEquivalenceClass, getEquivalenceClassId, getID, getLastUseDate, getNGramTag, getNGramTagId, getUsageCount, incrementUsageCount, isEquivalenceClass, isNGramTag, isUserWord, isValidForSaving, setModifiedBySystem, toString

Methods inherited from class java.lang.Object

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

Field Detail

word

protected final String word

probFactor

protected double probFactor

modifiedByUser

protected boolean modifiedByUser

modifiedBySystem

protected boolean modifiedBySystem

forceValid

protected boolean forceValid

forceInvalid

protected boolean forceInvalid

Constructor Detail

SimpleWord

protected SimpleWord(int id,
                     String word)

SimpleWord

protected SimpleWord(int id,
                     String word,
                     boolean modifiedByUser,
                     boolean modifiedBySystem,
                     double probFactor,
                     boolean forceInvalid,
                     boolean forceValid)

Method Detail

getWord

public String getWord()

Returns:

this word "word" ! Can sometimes be null if the word represent a concept more than a real word (e.g. EquivalenceClassWord or TagWord)

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 AbstractWord

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

Overrides:

getProbFactor in class AbstractWord

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

Overrides:

setProbFactor in class AbstractWord

Parameters:

factor - the prob factor

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

getType

public byte getType()

Returns:

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

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

Overrides:

isModifiedByUser in class AbstractWord

Returns:

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

Overrides:

isModifiedBySystem in class AbstractWord

Returns:

modification by system 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

Overrides:

setModifiedByUser in class AbstractWord

Parameters:

modified - modification by user flag

isModifiedByUserOrSystem

public boolean isModifiedByUserOrSystem()

Specified by:

isModifiedByUserOrSystem in interface Word

Overrides:

isModifiedByUserOrSystem in class AbstractWord

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

Overrides:

isForceValid in class AbstractWord

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

Overrides:

setForceValid in class AbstractWord

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

Overrides:

isForceInvalid in class AbstractWord

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

Overrides:

setForceInvalid in class AbstractWord

Parameters:

forceInvalid - force invalid enabled

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

create

public static SimpleWord create(int id,
                                String word)

createModified

public static SimpleWord createModified(int id,
                                        String word,
                                        boolean modifiedByUser,
                                        boolean modifiedBySystem,
                                        double probFactor,
                                        boolean forceInvalid,
                                        boolean forceValid)

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.

Parameters:

newId - the word new id

Returns:

a clone of this word, with the new id