Class TokenToWords

  • All Implemented Interfaces:
    UtteranceProcessor

    public class TokenToWords
    extends java.lang.Object
    implements UtteranceProcessor
    Converts the Tokens (in US English words) in an Utterance into a list of words. It puts the produced list back into the Utterance. Usually, the tokens that gets expanded are numbers like "23" (to "twenty" "three").

    * It translates the following code from flite:
    lang/usenglish/us_text.c

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Item getTokenItem()
      Returns the currently processing token Item.
      boolean isPronounceable​(java.lang.String word)
      Returns true if the given word is pronounceable.
      static boolean kingLike​(Item tokenItem)
      Returns true if the given token item contains a token that is in a king-like context, e.g., "King" or "Louis".
      void processUtterance​(Utterance utterance)
      process the utterance
      static boolean sectionLike​(Item tokenItem)
      Returns true if the given token item contains a token that is in a section-like context, e.g., "chapter" or "act".
      java.lang.String toString()
      Converts this object to its String representation
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • TokenToWords

        public TokenToWords​(CART usNumbersCART,
                            PronounceableFSM prefixFSM,
                            PronounceableFSM suffixFSM)
        Constructs a default USTokenWordProcessor. It uses the USEnglish regular expression set (USEngRegExp) by default.
        Parameters:
        usNumbersCART - the cart to use to classify numbers
    • Method Detail

      • getTokenItem

        public Item getTokenItem()
        Returns the currently processing token Item.
        Returns:
        the current token Item; null if no item
      • kingLike

        public static boolean kingLike​(Item tokenItem)
        Returns true if the given token item contains a token that is in a king-like context, e.g., "King" or "Louis".
        Parameters:
        tokenItem - the token item to check
        Returns:
        true or false
      • sectionLike

        public static boolean sectionLike​(Item tokenItem)
        Returns true if the given token item contains a token that is in a section-like context, e.g., "chapter" or "act".
        Parameters:
        tokenItem - the token item to check
        Returns:
        true or false
      • isPronounceable

        public boolean isPronounceable​(java.lang.String word)
        Returns true if the given word is pronounceable. This method is originally called us_aswd() in Flite 1.1.
        Parameters:
        word - the word to test
        Returns:
        true if the word is pronounceable, false otherwise
      • toString

        public java.lang.String toString()
        Converts this object to its String representation
        Overrides:
        toString in class java.lang.Object
        Returns:
        the string representation of this object