add a cleanup script to elide the non-free jsapi binary blob from the sources
[debian/freetts] / javadoc / com / sun / speech / freetts / en / TokenizerImpl.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 TokenizerImpl (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.en.TokenizerImpl 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="TokenizerImpl (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/PostLexicalAnalyzer.html" title="class in com.sun.speech.freetts.en"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;NEXT CLASS</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="TokenizerImpl.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</FONT>\r
85 <BR>\r
86 Class TokenizerImpl</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.TokenizerImpl</B>\r
90 </PRE>\r
91 <DL>\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>TokenizerImpl</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></DL>\r
97 \r
98 <P>\r
99 Implements the tokenizer interface. Breaks an input sequence of
100  characters into a set of tokens.\r
101 <P>\r
102 \r
103 <P>\r
104 <HR>\r
105 \r
106 <P>\r
107 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
108 \r
109 \r
110 <!-- =========== FIELD SUMMARY =========== -->\r
111 \r
112 <A NAME="field_summary"><!-- --></A>
113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
115 <TD COLSPAN=2><FONT SIZE="+2">\r
116 <B>Field Summary</B></FONT></TD>\r
117 </TR>\r
118 <TR BGCOLOR="white" CLASS="TableRowColor">\r
119 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
120 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
121 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#DEFAULT_POSTPUNCTUATION_SYMBOLS">DEFAULT_POSTPUNCTUATION_SYMBOLS</A></B></CODE>\r
122 \r
123 <BR>\r
124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string containing the default post-punctuation characters.</TD>\r
125 </TR>\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
128 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
129 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#DEFAULT_PREPUNCTUATION_SYMBOLS">DEFAULT_PREPUNCTUATION_SYMBOLS</A></B></CODE>\r
130 \r
131 <BR>\r
132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string containing the default pre-punctuation characters.</TD>\r
133 </TR>\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">\r
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
136 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
137 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#DEFAULT_SINGLE_CHAR_SYMBOLS">DEFAULT_SINGLE_CHAR_SYMBOLS</A></B></CODE>\r
138 \r
139 <BR>\r
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string containing the default single characters.</TD>\r
141 </TR>\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
144 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
145 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#DEFAULT_WHITESPACE_SYMBOLS">DEFAULT_WHITESPACE_SYMBOLS</A></B></CODE>\r
146 \r
147 <BR>\r
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string containing the default whitespace characters.</TD>\r
149 </TR>\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
152 <CODE>static&nbsp;int</CODE></FONT></TD>\r
153 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#EOF">EOF</A></B></CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A constant indicating that the end of the stream has been read.</TD>\r
157 </TR>\r
158 </TABLE>\r
159 &nbsp;\r
160 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
161 \r
162 <A NAME="constructor_summary"><!-- --></A>
163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
164 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
165 <TD COLSPAN=2><FONT SIZE="+2">\r
166 <B>Constructor Summary</B></FONT></TD>\r
167 </TR>\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
169 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#TokenizerImpl()">TokenizerImpl</A></B>()</CODE>\r
170 \r
171 <BR>\r
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a Tokenizer.</TD>\r
173 </TR>\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">\r
175 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#TokenizerImpl(java.io.Reader)">TokenizerImpl</A></B>(java.io.Reader&nbsp;file)</CODE>\r
176 \r
177 <BR>\r
178 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a tokenizer that will return tokens from
179  the given file.</TD>\r
180 </TR>\r
181 <TR BGCOLOR="white" CLASS="TableRowColor">\r
182 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#TokenizerImpl(java.lang.String)">TokenizerImpl</A></B>(java.lang.String&nbsp;string)</CODE>\r
183 \r
184 <BR>\r
185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a tokenizer that will return tokens from
186  the given string.</TD>\r
187 </TR>\r
188 </TABLE>\r
189 &nbsp;\r
190 <!-- ========== METHOD SUMMARY =========== -->\r
191 \r
192 <A NAME="method_summary"><!-- --></A>
193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
194 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
195 <TD COLSPAN=2><FONT SIZE="+2">\r
196 <B>Method Summary</B></FONT></TD>\r
197 </TR>\r
198 <TR BGCOLOR="white" CLASS="TableRowColor">\r
199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
200 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
201 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#getErrorDescription()">getErrorDescription</A></B>()</CODE>\r
202 \r
203 <BR>\r
204 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if hasErrors returns <code>true</code>, this will return a 
205  description of the error encountered, otherwise
206  it will return <code>null</code></TD>\r
207 </TR>\r
208 <TR BGCOLOR="white" CLASS="TableRowColor">\r
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
210 <CODE>&nbsp;<A HREF="../../../../../com/sun/speech/freetts/Token.html" title="class in com.sun.speech.freetts">Token</A></CODE></FONT></TD>\r
211 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#getNextToken()">getNextToken</A></B>()</CODE>\r
212 \r
213 <BR>\r
214 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next token.</TD>\r
215 </TR>\r
216 <TR BGCOLOR="white" CLASS="TableRowColor">\r
217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
218 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
219 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#hasErrors()">hasErrors</A></B>()</CODE>\r
220 \r
221 <BR>\r
222 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if there were errors while reading tokens</TD>\r
223 </TR>\r
224 <TR BGCOLOR="white" CLASS="TableRowColor">\r
225 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
226 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
227 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#hasMoreTokens()">hasMoreTokens</A></B>()</CODE>\r
228 \r
229 <BR>\r
230 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if there are more tokens,
231                 <code>false</code> otherwise.</TD>\r
232 </TR>\r
233 <TR BGCOLOR="white" CLASS="TableRowColor">\r
234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
235 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
236 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#isBreak()">isBreak</A></B>()</CODE>\r
237 \r
238 <BR>\r
239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the current token should start a new sentence.</TD>\r
240 </TR>\r
241 <TR BGCOLOR="white" CLASS="TableRowColor">\r
242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
243 <CODE>&nbsp;void</CODE></FONT></TD>\r
244 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#setInputReader(java.io.Reader)">setInputReader</A></B>(java.io.Reader&nbsp;reader)</CODE>\r
245 \r
246 <BR>\r
247 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the input reader</TD>\r
248 </TR>\r
249 <TR BGCOLOR="white" CLASS="TableRowColor">\r
250 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
251 <CODE>&nbsp;void</CODE></FONT></TD>\r
252 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#setInputText(java.lang.String)">setInputText</A></B>(java.lang.String&nbsp;inputString)</CODE>\r
253 \r
254 <BR>\r
255 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the text to tokenize.</TD>\r
256 </TR>\r
257 <TR BGCOLOR="white" CLASS="TableRowColor">\r
258 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
259 <CODE>&nbsp;void</CODE></FONT></TD>\r
260 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#setPostpunctuationSymbols(java.lang.String)">setPostpunctuationSymbols</A></B>(java.lang.String&nbsp;symbols)</CODE>\r
261 \r
262 <BR>\r
263 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the postpunctuation symbols of this Tokenizer to the given
264  symbols.</TD>\r
265 </TR>\r
266 <TR BGCOLOR="white" CLASS="TableRowColor">\r
267 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
268 <CODE>&nbsp;void</CODE></FONT></TD>\r
269 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#setPrepunctuationSymbols(java.lang.String)">setPrepunctuationSymbols</A></B>(java.lang.String&nbsp;symbols)</CODE>\r
270 \r
271 <BR>\r
272 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the prepunctuation symbols of this Tokenizer to the given
273  symbols.</TD>\r
274 </TR>\r
275 <TR BGCOLOR="white" CLASS="TableRowColor">\r
276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
277 <CODE>&nbsp;void</CODE></FONT></TD>\r
278 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#setSingleCharSymbols(java.lang.String)">setSingleCharSymbols</A></B>(java.lang.String&nbsp;symbols)</CODE>\r
279 \r
280 <BR>\r
281 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the single character symbols of this Tokenizer to the given
282  symbols.</TD>\r
283 </TR>\r
284 <TR BGCOLOR="white" CLASS="TableRowColor">\r
285 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
286 <CODE>&nbsp;void</CODE></FONT></TD>\r
287 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/TokenizerImpl.html#setWhitespaceSymbols(java.lang.String)">setWhitespaceSymbols</A></B>(java.lang.String&nbsp;symbols)</CODE>\r
288 \r
289 <BR>\r
290 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the whitespace symbols of this Tokenizer to the given symbols.</TD>\r
291 </TR>\r
292 </TABLE>\r
293 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
294 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
295 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
296 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
297 </TR>\r
298 <TR BGCOLOR="white" CLASS="TableRowColor">\r
299 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
300 </TR>\r
301 </TABLE>\r
302 &nbsp;\r
303 <P>\r
304 \r
305 <!-- ============ FIELD DETAIL =========== -->\r
306 \r
307 <A NAME="field_detail"><!-- --></A>
308 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
309 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
310 <TD COLSPAN=1><FONT SIZE="+2">\r
311 <B>Field Detail</B></FONT></TD>\r
312 </TR>\r
313 </TABLE>\r
314 \r
315 <A NAME="EOF"><!-- --></A><H3>\r
316 EOF</H3>\r
317 <PRE>\r
318 public static final int <B>EOF</B></PRE>\r
319 <DL>\r
320 <DD>A constant indicating that the end of the stream has been read.\r
321 <P>\r
322 <DL>\r
323 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sun.speech.freetts.en.TokenizerImpl.EOF">Constant Field Values</A></DL>\r
324 </DL>\r
325 <HR>\r
326 \r
327 <A NAME="DEFAULT_WHITESPACE_SYMBOLS"><!-- --></A><H3>\r
328 DEFAULT_WHITESPACE_SYMBOLS</H3>\r
329 <PRE>\r
330 public static final java.lang.String <B>DEFAULT_WHITESPACE_SYMBOLS</B></PRE>\r
331 <DL>\r
332 <DD>A string containing the default whitespace characters.\r
333 <P>\r
334 <DL>\r
335 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sun.speech.freetts.en.TokenizerImpl.DEFAULT_WHITESPACE_SYMBOLS">Constant Field Values</A></DL>\r
336 </DL>\r
337 <HR>\r
338 \r
339 <A NAME="DEFAULT_SINGLE_CHAR_SYMBOLS"><!-- --></A><H3>\r
340 DEFAULT_SINGLE_CHAR_SYMBOLS</H3>\r
341 <PRE>\r
342 public static final java.lang.String <B>DEFAULT_SINGLE_CHAR_SYMBOLS</B></PRE>\r
343 <DL>\r
344 <DD>A string containing the default single characters.\r
345 <P>\r
346 <DL>\r
347 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sun.speech.freetts.en.TokenizerImpl.DEFAULT_SINGLE_CHAR_SYMBOLS">Constant Field Values</A></DL>\r
348 </DL>\r
349 <HR>\r
350 \r
351 <A NAME="DEFAULT_PREPUNCTUATION_SYMBOLS"><!-- --></A><H3>\r
352 DEFAULT_PREPUNCTUATION_SYMBOLS</H3>\r
353 <PRE>\r
354 public static final java.lang.String <B>DEFAULT_PREPUNCTUATION_SYMBOLS</B></PRE>\r
355 <DL>\r
356 <DD>A string containing the default pre-punctuation characters.\r
357 <P>\r
358 <DL>\r
359 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sun.speech.freetts.en.TokenizerImpl.DEFAULT_PREPUNCTUATION_SYMBOLS">Constant Field Values</A></DL>\r
360 </DL>\r
361 <HR>\r
362 \r
363 <A NAME="DEFAULT_POSTPUNCTUATION_SYMBOLS"><!-- --></A><H3>\r
364 DEFAULT_POSTPUNCTUATION_SYMBOLS</H3>\r
365 <PRE>\r
366 public static final java.lang.String <B>DEFAULT_POSTPUNCTUATION_SYMBOLS</B></PRE>\r
367 <DL>\r
368 <DD>A string containing the default post-punctuation characters.\r
369 <P>\r
370 <DL>\r
371 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sun.speech.freetts.en.TokenizerImpl.DEFAULT_POSTPUNCTUATION_SYMBOLS">Constant Field Values</A></DL>\r
372 </DL>\r
373 \r
374 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
375 \r
376 <A NAME="constructor_detail"><!-- --></A>
377 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
378 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
379 <TD COLSPAN=1><FONT SIZE="+2">\r
380 <B>Constructor Detail</B></FONT></TD>\r
381 </TR>\r
382 </TABLE>\r
383 \r
384 <A NAME="TokenizerImpl()"><!-- --></A><H3>\r
385 TokenizerImpl</H3>\r
386 <PRE>\r
387 public <B>TokenizerImpl</B>()</PRE>\r
388 <DL>\r
389 <DD>Constructs a Tokenizer.\r
390 <P>\r
391 </DL>\r
392 <HR>\r
393 \r
394 <A NAME="TokenizerImpl(java.lang.String)"><!-- --></A><H3>\r
395 TokenizerImpl</H3>\r
396 <PRE>\r
397 public <B>TokenizerImpl</B>(java.lang.String&nbsp;string)</PRE>\r
398 <DL>\r
399 <DD>Creates a tokenizer that will return tokens from
400  the given string.\r
401 <P>\r
402 <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to tokenize</DL>\r
403 <HR>\r
404 \r
405 <A NAME="TokenizerImpl(java.io.Reader)"><!-- --></A><H3>\r
406 TokenizerImpl</H3>\r
407 <PRE>\r
408 public <B>TokenizerImpl</B>(java.io.Reader&nbsp;file)</PRE>\r
409 <DL>\r
410 <DD>Creates a tokenizer that will return tokens from
411  the given file.\r
412 <P>\r
413 <DT><B>Parameters:</B><DD><CODE>file</CODE> - where to read the input from</DL>\r
414 \r
415 <!-- ============ METHOD DETAIL ========== -->\r
416 \r
417 <A NAME="method_detail"><!-- --></A>
418 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
419 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
420 <TD COLSPAN=1><FONT SIZE="+2">\r
421 <B>Method Detail</B></FONT></TD>\r
422 </TR>\r
423 </TABLE>\r
424 \r
425 <A NAME="setWhitespaceSymbols(java.lang.String)"><!-- --></A><H3>\r
426 setWhitespaceSymbols</H3>\r
427 <PRE>\r
428 public void <B>setWhitespaceSymbols</B>(java.lang.String&nbsp;symbols)</PRE>\r
429 <DL>\r
430 <DD>Sets the whitespace symbols of this Tokenizer to the given symbols.\r
431 <P>\r
432 <DD><DL>\r
433 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#setWhitespaceSymbols(java.lang.String)">setWhitespaceSymbols</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
434 </DD>\r
435 <DD><DL>\r
436 <DT><B>Parameters:</B><DD><CODE>symbols</CODE> - the whitespace symbols</DL>\r
437 </DD>\r
438 </DL>\r
439 <HR>\r
440 \r
441 <A NAME="setSingleCharSymbols(java.lang.String)"><!-- --></A><H3>\r
442 setSingleCharSymbols</H3>\r
443 <PRE>\r
444 public void <B>setSingleCharSymbols</B>(java.lang.String&nbsp;symbols)</PRE>\r
445 <DL>\r
446 <DD>Sets the single character symbols of this Tokenizer to the given
447  symbols.\r
448 <P>\r
449 <DD><DL>\r
450 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#setSingleCharSymbols(java.lang.String)">setSingleCharSymbols</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
451 </DD>\r
452 <DD><DL>\r
453 <DT><B>Parameters:</B><DD><CODE>symbols</CODE> - the single character symbols</DL>\r
454 </DD>\r
455 </DL>\r
456 <HR>\r
457 \r
458 <A NAME="setPrepunctuationSymbols(java.lang.String)"><!-- --></A><H3>\r
459 setPrepunctuationSymbols</H3>\r
460 <PRE>\r
461 public void <B>setPrepunctuationSymbols</B>(java.lang.String&nbsp;symbols)</PRE>\r
462 <DL>\r
463 <DD>Sets the prepunctuation symbols of this Tokenizer to the given
464  symbols.\r
465 <P>\r
466 <DD><DL>\r
467 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#setPrepunctuationSymbols(java.lang.String)">setPrepunctuationSymbols</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
468 </DD>\r
469 <DD><DL>\r
470 <DT><B>Parameters:</B><DD><CODE>symbols</CODE> - the prepunctuation symbols</DL>\r
471 </DD>\r
472 </DL>\r
473 <HR>\r
474 \r
475 <A NAME="setPostpunctuationSymbols(java.lang.String)"><!-- --></A><H3>\r
476 setPostpunctuationSymbols</H3>\r
477 <PRE>\r
478 public void <B>setPostpunctuationSymbols</B>(java.lang.String&nbsp;symbols)</PRE>\r
479 <DL>\r
480 <DD>Sets the postpunctuation symbols of this Tokenizer to the given
481  symbols.\r
482 <P>\r
483 <DD><DL>\r
484 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#setPostpunctuationSymbols(java.lang.String)">setPostpunctuationSymbols</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
485 </DD>\r
486 <DD><DL>\r
487 <DT><B>Parameters:</B><DD><CODE>symbols</CODE> - the postpunctuation symbols</DL>\r
488 </DD>\r
489 </DL>\r
490 <HR>\r
491 \r
492 <A NAME="setInputText(java.lang.String)"><!-- --></A><H3>\r
493 setInputText</H3>\r
494 <PRE>\r
495 public void <B>setInputText</B>(java.lang.String&nbsp;inputString)</PRE>\r
496 <DL>\r
497 <DD>Sets the text to tokenize.\r
498 <P>\r
499 <DD><DL>\r
500 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#setInputText(java.lang.String)">setInputText</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
501 </DD>\r
502 <DD><DL>\r
503 <DT><B>Parameters:</B><DD><CODE>inputString</CODE> - the string to tokenize</DL>\r
504 </DD>\r
505 </DL>\r
506 <HR>\r
507 \r
508 <A NAME="setInputReader(java.io.Reader)"><!-- --></A><H3>\r
509 setInputReader</H3>\r
510 <PRE>\r
511 public void <B>setInputReader</B>(java.io.Reader&nbsp;reader)</PRE>\r
512 <DL>\r
513 <DD>Sets the input reader\r
514 <P>\r
515 <DD><DL>\r
516 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#setInputReader(java.io.Reader)">setInputReader</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
517 </DD>\r
518 <DD><DL>\r
519 <DT><B>Parameters:</B><DD><CODE>reader</CODE> - the input source</DL>\r
520 </DD>\r
521 </DL>\r
522 <HR>\r
523 \r
524 <A NAME="getNextToken()"><!-- --></A><H3>\r
525 getNextToken</H3>\r
526 <PRE>\r
527 public <A HREF="../../../../../com/sun/speech/freetts/Token.html" title="class in com.sun.speech.freetts">Token</A> <B>getNextToken</B>()</PRE>\r
528 <DL>\r
529 <DD>Returns the next token.\r
530 <P>\r
531 <DD><DL>\r
532 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#getNextToken()">getNextToken</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
533 </DD>\r
534 <DD><DL>\r
535
536 <DT><B>Returns:</B><DD>the next token if it exists,
537           <code>null</code> if no more tokens</DL>\r
538 </DD>\r
539 </DL>\r
540 <HR>\r
541 \r
542 <A NAME="hasMoreTokens()"><!-- --></A><H3>\r
543 hasMoreTokens</H3>\r
544 <PRE>\r
545 public boolean <B>hasMoreTokens</B>()</PRE>\r
546 <DL>\r
547 <DD>Returns <code>true</code> if there are more tokens,
548                 <code>false</code> otherwise.\r
549 <P>\r
550 <DD><DL>\r
551 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#hasMoreTokens()">hasMoreTokens</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
552 </DD>\r
553 <DD><DL>\r
554
555 <DT><B>Returns:</B><DD><code>true</code> if there are more tokens
556          <code>false</code> otherwise</DL>\r
557 </DD>\r
558 </DL>\r
559 <HR>\r
560 \r
561 <A NAME="hasErrors()"><!-- --></A><H3>\r
562 hasErrors</H3>\r
563 <PRE>\r
564 public boolean <B>hasErrors</B>()</PRE>\r
565 <DL>\r
566 <DD>Returns <code>true</code> if there were errors while reading tokens\r
567 <P>\r
568 <DD><DL>\r
569 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#hasErrors()">hasErrors</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
570 </DD>\r
571 <DD><DL>\r
572
573 <DT><B>Returns:</B><DD><code>true</code> if there were errors;
574                 <code>false</code> otherwise</DL>\r
575 </DD>\r
576 </DL>\r
577 <HR>\r
578 \r
579 <A NAME="getErrorDescription()"><!-- --></A><H3>\r
580 getErrorDescription</H3>\r
581 <PRE>\r
582 public java.lang.String <B>getErrorDescription</B>()</PRE>\r
583 <DL>\r
584 <DD>if hasErrors returns <code>true</code>, this will return a 
585  description of the error encountered, otherwise
586  it will return <code>null</code>\r
587 <P>\r
588 <DD><DL>\r
589 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#getErrorDescription()">getErrorDescription</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
590 </DD>\r
591 <DD><DL>\r
592
593 <DT><B>Returns:</B><DD>a description of the last error that occurred.</DL>\r
594 </DD>\r
595 </DL>\r
596 <HR>\r
597 \r
598 <A NAME="isBreak()"><!-- --></A><H3>\r
599 isBreak</H3>\r
600 <PRE>\r
601 public boolean <B>isBreak</B>()</PRE>\r
602 <DL>\r
603 <DD>Determines if the current token should start a new sentence.\r
604 <P>\r
605 <DD><DL>\r
606 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html#isBreak()">isBreak</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></DL>\r
607 </DD>\r
608 <DD><DL>\r
609
610 <DT><B>Returns:</B><DD><code>true</code> if a new sentence should be started</DL>\r
611 </DD>\r
612 </DL>\r
613 <!-- ========= END OF CLASS DATA ========= -->\r
614 <HR>\r
615 \r
616
617 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
618 <A NAME="navbar_bottom"><!-- --></A>
619 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
620 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
621 <TR>\r
622 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
623 <A NAME="navbar_bottom_firstrow"><!-- --></A>
624 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
625   <TR ALIGN="center" VALIGN="top">\r
626   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
627   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
628   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
629   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
630   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
631   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
632   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
633   </TR>\r
634 </TABLE>\r
635 </TD>\r
636 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
637 </EM>\r
638 </TD>\r
639 </TR>\r
640 \r
641 <TR>\r
642 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
643 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/en/PostLexicalAnalyzer.html" title="class in com.sun.speech.freetts.en"><B>PREV CLASS</B></A>&nbsp;\r
644 &nbsp;NEXT CLASS</FONT></TD>\r
645 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
646   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
647 &nbsp;<A HREF="TokenizerImpl.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
648 &nbsp;<SCRIPT type="text/javascript">\r
649   <!--\r
650   if(window==top) {\r
651     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
652   }\r
653   //-->\r
654 </SCRIPT>\r
655 <NOSCRIPT>\r
656   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
657 </NOSCRIPT>
658 \r
659 </FONT></TD>\r
660 </TR>\r
661 <TR>\r
662 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
663   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
664 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
665 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
666 </TR>\r
667 </TABLE>\r
668 <A NAME="skip-navbar_bottom"></A>
669 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
670 \r
671 <HR>\r
672 \r
673 </BODY>\r
674 </HTML>\r