upstream version 1.2.2
[debian/freetts] / com / sun / speech / freetts / lexicon / LetterToSound.java
1 /**
2  * Portions Copyright 2001 Sun Microsystems, Inc.
3  * Portions Copyright 1999-2001 Language Technologies Institute, 
4  * Carnegie Mellon University.
5  * All Rights Reserved.  Use is subject to license terms.
6  * 
7  * See the file "license.terms" for information on usage and
8  * redistribution of this file, and for a DISCLAIMER OF ALL 
9  * WARRANTIES.
10  */
11 package com.sun.speech.freetts.lexicon;
12
13 /**
14  * Provides the phone list for words using letter-to-sound rules.  The
15  * phone list is implementation dependent.
16  */
17 public interface LetterToSound {
18     /**
19      * Calculate the phone list for a given word.  If a phone list
20      * cannot be determined, <code>null</code> is returned.  The phone
21      * list is implementation dependent.  The format of the
22      * <code>partOfSpeech</code> is also implementation.  If the
23      * <code>partOfSpeech</code> does not matter, pass in <code>null</code>.
24      *
25      * @param word the word to get the phone list for
26      * @param partOfSpeech the part of speech or <code>null</code>
27      *
28      * @return the list of phones for word or <code>null</code>
29      */
30     String[] getPhones(String word, String partOfSpeech);
31 }
32
33
34