1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->
\r
7 Tokenizer (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Tokenizer interface">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="Tokenizer (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
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
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> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/Unit.html" title="interface in com.sun.speech.freetts"><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>
\r
56 <A HREF="Tokenizer.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.freetts</FONT>
\r
86 Interface Tokenizer</H2>
\r
88 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/sun/speech/freetts/en/TokenizerImpl.html" title="class in com.sun.speech.freetts.en">TokenizerImpl</A></DD>
\r
92 <DT>public interface <B>Tokenizer</B></DL>
\r
95 Chops a string or text file into Token instances.
\r
102 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
105 <!-- =========== FIELD SUMMARY =========== -->
\r
108 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
111 <!-- ========== METHOD SUMMARY =========== -->
\r
113 <A NAME="method_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>Method Summary</B></FONT></TD>
\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
121 <CODE> java.lang.String</CODE></FONT></TD>
\r
122 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#getErrorDescription()">getErrorDescription</A></B>()</CODE>
\r
125 If hasErrors returns true, returns a description of the error
128 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
129 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
130 <CODE> <A HREF="../../../../com/sun/speech/freetts/Token.html" title="class in com.sun.speech.freetts">Token</A></CODE></FONT></TD>
\r
131 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#getNextToken()">getNextToken</A></B>()</CODE>
\r
134 Returns the next token.</TD>
\r
136 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
137 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
138 <CODE> boolean</CODE></FONT></TD>
\r
139 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#hasErrors()">hasErrors</A></B>()</CODE>
\r
142 Returns true if there were errors while reading tokens.</TD>
\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
146 <CODE> boolean</CODE></FONT></TD>
\r
147 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#hasMoreTokens()">hasMoreTokens</A></B>()</CODE>
\r
150 Returns true if there are more tokens, false otherwise.</TD>
\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
154 <CODE> boolean</CODE></FONT></TD>
\r
155 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#isBreak()">isBreak</A></B>()</CODE>
\r
158 Determines if the current token should start a new sentence.</TD>
\r
160 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
162 <CODE> void</CODE></FONT></TD>
\r
163 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#setInputReader(java.io.Reader)">setInputReader</A></B>(java.io.Reader reader)</CODE>
\r
166 Sets the input reader.</TD>
\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
170 <CODE> void</CODE></FONT></TD>
\r
171 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#setInputText(java.lang.String)">setInputText</A></B>(java.lang.String textToTokenize)</CODE>
\r
174 Sets the text to be tokenized by this tokenizer.</TD>
\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
178 <CODE> void</CODE></FONT></TD>
\r
179 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#setPostpunctuationSymbols(java.lang.String)">setPostpunctuationSymbols</A></B>(java.lang.String symbols)</CODE>
\r
182 Sets the postpunctuation symbols of this Tokenizer to the given
185 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
186 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
187 <CODE> void</CODE></FONT></TD>
\r
188 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#setPrepunctuationSymbols(java.lang.String)">setPrepunctuationSymbols</A></B>(java.lang.String symbols)</CODE>
\r
191 Sets the prepunctuation symbols of this Tokenizer to the given
194 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
196 <CODE> void</CODE></FONT></TD>
\r
197 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#setSingleCharSymbols(java.lang.String)">setSingleCharSymbols</A></B>(java.lang.String symbols)</CODE>
\r
200 Sets the single character symbols of this Tokenizer to the given
203 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
205 <CODE> void</CODE></FONT></TD>
\r
206 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Tokenizer.html#setWhitespaceSymbols(java.lang.String)">setWhitespaceSymbols</A></B>(java.lang.String symbols)</CODE>
\r
209 Sets the whitespace symbols of this Tokenizer to the given
216 <!-- ============ FIELD DETAIL =========== -->
\r
219 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
222 <!-- ============ METHOD DETAIL ========== -->
\r
224 <A NAME="method_detail"><!-- --></A>
225 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
226 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
227 <TD COLSPAN=1><FONT SIZE="+2">
\r
228 <B>Method Detail</B></FONT></TD>
\r
232 <A NAME="setInputText(java.lang.String)"><!-- --></A><H3>
\r
235 public void <B>setInputText</B>(java.lang.String textToTokenize)</PRE>
\r
237 <DD>Sets the text to be tokenized by this tokenizer.
\r
240 <DT><B>Parameters:</B><DD><CODE>textToTokenize</CODE> - the text to tokenize</DL>
\r
245 <A NAME="setInputReader(java.io.Reader)"><!-- --></A><H3>
\r
246 setInputReader</H3>
\r
248 public void <B>setInputReader</B>(java.io.Reader reader)</PRE>
\r
250 <DD>Sets the input reader.
\r
253 <DT><B>Parameters:</B><DD><CODE>reader</CODE> - the input source</DL>
\r
258 <A NAME="getNextToken()"><!-- --></A><H3>
\r
261 public <A HREF="../../../../com/sun/speech/freetts/Token.html" title="class in com.sun.speech.freetts">Token</A> <B>getNextToken</B>()</PRE>
\r
263 <DD>Returns the next token.
\r
267 <DT><B>Returns:</B><DD>the next token if it exists; otherwise null</DL>
\r
272 <A NAME="hasMoreTokens()"><!-- --></A><H3>
\r
275 public boolean <B>hasMoreTokens</B>()</PRE>
\r
277 <DD>Returns true if there are more tokens, false otherwise.
\r
281 <DT><B>Returns:</B><DD>true if there are more tokens; otherwise false</DL>
\r
286 <A NAME="hasErrors()"><!-- --></A><H3>
\r
289 public boolean <B>hasErrors</B>()</PRE>
\r
291 <DD>Returns true if there were errors while reading tokens.
\r
295 <DT><B>Returns:</B><DD>true if there were errors; otherwise false</DL>
\r
300 <A NAME="getErrorDescription()"><!-- --></A><H3>
\r
301 getErrorDescription</H3>
\r
303 public java.lang.String <B>getErrorDescription</B>()</PRE>
\r
305 <DD>If hasErrors returns true, returns a description of the error
306 encountered. Otherwise returns null.
\r
310 <DT><B>Returns:</B><DD>a description of the last error that occurred</DL>
\r
315 <A NAME="setWhitespaceSymbols(java.lang.String)"><!-- --></A><H3>
\r
316 setWhitespaceSymbols</H3>
\r
318 public void <B>setWhitespaceSymbols</B>(java.lang.String symbols)</PRE>
\r
320 <DD>Sets the whitespace symbols of this Tokenizer to the given
324 <DT><B>Parameters:</B><DD><CODE>symbols</CODE> - the whitespace symbols</DL>
\r
329 <A NAME="setSingleCharSymbols(java.lang.String)"><!-- --></A><H3>
\r
330 setSingleCharSymbols</H3>
\r
332 public void <B>setSingleCharSymbols</B>(java.lang.String symbols)</PRE>
\r
334 <DD>Sets the single character symbols of this Tokenizer to the given
338 <DT><B>Parameters:</B><DD><CODE>symbols</CODE> - the single character symbols</DL>
\r
343 <A NAME="setPrepunctuationSymbols(java.lang.String)"><!-- --></A><H3>
\r
344 setPrepunctuationSymbols</H3>
\r
346 public void <B>setPrepunctuationSymbols</B>(java.lang.String symbols)</PRE>
\r
348 <DD>Sets the prepunctuation symbols of this Tokenizer to the given
352 <DT><B>Parameters:</B><DD><CODE>symbols</CODE> - the prepunctuation symbols</DL>
\r
357 <A NAME="setPostpunctuationSymbols(java.lang.String)"><!-- --></A><H3>
\r
358 setPostpunctuationSymbols</H3>
\r
360 public void <B>setPostpunctuationSymbols</B>(java.lang.String symbols)</PRE>
\r
362 <DD>Sets the postpunctuation symbols of this Tokenizer to the given
366 <DT><B>Parameters:</B><DD><CODE>symbols</CODE> - the postpunctuation symbols</DL>
\r
371 <A NAME="isBreak()"><!-- --></A><H3>
\r
374 public boolean <B>isBreak</B>()</PRE>
\r
376 <DD>Determines if the current token should start a new sentence.
\r
380 <DT><B>Returns:</B><DD>true if a new sentence should be started</DL>
\r
383 <!-- ========= END OF CLASS DATA ========= -->
\r
387 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
388 <A NAME="navbar_bottom"><!-- --></A>
389 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
390 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
392 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
393 <A NAME="navbar_bottom_firstrow"><!-- --></A>
394 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
395 <TR ALIGN="center" VALIGN="top">
\r
396 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
397 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
398 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
399 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
400 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
401 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
402 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
406 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
412 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
413 <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
414 <A HREF="../../../../com/sun/speech/freetts/Unit.html" title="interface in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
415 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
416 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
417 <A HREF="Tokenizer.html" target="_top"><B>NO FRAMES</B></A>
\r
418 <SCRIPT type="text/javascript">
\r
421 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
426 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
432 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
433 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
434 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
435 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
438 <A NAME="skip-navbar_bottom"></A>
439 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob