add a cleanup script to elide the non-free jsapi binary blob from the sources
[debian/freetts] / javadoc / com / sun / speech / freetts / lexicon / LetterToSound.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:30 CET 2009 -->\r
6 <TITLE>\r
7 LetterToSound (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.lexicon.LetterToSound interface">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="LetterToSound (FreeTTS 1.2)";\r
18 }\r
19 </SCRIPT>\r
20 \r
21 </HEAD>\r
22 \r
23 <BODY BGCOLOR="white" onload="windowTitle();">\r
24 \r
25
26 <!-- ========= START OF TOP NAVBAR ======= -->\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
30 <TR>\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
34   <TR ALIGN="center" VALIGN="top">\r
35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
42   </TR>\r
43 </TABLE>\r
44 </TD>\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
46 </EM>\r
47 </TD>\r
48 </TR>\r
49 \r
50 <TR>\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
52 &nbsp;PREV CLASS&nbsp;\r
53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon"><B>NEXT CLASS</B></A></FONT></TD>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
56 &nbsp;<A HREF="LetterToSound.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
57 &nbsp;<SCRIPT type="text/javascript">\r
58   <!--\r
59   if(window==top) {\r
60     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
61   }\r
62   //-->\r
63 </SCRIPT>\r
64 <NOSCRIPT>\r
65   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
66 </NOSCRIPT>
67 \r
68 </FONT></TD>\r
69 </TR>\r
70 <TR>\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
75 </TR>\r
76 </TABLE>\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->\r
79 \r
80 <HR>\r
81 <!-- ======== START OF CLASS DATA ======== -->\r
82 <H2>\r
83 <FONT SIZE="-1">\r
84 com.sun.speech.freetts.lexicon</FONT>\r
85 <BR>\r
86 Interface LetterToSound</H2>\r
87 <DL>\r
88 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/sun/speech/freetts/lexicon/LetterToSoundImpl.html" title="class in com.sun.speech.freetts.lexicon">LetterToSoundImpl</A></DD>\r
89 </DL>\r
90 <HR>\r
91 <DL>\r
92 <DT>public interface <B>LetterToSound</B></DL>\r
93 \r
94 <P>\r
95 Provides the phone list for words using letter-to-sound rules.  The
96  phone list is implementation dependent.\r
97 <P>\r
98 \r
99 <P>\r
100 <HR>\r
101 \r
102 <P>\r
103 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
104 \r
105 \r
106 <!-- =========== FIELD SUMMARY =========== -->\r
107 \r
108 \r
109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
110 \r
111 \r
112 <!-- ========== METHOD SUMMARY =========== -->\r
113 \r
114 <A NAME="method_summary"><!-- --></A>
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
117 <TD COLSPAN=2><FONT SIZE="+2">\r
118 <B>Method Summary</B></FONT></TD>\r
119 </TR>\r
120 <TR BGCOLOR="white" CLASS="TableRowColor">\r
121 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
122 <CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>\r
123 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LetterToSound.html#getPhones(java.lang.String, java.lang.String)">getPhones</A></B>(java.lang.String&nbsp;word,
124           java.lang.String&nbsp;partOfSpeech)</CODE>\r
125 \r
126 <BR>\r
127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calculate the phone list for a given word.  </TD>\r
128 </TR>\r
129 </TABLE>\r
130 &nbsp;\r
131 <P>\r
132 \r
133 <!-- ============ FIELD DETAIL =========== -->\r
134 \r
135 \r
136 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
137 \r
138 \r
139 <!-- ============ METHOD DETAIL ========== -->\r
140 \r
141 <A NAME="method_detail"><!-- --></A>
142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
143 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
144 <TD COLSPAN=1><FONT SIZE="+2">\r
145 <B>Method Detail</B></FONT></TD>\r
146 </TR>\r
147 </TABLE>\r
148 \r
149 <A NAME="getPhones(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
150 getPhones</H3>\r
151 <PRE>\r
152 public java.lang.String[] <B>getPhones</B>(java.lang.String&nbsp;word,
153                                     java.lang.String&nbsp;partOfSpeech)</PRE>\r
154 <DL>\r
155 <DD>Calculate the phone list for a given word.  If a phone list
156  cannot be determined, <code>null</code> is returned.  The phone
157  list is implementation dependent.  The format of the
158  <code>partOfSpeech</code> is also implementation.  If the
159  <code>partOfSpeech</code> does not matter, pass in <code>null</code>.\r
160 <P>\r
161 <DD><DL>\r
162 <DT><B>Parameters:</B><DD><CODE>word</CODE> - the word to get the phone list for<DD><CODE>partOfSpeech</CODE> - the part of speech or <code>null</code>
163 <DT><B>Returns:</B><DD>the list of phones for word or <code>null</code></DL>\r
164 </DD>\r
165 </DL>\r
166 <!-- ========= END OF CLASS DATA ========= -->\r
167 <HR>\r
168 \r
169
170 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
171 <A NAME="navbar_bottom"><!-- --></A>
172 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
173 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
174 <TR>\r
175 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
176 <A NAME="navbar_bottom_firstrow"><!-- --></A>
177 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
178   <TR ALIGN="center" VALIGN="top">\r
179   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
180   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
181   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
182   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
183   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
184   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
185   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
186   </TR>\r
187 </TABLE>\r
188 </TD>\r
189 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
190 </EM>\r
191 </TD>\r
192 </TR>\r
193 \r
194 <TR>\r
195 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
196 &nbsp;PREV CLASS&nbsp;\r
197 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon"><B>NEXT CLASS</B></A></FONT></TD>\r
198 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
199   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
200 &nbsp;<A HREF="LetterToSound.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
201 &nbsp;<SCRIPT type="text/javascript">\r
202   <!--\r
203   if(window==top) {\r
204     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
205   }\r
206   //-->\r
207 </SCRIPT>\r
208 <NOSCRIPT>\r
209   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
210 </NOSCRIPT>
211 \r
212 </FONT></TD>\r
213 </TR>\r
214 <TR>\r
215 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
216   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
217 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
218 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
219 </TR>\r
220 </TABLE>\r
221 <A NAME="skip-navbar_bottom"></A>
222 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
223 \r
224 <HR>\r
225 \r
226 </BODY>\r
227 </HTML>\r