add a cleanup script to elide the non-free jsapi binary blob from the sources
[debian/freetts] / javadoc / com / sun / speech / freetts / Segmenter.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:29 CET 2009 -->\r
6 <TITLE>\r
7 Segmenter (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Segmenter 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="Segmenter (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/Relation.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Token.html" title="class 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>  &nbsp;\r
56 &nbsp;<A HREF="Segmenter.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;<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</FONT>\r
85 <BR>\r
86 Class Segmenter</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.Segmenter</B>\r
90 </PRE>\r
91 <DL>\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>Segmenter</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></DL>\r
97 \r
98 <P>\r
99 Annotates an utterance with <code>Relation.SYLLABLE</code>,
100  <code>Relation.SYLLABLE_STRUCTURE</code>, and
101  <code>Relation.SEGMENT</code>.
102  To determine stress, the <code>isStressed</code> method relies upon
103  a phone ending in the number "1".  Subclasses should override
104  <code>isStressed</code> and <code>deStress</code> if stresses are
105  determined in other ways.\r
106 <P>\r
107 \r
108 <P>\r
109 <DL>\r
110 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Relation.html#SEGMENT"><CODE>Relation.SEGMENT</CODE></A>, 
111 <A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE"><CODE>Relation.SYLLABLE</CODE></A>, 
112 <A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE_STRUCTURE"><CODE>Relation.SYLLABLE_STRUCTURE</CODE></A></DL>\r
113 <HR>\r
114 \r
115 <P>\r
116 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
117 \r
118 \r
119 <!-- =========== FIELD SUMMARY =========== -->\r
120 \r
121 \r
122 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
123 \r
124 <A NAME="constructor_summary"><!-- --></A>
125 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
126 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
127 <TD COLSPAN=2><FONT SIZE="+2">\r
128 <B>Constructor Summary</B></FONT></TD>\r
129 </TR>\r
130 <TR BGCOLOR="white" CLASS="TableRowColor">\r
131 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Segmenter.html#Segmenter()">Segmenter</A></B>()</CODE>\r
132 \r
133 <BR>\r
134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
135 </TR>\r
136 </TABLE>\r
137 &nbsp;\r
138 <!-- ========== METHOD SUMMARY =========== -->\r
139 \r
140 <A NAME="method_summary"><!-- --></A>
141 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
142 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
143 <TD COLSPAN=2><FONT SIZE="+2">\r
144 <B>Method Summary</B></FONT></TD>\r
145 </TR>\r
146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
148 <CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>\r
149 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Segmenter.html#deStress(java.lang.String)">deStress</A></B>(java.lang.String&nbsp;phone)</CODE>\r
150 \r
151 <BR>\r
152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts stressed phoneme to regular phoneme.  </TD>\r
153 </TR>\r
154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
156 <CODE>protected &nbsp;boolean</CODE></FONT></TD>\r
157 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Segmenter.html#isStressed(java.lang.String)">isStressed</A></B>(java.lang.String&nbsp;phone)</CODE>\r
158 \r
159 <BR>\r
160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the given phonemene is stressed.
161  </TD>\r
162 </TR>\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
165 <CODE>&nbsp;void</CODE></FONT></TD>\r
166 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Segmenter.html#processUtterance(com.sun.speech.freetts.Utterance)">processUtterance</A></B>(<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance)</CODE>\r
167 \r
168 <BR>\r
169 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Annotates an utterance with <code>Relation.SYLLABLE</code>,
170  <code>Relation.SYLLABLE_STRUCTURE</code>, and
171  <code>Relation.SEGMENT</code>.</TD>\r
172 </TR>\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">\r
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
175 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
176 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Segmenter.html#toString()">toString</A></B>()</CODE>\r
177 \r
178 <BR>\r
179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the simple name of this class.</TD>\r
180 </TR>\r
181 </TABLE>\r
182 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
183 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
184 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
185 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
186 </TR>\r
187 <TR BGCOLOR="white" CLASS="TableRowColor">\r
188 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
189 </TR>\r
190 </TABLE>\r
191 &nbsp;\r
192 <P>\r
193 \r
194 <!-- ============ FIELD DETAIL =========== -->\r
195 \r
196 \r
197 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
198 \r
199 <A NAME="constructor_detail"><!-- --></A>
200 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
201 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
202 <TD COLSPAN=1><FONT SIZE="+2">\r
203 <B>Constructor Detail</B></FONT></TD>\r
204 </TR>\r
205 </TABLE>\r
206 \r
207 <A NAME="Segmenter()"><!-- --></A><H3>\r
208 Segmenter</H3>\r
209 <PRE>\r
210 public <B>Segmenter</B>()</PRE>\r
211 <DL>\r
212 </DL>\r
213 \r
214 <!-- ============ METHOD DETAIL ========== -->\r
215 \r
216 <A NAME="method_detail"><!-- --></A>
217 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
218 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
219 <TD COLSPAN=1><FONT SIZE="+2">\r
220 <B>Method Detail</B></FONT></TD>\r
221 </TR>\r
222 </TABLE>\r
223 \r
224 <A NAME="processUtterance(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>\r
225 processUtterance</H3>\r
226 <PRE>\r
227 public void <B>processUtterance</B>(<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance)
228                       throws <A HREF="../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></PRE>\r
229 <DL>\r
230 <DD>Annotates an utterance with <code>Relation.SYLLABLE</code>,
231  <code>Relation.SYLLABLE_STRUCTURE</code>, and
232  <code>Relation.SEGMENT</code>.\r
233 <P>\r
234 <DD><DL>\r
235 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html#processUtterance(com.sun.speech.freetts.Utterance)">processUtterance</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></CODE></DL>\r
236 </DD>\r
237 <DD><DL>\r
238 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the utterance to process/tokenize
239 <DT><B>Throws:</B>
240 <DD><CODE><A HREF="../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></CODE> - if an IOException is thrown during the
241    processing of the utterance<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Relation.html#SEGMENT"><CODE>Relation.SEGMENT</CODE></A>, 
242 <A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE"><CODE>Relation.SYLLABLE</CODE></A>, 
243 <A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE_STRUCTURE"><CODE>Relation.SYLLABLE_STRUCTURE</CODE></A></DL>\r
244 </DD>\r
245 </DL>\r
246 <HR>\r
247 \r
248 <A NAME="isStressed(java.lang.String)"><!-- --></A><H3>\r
249 isStressed</H3>\r
250 <PRE>\r
251 protected boolean <B>isStressed</B>(java.lang.String&nbsp;phone)</PRE>\r
252 <DL>\r
253 <DD>Determines if the given phonemene is stressed.
254  To determine stress, this method relies upon
255  a phone ending in the number "1".  Subclasses should override this
256  method if stresses are determined in other ways.\r
257 <P>\r
258 <DD><DL>\r
259 </DL>\r
260 </DD>\r
261 <DD><DL>\r
262 <DT><B>Parameters:</B><DD><CODE>phone</CODE> - the phone to check
263 <DT><B>Returns:</B><DD>true if the phone is stressed, otherwise false</DL>\r
264 </DD>\r
265 </DL>\r
266 <HR>\r
267 \r
268 <A NAME="deStress(java.lang.String)"><!-- --></A><H3>\r
269 deStress</H3>\r
270 <PRE>\r
271 protected java.lang.String <B>deStress</B>(java.lang.String&nbsp;phone)</PRE>\r
272 <DL>\r
273 <DD>Converts stressed phoneme to regular phoneme.  This method
274  merely removes the last character of the phone.  Subclasses
275  should override this if another method is to be used.\r
276 <P>\r
277 <DD><DL>\r
278 </DL>\r
279 </DD>\r
280 <DD><DL>\r
281 <DT><B>Parameters:</B><DD><CODE>phone</CODE> - the phone to convert
282 <DT><B>Returns:</B><DD>de-stressed phone</DL>\r
283 </DD>\r
284 </DL>\r
285 <HR>\r
286 \r
287 <A NAME="toString()"><!-- --></A><H3>\r
288 toString</H3>\r
289 <PRE>\r
290 public java.lang.String <B>toString</B>()</PRE>\r
291 <DL>\r
292 <DD>Returns the simple name of this class.\r
293 <P>\r
294 <DD><DL>\r
295 </DL>\r
296 </DD>\r
297 <DD><DL>\r
298
299 <DT><B>Returns:</B><DD>the simple name of this class</DL>\r
300 </DD>\r
301 </DL>\r
302 <!-- ========= END OF CLASS DATA ========= -->\r
303 <HR>\r
304 \r
305
306 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
307 <A NAME="navbar_bottom"><!-- --></A>
308 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
309 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
310 <TR>\r
311 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
312 <A NAME="navbar_bottom_firstrow"><!-- --></A>
313 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
314   <TR ALIGN="center" VALIGN="top">\r
315   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
316   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
317   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
318   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
319   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
320   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
321   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
322   </TR>\r
323 </TABLE>\r
324 </TD>\r
325 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
326 </EM>\r
327 </TD>\r
328 </TR>\r
329 \r
330 <TR>\r
331 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
332 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
333 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Token.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
334 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
335   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
336 &nbsp;<A HREF="Segmenter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
337 &nbsp;<SCRIPT type="text/javascript">\r
338   <!--\r
339   if(window==top) {\r
340     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
341   }\r
342   //-->\r
343 </SCRIPT>\r
344 <NOSCRIPT>\r
345   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
346 </NOSCRIPT>
347 \r
348 </FONT></TD>\r
349 </TR>\r
350 <TR>\r
351 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
352   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
353 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
354 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
355 </TR>\r
356 </TABLE>\r
357 <A NAME="skip-navbar_bottom"></A>
358 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
359 \r
360 <HR>\r
361 \r
362 </BODY>\r
363 </HTML>\r