All Known Implementing Classes:

AbstractWord, EquivalenceClassWord, SimpleWord, TagWord, UserWord
```
public interface Word
```
Represent a word stored in a WordDictionary - word are stored with a int ID to optimize memory usage. Word can be special (EquivalenceClassWord or simple. SimpleWord are firstly got from trained data, but then UserWord can be added from user vocabulary.
Word type is not specialized as it contains every type methods (e.g. getNGramTag() even for SimpleWord) but it is done to optimized runtime performance (avoid instanceof)

Field Summary

Fields
Modifier and Type Field Description

static byte TYPE_EQUIVALENCE_CLASS

static byte TYPE_NGRAM_TAG

static byte TYPE_SIMPLE

static byte TYPE_USER_WORD

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Word`	`clone(int newId)`
`int`	`getCount()`
`EquivalenceClass`	`getEquivalenceClass()`
`byte`	`getEquivalenceClassId()`
`int`	`getID()`
`Tag`	`getNGramTag()`
`byte`	`getNGramTagId()`
`double`	`getProbFactor()`
`byte`	`getType()`
`long`	`getUpdateDate()`
`java.lang.String`	`getWord()`
`void`	`increment()`
`boolean`	`isEquivalenceClass()`
`boolean`	`isForceInvalid()`
`boolean`	`isForceValid()`
`boolean`	`isModifiedBySystem()`
`boolean`	`isModifiedByUser()`
`boolean`	`isModifiedByUserOrSystem()`
`boolean`	`isNGramTag()`
`boolean`	`isUserWord()`
`boolean`	`isValidForSaving()`
`boolean`	`isValidToBePredicted(PredictionParameter predictionParameter)`
`boolean`	`isValidToPredictionContext(PredictionParameter predictionParameter)`
`void`	`setForceInvalid(boolean forceInvalid, boolean modificationByUser)`
`void`	`setForceValid(boolean forceValid, boolean modificationByUser)`
`void`	`setModifiedBySystem(boolean modifiedBySystem)`
`void`	`setModifiedByUser(boolean modifiedByUser)`
`void`	`setProbFactor(double factor, boolean modificationByUser)`
`boolean`	`startsWith(java.lang.String longestWordPrefix)`

Field Detail
- TYPE_EQUIVALENCE_CLASS
```
static final byte TYPE_EQUIVALENCE_CLASS
```
  See Also:
  
  Constant Field Values
- TYPE_NGRAM_TAG
```
static final byte TYPE_NGRAM_TAG
```
  See Also:
  
  Constant Field Values
- TYPE_SIMPLE
```
static final byte TYPE_SIMPLE
```
  See Also:
  
  Constant Field Values
- TYPE_USER_WORD
```
static final byte TYPE_USER_WORD
```
  See Also:
  
  Constant Field Values

Method Detail

getID
```
int getID()
```

getWord
```
java.lang.String getWord()
```

isNGramTag
```
boolean isNGramTag()
```

getEquivalenceClassId
```
byte getEquivalenceClassId()
```

startsWith

boolean startsWith(java.lang.String longestWordPrefix)

getEquivalenceClass
```
EquivalenceClass getEquivalenceClass()
```

isEquivalenceClass
```
boolean isEquivalenceClass()
```

getNGramTagId
```
byte getNGramTagId()
```

getNGramTag
```
Tag getNGramTag()
```

isUserWord
```
boolean isUserWord()
```

isValidForSaving
```
boolean isValidForSaving()
```

isValidToPredictionContext

boolean isValidToPredictionContext(PredictionParameter predictionParameter)

isValidToBePredicted

boolean isValidToBePredicted(PredictionParameter predictionParameter)

getProbFactor
```
double getProbFactor()
```

setProbFactor

void setProbFactor(double factor,
                   boolean modificationByUser)

getType
```
byte getType()
```

isModifiedByUser
```
boolean isModifiedByUser()
```

setModifiedByUser

void setModifiedByUser(boolean modifiedByUser)

isModifiedBySystem
```
boolean isModifiedBySystem()
```

setModifiedBySystem

void setModifiedBySystem(boolean modifiedBySystem)

isModifiedByUserOrSystem
```
boolean isModifiedByUserOrSystem()
```

isForceValid
```
boolean isForceValid()
```

setForceValid

void setForceValid(boolean forceValid,
                   boolean modificationByUser)

isForceInvalid
```
boolean isForceInvalid()
```

setForceInvalid

void setForceInvalid(boolean forceInvalid,
                     boolean modificationByUser)

getCount
```
int getCount()
```

increment
```
void increment()
```

getUpdateDate
```
long getUpdateDate()
```

clone
```
Word clone(int newId)
```

Modifier and Type	Field	Description
`static byte`	`TYPE_EQUIVALENCE_CLASS`
`static byte`	`TYPE_NGRAM_TAG`
`static byte`	`TYPE_SIMPLE`
`static byte`	`TYPE_USER_WORD`

Interface Word

Field Summary

Method Summary

Field Detail

TYPE_EQUIVALENCE_CLASS

TYPE_NGRAM_TAG

TYPE_SIMPLE

TYPE_USER_WORD

Method Detail

getID

getWord

isNGramTag

getEquivalenceClassId

startsWith

getEquivalenceClass

isEquivalenceClass

getNGramTagId

getNGramTag

isUserWord

isValidForSaving

isValidToPredictionContext

isValidToBePredicted

getProbFactor

setProbFactor

getType

isModifiedByUser

setModifiedByUser

isModifiedBySystem

setModifiedBySystem

isModifiedByUserOrSystem

isForceValid

setForceValid

isForceInvalid

setForceInvalid

getCount

increment

getUpdateDate

clone