edu.cmu.sphinx.linguist.dictionary

Interface Dictionary

All Superinterfaces:

Configurable

All Known Implementing Classes:

ClassPresentingDictionary, MappingDictionary, TextDictionary, TrainerDictionary

public interface Dictionary
extends Configurable

Provides a generic interface to a dictionary. The dictionary is responsible for determining how a word is pronounced.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_ADDENDA The property for the custom dictionary file paths.
static java.lang.String	PROP_DICTIONARY The property for the dictionary file path.
static java.lang.String	PROP_FILLER_DICTIONARY The property for the filler dictionary file path.
static java.lang.String	PROP_G2P_MAX_PRONUNCIATIONS The property for the g2p model file path.
static java.lang.String	PROP_G2P_MODEL_PATH The property for the g2p model file path.
static java.lang.String	PROP_UNIT_MANAGER The property that defines the name of the unit manager that is used to convert strings to Unit objects
static java.lang.String	PROP_WORD_REPLACEMENT The property that specifies the word to substitute when a lookup fails to find the word in the dictionary.
static java.lang.String	SENTENCE_END_SPELLING Spelling of the sentence end word.
static java.lang.String	SENTENCE_START_SPELLING Spelling of the sentence start word.
static java.lang.String	SILENCE_SPELLING Spelling of the 'word' that marks a silence

Method Summary

Modifier and Type	Method and Description
void	allocate() Allocates the dictionary
void	deallocate() Deallocates the dictionary
Word[]	getFillerWords() Gets the set of all filler words in the 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.

Methods inherited from interface edu.cmu.sphinx.util.props.Configurable

newProperties

Field Detail

SENTENCE_START_SPELLING

static final java.lang.String SENTENCE_START_SPELLING

Spelling of the sentence start word.

See Also:

Constant Field Values

SENTENCE_END_SPELLING

static final java.lang.String SENTENCE_END_SPELLING

Spelling of the sentence end word.

See Also:

Constant Field Values

SILENCE_SPELLING

static final java.lang.String SILENCE_SPELLING

Spelling of the 'word' that marks a silence

See Also:

Constant Field Values

PROP_DICTIONARY

@S4String
static final java.lang.String PROP_DICTIONARY

The property for the dictionary file path.

See Also:

Constant Field Values

PROP_G2P_MODEL_PATH

@S4String(defaultValue="")
static final java.lang.String PROP_G2P_MODEL_PATH

The property for the g2p model file path.

See Also:

Constant Field Values

PROP_G2P_MAX_PRONUNCIATIONS

@S4Integer(defaultValue=1)
static final java.lang.String PROP_G2P_MAX_PRONUNCIATIONS

The property for the g2p model file path.

See Also:

Constant Field Values

PROP_FILLER_DICTIONARY

@S4String
static final java.lang.String PROP_FILLER_DICTIONARY

The property for the filler dictionary file path.

See Also:

Constant Field Values

PROP_WORD_REPLACEMENT

@S4String(mandatory=false)
static final java.lang.String PROP_WORD_REPLACEMENT

The property that specifies the word to substitute when a lookup fails to find the word in the dictionary. If this is not set, no substitute is performed.

See Also:

Constant Field Values

PROP_UNIT_MANAGER

@S4Component(type=UnitManager.class,
             defaultClass=UnitManager.class)
static final java.lang.String PROP_UNIT_MANAGER

The property that defines the name of the unit manager that is used to convert strings to Unit objects

See Also:

Constant Field Values

PROP_ADDENDA

@S4String(mandatory=false)
static final java.lang.String PROP_ADDENDA

The property for the custom dictionary file paths. This addenda property points to a possibly empty list of URLs to dictionary addenda. Each addendum should contain word pronunciations in the same Sphinx-3 dictionary format as the main dictionary. Words in the addendum are added after the words in the main dictionary and will override previously specified pronunciations. If you wish to extend the set of pronunciations for a particular word, add a new pronunciation by number. For example, in the following addendum, given that the aforementioned main dictionary is specified, the pronunciation for 'EIGHT' will be overridden by the addenda, while the pronunciation for 'SIX' and 'ZERO' will be augmented and a new pronunciation for 'ELEVEN' will be added.

          EIGHT   OW T
          SIX(2)  Z IH K S
          ZERO(3)  Z IY Rl AH
          ELEVEN   EH L EH V AH N
 

See Also:

Constant Field Values

Method Detail

getWord

Word getWord(java.lang.String text)

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

Parameters:

text - the spelling of the word of interest.

Returns:

a Word object

See Also:

Pronunciation

getSentenceStartWord

Word getSentenceStartWord()

Returns the sentence start word.

Returns:

the sentence start word

getSentenceEndWord

Word getSentenceEndWord()

Returns the sentence end word.

Returns:

the sentence end word

getSilenceWord

Word getSilenceWord()

Returns the silence word.

Returns:

the silence word

getFillerWords

Word[] getFillerWords()

Gets the set of all filler words in the dictionary

Returns:

an array (possibly empty) of all filler words

allocate

void allocate()
       throws java.io.IOException

Allocates the dictionary

Throws:

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

deallocate

void deallocate()

Deallocates the dictionary