edu.cmu.sphinx.linguist.dictionary

Class Word

java.lang.Object

edu.cmu.sphinx.linguist.dictionary.Word

All Implemented Interfaces:

java.lang.Comparable<Word>

public class Word
extends java.lang.Object
implements java.lang.Comparable<Word>

Represents a word, its spelling and its pronunciation.

Field Summary

Fields

Modifier and Type	Field and Description
static Word	UNKNOWN The Word representing the unknown word.

Constructor Summary

Constructors

Constructor and Description
Word(java.lang.String spelling, Pronunciation[] pronunciations, boolean isFiller) Creates a Word

Method Summary

Modifier and Type	Method and Description
int	compareTo(Word other)
boolean	equals(java.lang.Object obj)
Pronunciation	getMostLikelyPronunciation() Get the highest probability pronunciation for a word
Pronunciation[]	getPronunciations() Retrieves the pronunciations of this word
java.lang.String	getSpelling() Returns the spelling of the word.
int	hashCode()
boolean	isFiller() Determines if this is a filler word
boolean	isSentenceEndWord() Returns true if this word is an end of sentence word
boolean	isSentenceStartWord() Returns true if this word is a start of sentence word
java.lang.String	toString() Returns a string representation of this word, which is the spelling

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN

public static final Word UNKNOWN

The Word representing the unknown word.

Constructor Detail

Word

public Word(java.lang.String spelling,
            Pronunciation[] pronunciations,
            boolean isFiller)

Creates a Word

Parameters:

spelling - the spelling of this word

pronunciations - the pronunciations of this word

isFiller - true if the word is a filler word

Method Detail

getSpelling

public java.lang.String getSpelling()

Returns the spelling of the word.

Returns:

the spelling of the word

isFiller

public boolean isFiller()

Determines if this is a filler word

Returns:

true if this word is a filler word, otherwise it returns false

isSentenceEndWord

public boolean isSentenceEndWord()

Returns true if this word is an end of sentence word

Returns:

true if the word matches Dictionary.SENTENCE_END_SPELLING

isSentenceStartWord

public boolean isSentenceStartWord()

Returns true if this word is a start of sentence word

Returns:

true if the word matches Dictionary.SENTENCE_START_SPELLING

getPronunciations

public Pronunciation[] getPronunciations()

Retrieves the pronunciations of this word

Returns:

the pronunciations of this word

getMostLikelyPronunciation

public Pronunciation getMostLikelyPronunciation()

Get the highest probability pronunciation for a word

Returns:

the highest probability pronunciation

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Returns a string representation of this word, which is the spelling

Overrides:

toString in class java.lang.Object

Returns:

the spelling of this word

compareTo

public int compareTo(Word other)

Specified by:

compareTo in interface java.lang.Comparable<Word>