edu.cmu.sphinx.linguist.dictionary
Class Pronunciation

java.lang.Object
  extended byedu.cmu.sphinx.linguist.dictionary.Pronunciation

public class Pronunciation
extends java.lang.Object

Provides pronunciation information for a word.


Field Summary
static Pronunciation UNKNOWN
           
 
Method Summary
 void dump()
          Dumps a pronunciation
 float getProbability()
          Retrieves the probability for the pronunciation.
 java.lang.String getTag()
          Retrieves the tag associated with the pronunciation or null if there is no tag associated with this pronunciation.
 Unit[] getUnits()
          Retrieves the units for this pronunciation
 Word getWord()
          Retrives the word that this Pronunciation object represents.
 WordClassification getWordClassification()
          Retrieves the word classification for this pronunciation
 java.lang.String toDetailedString()
          Returns a detailed string representation of this Pronunication.
 java.lang.String toString()
          Returns a string representation of this Pronunication.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

UNKNOWN

public static final Pronunciation UNKNOWN
Method Detail

getWord

public Word getWord()
Retrives the word that this Pronunciation object represents.

Returns:
the word

getWordClassification

public WordClassification getWordClassification()
Retrieves the word classification for this pronunciation

Returns:
the word classification for this pronunciation.

getUnits

public Unit[] getUnits()
Retrieves the units for this pronunciation

Returns:
the units for this pronunciation

getTag

public java.lang.String getTag()
Retrieves the tag associated with the pronunciation or null if there is no tag associated with this pronunciation. Pronunciations can optionally be tagged to allow applications to distinguish between different pronunciations.

Returns:
the tag or null if no tag is available.

getProbability

public float getProbability()
Retrieves the probability for the pronunciation. A word may have multiple pronunciations that are not all equally probable. All probabilities for particular word sum to 1.0.

Returns:
the probability of this pronunciation as a value between 0 and 1.0. TODO: FIX Note that probabilities are currently maintained in the linear domain (unlike just about everything else)

dump

public void dump()
Dumps a pronunciation


toString

public java.lang.String toString()
Returns a string representation of this Pronunication.

Returns:
a string of this Pronunciation

toDetailedString

public java.lang.String toDetailedString()
Returns a detailed string representation of this Pronunication.

Returns:
a string of this Pronunciation