upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / en / us / PronounceableFSM.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 PronounceableFSM (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.en.us.PronounceableFSM 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="PronounceableFSM (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/PrefixFSM.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/SuffixFSM.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="PronounceableFSM.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="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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 PronounceableFSM</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.en.us.PronounceableFSM</B>\r
90 </PRE>\r
91 <DL>\r
92 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../com/sun/speech/freetts/en/us/PrefixFSM.html" title="class in com.sun.speech.freetts.en.us">PrefixFSM</A>, <A HREF="../../../../../../com/sun/speech/freetts/en/us/SuffixFSM.html" title="class in com.sun.speech.freetts.en.us">SuffixFSM</A></DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>PronounceableFSM</B><DT>extends java.lang.Object</DL>\r
97 \r
98 <P>\r
99 Implements a finite state machine that checks if a given string
100  is pronounceable. If it is pronounceable, the method
101  <code>accept()</code> will return true.\r
102 <P>\r
103 \r
104 <P>\r
105 <HR>\r
106 \r
107 <P>\r
108 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
109 \r
110 \r
111 <!-- =========== FIELD SUMMARY =========== -->\r
112 \r
113 <A NAME="field_summary"><!-- --></A>
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
116 <TD COLSPAN=2><FONT SIZE="+2">\r
117 <B>Field Summary</B></FONT></TD>\r
118 </TR>\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">\r
120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
121 <CODE>protected &nbsp;boolean</CODE></FONT></TD>\r
122 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/PronounceableFSM.html#scanFromFront">scanFromFront</A></B></CODE>\r
123 \r
124 <BR>\r
125 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Whether we should scan the input string from the front.</TD>\r
126 </TR>\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">\r
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
129 <CODE>protected &nbsp;int[]</CODE></FONT></TD>\r
130 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/PronounceableFSM.html#transitions">transitions</A></B></CODE>\r
131 \r
132 <BR>\r
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The transitions of this FSM</TD>\r
134 </TR>\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
137 <CODE>protected &nbsp;int</CODE></FONT></TD>\r
138 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/PronounceableFSM.html#vocabularySize">vocabularySize</A></B></CODE>\r
139 \r
140 <BR>\r
141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The vocabulary size.</TD>\r
142 </TR>\r
143 </TABLE>\r
144 &nbsp;\r
145 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
146 \r
147 <A NAME="constructor_summary"><!-- --></A>
148 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
149 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
150 <TD COLSPAN=2><FONT SIZE="+2">\r
151 <B>Constructor Summary</B></FONT></TD>\r
152 </TR>\r
153 <TR BGCOLOR="white" CLASS="TableRowColor">\r
154 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/PronounceableFSM.html#PronounceableFSM(int, int[], boolean)">PronounceableFSM</A></B>(int&nbsp;vocabularySize,
155                  int[]&nbsp;transitions,
156                  boolean&nbsp;scanFromFront)</CODE>\r
157 \r
158 <BR>\r
159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a PronounceableFSM with the given attributes.</TD>\r
160 </TR>\r
161 <TR BGCOLOR="white" CLASS="TableRowColor">\r
162 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/PronounceableFSM.html#PronounceableFSM(java.net.URL, boolean)">PronounceableFSM</A></B>(java.net.URL&nbsp;url,
163                  boolean&nbsp;scanFromFront)</CODE>\r
164 \r
165 <BR>\r
166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a PronounceableFSM with information in the given URL.</TD>\r
167 </TR>\r
168 </TABLE>\r
169 &nbsp;\r
170 <!-- ========== METHOD SUMMARY =========== -->\r
171 \r
172 <A NAME="method_summary"><!-- --></A>
173 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
174 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
175 <TD COLSPAN=2><FONT SIZE="+2">\r
176 <B>Method Summary</B></FONT></TD>\r
177 </TR>\r
178 <TR BGCOLOR="white" CLASS="TableRowColor">\r
179 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
180 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
181 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/PronounceableFSM.html#accept(java.lang.String)">accept</A></B>(java.lang.String&nbsp;inputString)</CODE>\r
182 \r
183 <BR>\r
184 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks to see if this finite state machine accepts the given
185  input string.</TD>\r
186 </TR>\r
187 </TABLE>\r
188 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
189 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
190 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
191 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
192 </TR>\r
193 <TR BGCOLOR="white" CLASS="TableRowColor">\r
194 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
195 </TR>\r
196 </TABLE>\r
197 &nbsp;\r
198 <P>\r
199 \r
200 <!-- ============ FIELD DETAIL =========== -->\r
201 \r
202 <A NAME="field_detail"><!-- --></A>
203 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
204 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
205 <TD COLSPAN=1><FONT SIZE="+2">\r
206 <B>Field Detail</B></FONT></TD>\r
207 </TR>\r
208 </TABLE>\r
209 \r
210 <A NAME="vocabularySize"><!-- --></A><H3>\r
211 vocabularySize</H3>\r
212 <PRE>\r
213 protected int <B>vocabularySize</B></PRE>\r
214 <DL>\r
215 <DD>The vocabulary size.\r
216 <P>\r
217 <DL>\r
218 </DL>\r
219 </DL>\r
220 <HR>\r
221 \r
222 <A NAME="transitions"><!-- --></A><H3>\r
223 transitions</H3>\r
224 <PRE>\r
225 protected int[] <B>transitions</B></PRE>\r
226 <DL>\r
227 <DD>The transitions of this FSM\r
228 <P>\r
229 <DL>\r
230 </DL>\r
231 </DL>\r
232 <HR>\r
233 \r
234 <A NAME="scanFromFront"><!-- --></A><H3>\r
235 scanFromFront</H3>\r
236 <PRE>\r
237 protected boolean <B>scanFromFront</B></PRE>\r
238 <DL>\r
239 <DD>Whether we should scan the input string from the front.\r
240 <P>\r
241 <DL>\r
242 </DL>\r
243 </DL>\r
244 \r
245 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
246 \r
247 <A NAME="constructor_detail"><!-- --></A>
248 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
249 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
250 <TD COLSPAN=1><FONT SIZE="+2">\r
251 <B>Constructor Detail</B></FONT></TD>\r
252 </TR>\r
253 </TABLE>\r
254 \r
255 <A NAME="PronounceableFSM(java.net.URL, boolean)"><!-- --></A><H3>\r
256 PronounceableFSM</H3>\r
257 <PRE>\r
258 public <B>PronounceableFSM</B>(java.net.URL&nbsp;url,
259                         boolean&nbsp;scanFromFront)
260                  throws java.io.IOException</PRE>\r
261 <DL>\r
262 <DD>Constructs a PronounceableFSM with information in the given URL.\r
263 <P>\r
264 <DT><B>Parameters:</B><DD><CODE>url</CODE> - the URL that contains the FSM specification<DD><CODE>scanFromFront</CODE> - indicates whether this FSM should scan the input
265  string from the front, or from the back</DL>\r
266 <HR>\r
267 \r
268 <A NAME="PronounceableFSM(int, int[], boolean)"><!-- --></A><H3>\r
269 PronounceableFSM</H3>\r
270 <PRE>\r
271 public <B>PronounceableFSM</B>(int&nbsp;vocabularySize,
272                         int[]&nbsp;transitions,
273                         boolean&nbsp;scanFromFront)</PRE>\r
274 <DL>\r
275 <DD>Constructs a PronounceableFSM with the given attributes.\r
276 <P>\r
277 <DT><B>Parameters:</B><DD><CODE>vocabularySize</CODE> - the vocabulary size of the FSM<DD><CODE>transitions</CODE> - the transitions of the FSM<DD><CODE>scanFromFront</CODE> - indicates whether this FSM should scan the input
278  string from the front, or from the back</DL>\r
279 \r
280 <!-- ============ METHOD DETAIL ========== -->\r
281 \r
282 <A NAME="method_detail"><!-- --></A>
283 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
284 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
285 <TD COLSPAN=1><FONT SIZE="+2">\r
286 <B>Method Detail</B></FONT></TD>\r
287 </TR>\r
288 </TABLE>\r
289 \r
290 <A NAME="accept(java.lang.String)"><!-- --></A><H3>\r
291 accept</H3>\r
292 <PRE>\r
293 public boolean <B>accept</B>(java.lang.String&nbsp;inputString)</PRE>\r
294 <DL>\r
295 <DD>Checks to see if this finite state machine accepts the given
296  input string.\r
297 <P>\r
298 <DD><DL>\r
299 <DT><B>Parameters:</B><DD><CODE>inputString</CODE> - the input string to be tested
300 <DT><B>Returns:</B><DD>true if this FSM accepts, false if it rejects</DL>\r
301 </DD>\r
302 </DL>\r
303 <!-- ========= END OF CLASS DATA ========= -->\r
304 <HR>\r
305 \r
306
307 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
308 <A NAME="navbar_bottom"><!-- --></A>
309 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
310 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
311 <TR>\r
312 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
313 <A NAME="navbar_bottom_firstrow"><!-- --></A>
314 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
315   <TR ALIGN="center" VALIGN="top">\r
316   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
317   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
318   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
319   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
320   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
321   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
322   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
323   </TR>\r
324 </TABLE>\r
325 </TD>\r
326 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
327 </EM>\r
328 </TD>\r
329 </TR>\r
330 \r
331 <TR>\r
332 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
333 &nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/PrefixFSM.html" title="class in com.sun.speech.freetts.en.us"><B>PREV CLASS</B></A>&nbsp;\r
334 &nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/SuffixFSM.html" title="class in com.sun.speech.freetts.en.us"><B>NEXT CLASS</B></A></FONT></TD>\r
335 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
336   <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
337 &nbsp;<A HREF="PronounceableFSM.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
338 &nbsp;<SCRIPT type="text/javascript">\r
339   <!--\r
340   if(window==top) {\r
341     document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
342   }\r
343   //-->\r
344 </SCRIPT>\r
345 <NOSCRIPT>\r
346   <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
347 </NOSCRIPT>
348 \r
349 </FONT></TD>\r
350 </TR>\r
351 <TR>\r
352 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
353   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
354 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
355 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
356 </TR>\r
357 </TABLE>\r
358 <A NAME="skip-navbar_bottom"></A>
359 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
360 \r
361 <HR>\r
362 \r
363 </BODY>\r
364 </HTML>\r