upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / en / us / CMULexicon.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 CMULexicon (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.en.us.CMULexicon class">\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="CMULexicon (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;<A HREF="../../../../../../com/sun/speech/freetts/en/us/CMUDiphoneVoice.html" title="class in com.sun.speech.freetts.en.us"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/CMUTimeLexicon.html" title="class in com.sun.speech.freetts.en.us"><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="CMULexicon.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;<A HREF="#fields_inherited_from_class_com.sun.speech.freetts.lexicon.LexiconImpl">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&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.en.us</FONT>\r
85 <BR>\r
86 Class CMULexicon</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html" title="class in com.sun.speech.freetts.lexicon">com.sun.speech.freetts.lexicon.LexiconImpl</A>\r
90       <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.en.us.CMULexicon</B>\r
91 </PRE>\r
92 <DL>\r
93 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></DD>\r
94 </DL>\r
95 <DL>\r
96 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMUTimeLexicon.html" title="class in com.sun.speech.freetts.en.us">CMUTimeLexicon</A></DD>\r
97 </DL>\r
98 <HR>\r
99 <DL>\r
100 <DT>public class <B>CMULexicon</B><DT>extends <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html" title="class in com.sun.speech.freetts.lexicon">LexiconImpl</A></DL>\r
101 \r
102 <P>\r
103 Provides a CMU lexicon-specific implementation of a Lexicon that is
104  stored in a text file.\r
105 <P>\r
106 \r
107 <P>\r
108 <HR>\r
109 \r
110 <P>\r
111 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
112 \r
113 \r
114 <!-- =========== FIELD SUMMARY =========== -->\r
115 \r
116 <A NAME="field_summary"><!-- --></A>
117 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
118 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
119 <TD COLSPAN=2><FONT SIZE="+2">\r
120 <B>Field Summary</B></FONT></TD>\r
121 </TR>\r
122 </TABLE>\r
123 &nbsp;<A NAME="fields_inherited_from_class_com.sun.speech.freetts.lexicon.LexiconImpl"><!-- --></A>
124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
125 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
126 <TD><B>Fields inherited from class com.sun.speech.freetts.lexicon.<A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html" title="class in com.sun.speech.freetts.lexicon">LexiconImpl</A></B></TD>\r
127 </TR>\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
129 <TD><CODE><A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#tokenizeOnLoad">tokenizeOnLoad</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#tokenizeOnLookup">tokenizeOnLookup</A></CODE></TD>\r
130 </TR>\r
131 </TABLE>\r
132 &nbsp;\r
133 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
134 \r
135 <A NAME="constructor_summary"><!-- --></A>
136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
138 <TD COLSPAN=2><FONT SIZE="+2">\r
139 <B>Constructor Summary</B></FONT></TD>\r
140 </TR>\r
141 <TR BGCOLOR="white" CLASS="TableRowColor">\r
142 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#CMULexicon()">CMULexicon</A></B>()</CODE>\r
143 \r
144 <BR>\r
145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the default CMU Lexicon which is a binary lexicon</TD>\r
146 </TR>\r
147 <TR BGCOLOR="white" CLASS="TableRowColor">\r
148 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#CMULexicon(java.lang.String)">CMULexicon</A></B>(java.lang.String&nbsp;basename)</CODE>\r
149 \r
150 <BR>\r
151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the CMU Lexicon which is a binary lexicon</TD>\r
152 </TR>\r
153 <TR BGCOLOR="white" CLASS="TableRowColor">\r
154 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#CMULexicon(java.lang.String, boolean)">CMULexicon</A></B>(java.lang.String&nbsp;basename,
155            boolean&nbsp;useBinaryIO)</CODE>\r
156 \r
157 <BR>\r
158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
159 </TR>\r
160 <TR BGCOLOR="white" CLASS="TableRowColor">\r
161 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#CMULexicon(java.net.URL, java.net.URL, java.net.URL, boolean)">CMULexicon</A></B>(java.net.URL&nbsp;compiledURL,
162            java.net.URL&nbsp;addendaURL,
163            java.net.URL&nbsp;letterToSoundURL,
164            boolean&nbsp;binary)</CODE>\r
165 \r
166 <BR>\r
167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a CMULexicon based upon the given compiled and addenda
168  DBs and the given letter to sound rules</TD>\r
169 </TR>\r
170 </TABLE>\r
171 &nbsp;\r
172 <!-- ========== METHOD SUMMARY =========== -->\r
173 \r
174 <A NAME="method_summary"><!-- --></A>
175 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
176 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
177 <TD COLSPAN=2><FONT SIZE="+2">\r
178 <B>Method Summary</B></FONT></TD>\r
179 </TR>\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">\r
181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
182 <CODE>static&nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html" title="class in com.sun.speech.freetts.en.us">CMULexicon</A></CODE></FONT></TD>\r
183 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#getInstance(boolean)">getInstance</A></B>(boolean&nbsp;useBinaryIO)</CODE>\r
184 \r
185 <BR>\r
186 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the CMULexicon.</TD>\r
187 </TR>\r
188 <TR BGCOLOR="white" CLASS="TableRowColor">\r
189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
190 <CODE>static&nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html" title="class in com.sun.speech.freetts.en.us">CMULexicon</A></CODE></FONT></TD>\r
191 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#getInstance(java.lang.String, boolean)">getInstance</A></B>(java.lang.String&nbsp;basename,
192             boolean&nbsp;useBinaryIO)</CODE>\r
193 \r
194 <BR>\r
195 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the CMULexicon.</TD>\r
196 </TR>\r
197 <TR BGCOLOR="white" CLASS="TableRowColor">\r
198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
199 <CODE>protected static&nbsp;int</CODE></FONT></TD>\r
200 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#getSonority(java.lang.String)">getSonority</A></B>(java.lang.String&nbsp;phone)</CODE>\r
201 \r
202 <BR>\r
203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines the sonority for the given phone.</TD>\r
204 </TR>\r
205 <TR BGCOLOR="white" CLASS="TableRowColor">\r
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
207 <CODE>protected static&nbsp;boolean</CODE></FONT></TD>\r
208 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#hasVowel(java.util.List)">hasVowel</A></B>(java.util.List&nbsp;phones)</CODE>\r
209 \r
210 <BR>\r
211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if there is a vowel in given list of phones.</TD>\r
212 </TR>\r
213 <TR BGCOLOR="white" CLASS="TableRowColor">\r
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
215 <CODE>protected static&nbsp;boolean</CODE></FONT></TD>\r
216 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#hasVowel(java.lang.String[], int)">hasVowel</A></B>(java.lang.String[]&nbsp;phones,
217          int&nbsp;index)</CODE>\r
218 \r
219 <BR>\r
220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if there is a vowel in the remainder of the array, 
221  starting at the given index.</TD>\r
222 </TR>\r
223 <TR BGCOLOR="white" CLASS="TableRowColor">\r
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
225 <CODE>protected static&nbsp;boolean</CODE></FONT></TD>\r
226 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#isSilence(java.lang.String)">isSilence</A></B>(java.lang.String&nbsp;phone)</CODE>\r
227 \r
228 <BR>\r
229 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the given phone represents a silent phone.</TD>\r
230 </TR>\r
231 <TR BGCOLOR="white" CLASS="TableRowColor">\r
232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
233 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
234 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#isSyllableBoundary(java.util.List, java.lang.String[], int)">isSyllableBoundary</A></B>(java.util.List&nbsp;syllablePhones,
235                    java.lang.String[]&nbsp;wordPhones,
236                    int&nbsp;currentWordPhone)</CODE>\r
237 \r
238 <BR>\r
239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the currentPhone represents a new syllable
240  boundary.</TD>\r
241 </TR>\r
242 <TR BGCOLOR="white" CLASS="TableRowColor">\r
243 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
244 <CODE>protected static&nbsp;boolean</CODE></FONT></TD>\r
245 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#isVowel(java.lang.String)">isVowel</A></B>(java.lang.String&nbsp;phone)</CODE>\r
246 \r
247 <BR>\r
248 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the given phone is a vowel</TD>\r
249 </TR>\r
250 <TR BGCOLOR="white" CLASS="TableRowColor">\r
251 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
252 <CODE>static&nbsp;void</CODE></FONT></TD>\r
253 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
254 \r
255 <BR>\r
256 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Provides test code for the CMULexicon.
257  </TD>\r
258 </TR>\r
259 </TABLE>\r
260 &nbsp;<A NAME="methods_inherited_from_class_com.sun.speech.freetts.lexicon.LexiconImpl"><!-- --></A>
261 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
262 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
263 <TD><B>Methods inherited from class com.sun.speech.freetts.lexicon.<A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html" title="class in com.sun.speech.freetts.lexicon">LexiconImpl</A></B></TD>\r
264 </TR>\r
265 <TR BGCOLOR="white" CLASS="TableRowColor">\r
266 <TD><CODE><A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#addAddendum(java.lang.String, java.lang.String, java.lang.String[])">addAddendum</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#compare(com.sun.speech.freetts.lexicon.LexiconImpl)">compare</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#createLexicon(java.io.InputStream, boolean, int)">createLexicon</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#dumpBinary(java.lang.String)">dumpBinary</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#fixPartOfSpeech(java.lang.String)">fixPartOfSpeech</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.util.Map, java.lang.String)">getPhones</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.util.Map, java.lang.String, java.lang.String)">getPhones</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.lang.String)">getPhones</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.lang.String, java.lang.String)">getPhones</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.lang.String, java.lang.String, boolean)">getPhones</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#isLoaded()">isLoaded</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#load()">load</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#loadTextLexicon(java.io.InputStream, int)">loadTextLexicon</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#parseAndAdd(java.util.Map, java.lang.String)">parseAndAdd</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#removeAddendum(java.lang.String, java.lang.String)">removeAddendum</A>, <A HREF="../../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#setLexiconParameters(java.net.URL, java.net.URL, java.net.URL, boolean)">setLexiconParameters</A></CODE></TD>\r
267 </TR>\r
268 </TABLE>\r
269 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
270 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
271 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
272 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
273 </TR>\r
274 <TR BGCOLOR="white" CLASS="TableRowColor">\r
275 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
276 </TR>\r
277 </TABLE>\r
278 &nbsp;\r
279 <P>\r
280 \r
281 <!-- ============ FIELD DETAIL =========== -->\r
282 \r
283 \r
284 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
285 \r
286 <A NAME="constructor_detail"><!-- --></A>
287 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
288 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
289 <TD COLSPAN=1><FONT SIZE="+2">\r
290 <B>Constructor Detail</B></FONT></TD>\r
291 </TR>\r
292 </TABLE>\r
293 \r
294 <A NAME="CMULexicon(java.net.URL, java.net.URL, java.net.URL, boolean)"><!-- --></A><H3>\r
295 CMULexicon</H3>\r
296 <PRE>\r
297 public <B>CMULexicon</B>(java.net.URL&nbsp;compiledURL,
298                   java.net.URL&nbsp;addendaURL,
299                   java.net.URL&nbsp;letterToSoundURL,
300                   boolean&nbsp;binary)</PRE>\r
301 <DL>\r
302 <DD>Creates a CMULexicon based upon the given compiled and addenda
303  DBs and the given letter to sound rules\r
304 <P>\r
305 <DT><B>Parameters:</B><DD><CODE>compiledURL</CODE> - the compiled database is loaded from here<DD><CODE>addendaURL</CODE> - the database addenda is loaded from here<DD><CODE>letterToSoundURL</CODE> - the letter to sound rules are loaded
306                 from here<DD><CODE>binary</CODE> - if <code>true</code> the input data are loaded as
307                 binary ; otherwise if <code>false</code> the input
308                 data are loaded as text.</DL>\r
309 <HR>\r
310 \r
311 <A NAME="CMULexicon()"><!-- --></A><H3>\r
312 CMULexicon</H3>\r
313 <PRE>\r
314 public <B>CMULexicon</B>()</PRE>\r
315 <DL>\r
316 <DD>Creates the default CMU Lexicon which is a binary lexicon\r
317 <P>\r
318 </DL>\r
319 <HR>\r
320 \r
321 <A NAME="CMULexicon(java.lang.String)"><!-- --></A><H3>\r
322 CMULexicon</H3>\r
323 <PRE>\r
324 public <B>CMULexicon</B>(java.lang.String&nbsp;basename)</PRE>\r
325 <DL>\r
326 <DD>Creates the CMU Lexicon which is a binary lexicon\r
327 <P>\r
328 <DT><B>Parameters:</B><DD><CODE>basename</CODE> - the basename for the lexicon.</DL>\r
329 <HR>\r
330 \r
331 <A NAME="CMULexicon(java.lang.String, boolean)"><!-- --></A><H3>\r
332 CMULexicon</H3>\r
333 <PRE>\r
334 public <B>CMULexicon</B>(java.lang.String&nbsp;basename,
335                   boolean&nbsp;useBinaryIO)</PRE>\r
336 <DL>\r
337 </DL>\r
338 \r
339 <!-- ============ METHOD DETAIL ========== -->\r
340 \r
341 <A NAME="method_detail"><!-- --></A>
342 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
343 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
344 <TD COLSPAN=1><FONT SIZE="+2">\r
345 <B>Method Detail</B></FONT></TD>\r
346 </TR>\r
347 </TABLE>\r
348 \r
349 <A NAME="getInstance(boolean)"><!-- --></A><H3>\r
350 getInstance</H3>\r
351 <PRE>\r
352 public static <A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html" title="class in com.sun.speech.freetts.en.us">CMULexicon</A> <B>getInstance</B>(boolean&nbsp;useBinaryIO)
353                               throws java.io.IOException</PRE>\r
354 <DL>\r
355 <DD>Get the CMULexicon.\r
356 <P>\r
357 <DD><DL>\r
358 <DT><B>Parameters:</B><DD><CODE>useBinaryIO</CODE> - if true use binary IO to load DB
359 <DT><B>Throws:</B>
360 <DD><CODE>java.io.IOException</CODE> - if problems occurred while reading the data</DL>\r
361 </DD>\r
362 </DL>\r
363 <HR>\r
364 \r
365 <A NAME="getInstance(java.lang.String, boolean)"><!-- --></A><H3>\r
366 getInstance</H3>\r
367 <PRE>\r
368 public static <A HREF="../../../../../../com/sun/speech/freetts/en/us/CMULexicon.html" title="class in com.sun.speech.freetts.en.us">CMULexicon</A> <B>getInstance</B>(java.lang.String&nbsp;basename,
369                                      boolean&nbsp;useBinaryIO)
370                               throws java.io.IOException</PRE>\r
371 <DL>\r
372 <DD>Get the CMULexicon.\r
373 <P>\r
374 <DD><DL>\r
375 <DT><B>Parameters:</B><DD><CODE>useBinaryIO</CODE> - if true use binary IO to load DB
376 <DT><B>Throws:</B>
377 <DD><CODE>java.io.IOException</CODE> - if problems occurred while reading the data</DL>\r
378 </DD>\r
379 </DL>\r
380 <HR>\r
381 \r
382 <A NAME="isSyllableBoundary(java.util.List, java.lang.String[], int)"><!-- --></A><H3>\r
383 isSyllableBoundary</H3>\r
384 <PRE>\r
385 public boolean <B>isSyllableBoundary</B>(java.util.List&nbsp;syllablePhones,
386                                   java.lang.String[]&nbsp;wordPhones,
387                                   int&nbsp;currentWordPhone)</PRE>\r
388 <DL>\r
389 <DD>Determines if the currentPhone represents a new syllable
390  boundary.\r
391 <P>\r
392 <DD><DL>\r
393 <DT><B>Parameters:</B><DD><CODE>syllablePhones</CODE> - the phones in the current syllable so far<DD><CODE>wordPhones</CODE> - the phones for the whole word<DD><CODE>currentWordPhone</CODE> - the word phone in question
394 <DT><B>Returns:</B><DD><code>true</code> if the word phone in question is on a
395      syllable boundary; otherwise <code>false</code>.</DL>\r
396 </DD>\r
397 </DL>\r
398 <HR>\r
399 \r
400 <A NAME="isSilence(java.lang.String)"><!-- --></A><H3>\r
401 isSilence</H3>\r
402 <PRE>\r
403 protected static boolean <B>isSilence</B>(java.lang.String&nbsp;phone)</PRE>\r
404 <DL>\r
405 <DD>Determines if the given phone represents a silent phone.\r
406 <P>\r
407 <DD><DL>\r
408 <DT><B>Parameters:</B><DD><CODE>phone</CODE> - the phone to test
409 <DT><B>Returns:</B><DD><code>true</code> if the phone represents a silent
410                 phone; otherwise <code>false</code>.</DL>\r
411 </DD>\r
412 </DL>\r
413 <HR>\r
414 \r
415 <A NAME="hasVowel(java.lang.String[], int)"><!-- --></A><H3>\r
416 hasVowel</H3>\r
417 <PRE>\r
418 protected static boolean <B>hasVowel</B>(java.lang.String[]&nbsp;phones,
419                                   int&nbsp;index)</PRE>\r
420 <DL>\r
421 <DD>Determines if there is a vowel in the remainder of the array, 
422  starting at the given index.\r
423 <P>\r
424 <DD><DL>\r
425 <DT><B>Parameters:</B><DD><CODE>phones</CODE> - the set of phones to check<DD><CODE>index</CODE> - start checking at this index
426 <DT><B>Returns:</B><DD><code>true</code> if a vowel is found; 
427                 otherwise <code>false</code>.</DL>\r
428 </DD>\r
429 </DL>\r
430 <HR>\r
431 \r
432 <A NAME="hasVowel(java.util.List)"><!-- --></A><H3>\r
433 hasVowel</H3>\r
434 <PRE>\r
435 protected static boolean <B>hasVowel</B>(java.util.List&nbsp;phones)</PRE>\r
436 <DL>\r
437 <DD>Determines if there is a vowel in given list of phones.\r
438 <P>\r
439 <DD><DL>\r
440 <DT><B>Parameters:</B><DD><CODE>phones</CODE> - the list of phones
441 <DT><B>Returns:</B><DD><code>true</code> if a vowel is found; 
442                 otherwise <code>false</code>.</DL>\r
443 </DD>\r
444 </DL>\r
445 <HR>\r
446 \r
447 <A NAME="isVowel(java.lang.String)"><!-- --></A><H3>\r
448 isVowel</H3>\r
449 <PRE>\r
450 protected static boolean <B>isVowel</B>(java.lang.String&nbsp;phone)</PRE>\r
451 <DL>\r
452 <DD>Determines if the given phone is a vowel\r
453 <P>\r
454 <DD><DL>\r
455 <DT><B>Parameters:</B><DD><CODE>phone</CODE> - the phone to test
456 <DT><B>Returns:</B><DD><code>true</code> if phone is a vowel
457                 otherwise <code>false</code>.</DL>\r
458 </DD>\r
459 </DL>\r
460 <HR>\r
461 \r
462 <A NAME="getSonority(java.lang.String)"><!-- --></A><H3>\r
463 getSonority</H3>\r
464 <PRE>\r
465 protected static int <B>getSonority</B>(java.lang.String&nbsp;phone)</PRE>\r
466 <DL>\r
467 <DD>Determines the sonority for the given phone.\r
468 <P>\r
469 <DD><DL>\r
470 <DT><B>Parameters:</B><DD><CODE>phone</CODE> - the phone of interest
471 <DT><B>Returns:</B><DD>an integer that classifies phone transitions</DL>\r
472 </DD>\r
473 </DL>\r
474 <HR>\r
475 \r
476 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
477 main</H3>\r
478 <PRE>\r
479 public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>\r
480 <DL>\r
481 <DD>Provides test code for the CMULexicon.
482  <br><b>Usage:</b><br>
483  <pre>
484   com.sun.speech.freetts.en.us.CMULexicon [options]
485
486  Where options is any combination of:
487
488  -src path
489  -dest path
490  -generate_binary [base_name]
491  -compare
492  -showtimes
493
494  </pre>\r
495 <P>\r
496 <DD><DL>\r
497 </DL>\r
498 </DD>\r
499 </DL>\r
500 <!-- ========= END OF CLASS DATA ========= -->\r
501 <HR>\r
502 \r
503
504 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
505 <A NAME="navbar_bottom"><!-- --></A>
506 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
507 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
508 <TR>\r
509 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
510 <A NAME="navbar_bottom_firstrow"><!-- --></A>
511 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
512   <TR ALIGN="center" VALIGN="top">\r
513   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
514   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
515   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
516   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
517   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
518   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
519   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
520   </TR>\r
521 </TABLE>\r
522 </TD>\r
523 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
524 </EM>\r
525 </TD>\r
526 </TR>\r
527 \r
528 <TR>\r
529 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
530 &nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/CMUDiphoneVoice.html" title="class in com.sun.speech.freetts.en.us"><B>PREV CLASS</B></A>&nbsp;\r
531 &nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/CMUTimeLexicon.html" title="class in com.sun.speech.freetts.en.us"><B>NEXT CLASS</B></A></FONT></TD>\r
532 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
533   <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
534 &nbsp;<A HREF="CMULexicon.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
535 &nbsp;<SCRIPT type="text/javascript">\r
536   <!--\r
537   if(window==top) {\r
538     document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
539   }\r
540   //-->\r
541 </SCRIPT>\r
542 <NOSCRIPT>\r
543   <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
544 </NOSCRIPT>
545 \r
546 </FONT></TD>\r
547 </TR>\r
548 <TR>\r
549 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
550   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_com.sun.speech.freetts.lexicon.LexiconImpl">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
551 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
552 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
553 </TR>\r
554 </TABLE>\r
555 <A NAME="skip-navbar_bottom"></A>
556 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
557 \r
558 <HR>\r
559 \r
560 </BODY>\r
561 </HTML>\r