edu.cmu.sphinx.linguist.dictionary
Class FullDictionary

java.lang.Object
  edu.cmu.sphinx.linguist.dictionary.FullDictionary

All Implemented Interfaces:

Dictionary, Configurable

public class FullDictionary
extends java.lang.Object
implements Dictionary

Creates a dictionary by reading in an ASCII-based Sphinx-3 format dictionary. Each line of the dictionary specifies the word, followed by spaces or tab, followed by the pronuncation (by way of the list of phones) of the word. Each word can have more than one pronunciations. For example, a digits dictionary will look like:

 ONE                  HH W AH N
 ONE(2)               W AH N
 TWO                  T UW
 THREE                TH R IY
 FOUR                 F AO R
 FIVE                 F AY V
 SIX                  S IH K S
 SEVEN                S EH V AH N
 EIGHT                EY T
 NINE                 N AY N
 ZERO                 Z IH R OW
 ZERO(2)              Z IY R OW
 OH                   OW
 

In the above example, the words "one" and "zero" have two pronunciations each.

This dictionary will read in all the words and its pronunciation(s) at startup. Therefore, if the dictionary is big, it will take longer to load and will consume more memory.

Field Summary

Fields inherited from interface edu.cmu.sphinx.linguist.dictionary.Dictionary

PROP_ADD_SIL_ENDING_PRONUNCIATION, PROP_ALLOW_MISSING_WORDS, PROP_CREATE_MISSING_WORDS, PROP_DICTIONARY, PROP_FILLER_DICTIONARY, PROP_LOCATION, PROP_UNIT_MANAGER, PROP_WORD_REPLACEMENT, SENTENCE_END_SPELLING, SENTENCE_START_SPELLING, SILENCE_SPELLING

Constructor Summary

FullDictionary()

Method Summary

void	allocate() Allocates the dictionary
void	deallocate() Deallocates the dictionary
java.net.URL	getFillerDictionaryFile() Get the filler dictionary file
Word[]	getFillerWords() Gets the set of all filler words in the dictionary
java.lang.String	getName()
WordClassification[]	getPossibleWordClassifications() Returns the set of all possible word classifications for this dictionary.
Word	getSentenceEndWord() Returns the sentence end word.
Word	getSentenceStartWord() Returns the sentence start word.
Word	getSilenceWord() Returns the silence word.
Word	getWord(java.lang.String text) Returns a Word object based on the spelling and its classification.
java.net.URL	getWordDictionaryFile() Get the word dictionary file
void	newProperties(PropertySheet ps) This method is called when this configurable component needs to be reconfigured.
java.lang.String	toString() Returns a string representation of this FullDictionary in alphabetical order.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FullDictionary

public FullDictionary()

Method Detail

newProperties

public void newProperties(PropertySheet ps)
                   throws PropertyException

Description copied from interface: Configurable

This method is called when this configurable component needs to be reconfigured.

Specified by:

newProperties in interface Configurable

Parameters:

ps - a property sheet holding the new data

Throws:

PropertyException - if there is a problem with the properties.

getName

public java.lang.String getName()

allocate

public void allocate()
              throws java.io.IOException

Description copied from interface: Dictionary

Allocates the dictionary

Specified by:

allocate in interface Dictionary

Throws:

java.io.IOException - if there is trouble loading the dictionary

deallocate

public void deallocate()

Description copied from interface: Dictionary

Deallocates the dictionary

Specified by:

deallocate in interface Dictionary

getWord

public Word getWord(java.lang.String text)

Returns a Word object based on the spelling and its classification. The behavior of this method is affected by the properties wordReplacement, allowMissingWords, and createMissingWords.

Specified by:

getWord in interface Dictionary

Parameters:

text - the spelling of the word of interest.

Returns:

a Word object

See Also:

Word

getSentenceStartWord

public Word getSentenceStartWord()

Returns the sentence start word.

Specified by:

getSentenceStartWord in interface Dictionary

Returns:

the sentence start word

getSentenceEndWord

public Word getSentenceEndWord()

Returns the sentence end word.

Specified by:

getSentenceEndWord in interface Dictionary

Returns:

the sentence end word

getSilenceWord

public Word getSilenceWord()

Returns the silence word.

Specified by:

getSilenceWord in interface Dictionary

Returns:

the silence word

getPossibleWordClassifications

public WordClassification[] getPossibleWordClassifications()

Returns the set of all possible word classifications for this dictionary.

Specified by:

getPossibleWordClassifications in interface Dictionary

Returns:

the set of all possible word classifications

getWordDictionaryFile

public java.net.URL getWordDictionaryFile()

Get the word dictionary file

Returns:

the URL of the word dictionary file

getFillerDictionaryFile

public java.net.URL getFillerDictionaryFile()

Get the filler dictionary file

Returns:

the URL of the filler dictionary file

toString

public java.lang.String toString()

Returns a string representation of this FullDictionary in alphabetical order.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this FullDictionary

getFillerWords

public Word[] getFillerWords()

Gets the set of all filler words in the dictionary

Specified by:

getFillerWords in interface Dictionary

Returns:

an array (possibly empty) of all filler words