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 Segmenter (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Segmenter class">
\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="Segmenter (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/Relation.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <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>
\r
56 <A HREF="Segmenter.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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 Class Segmenter</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.Segmenter</B>
\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
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
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
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
116 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
119 <!-- =========== FIELD SUMMARY =========== -->
\r
122 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\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
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
134 </TD>
\r
138 <!-- ========== METHOD SUMMARY =========== -->
\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
146 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
148 <CODE>protected 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 phone)</CODE>
\r
152 Converts stressed phoneme to regular phoneme. </TD>
\r
154 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
156 <CODE>protected 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 phone)</CODE>
\r
160 Determines if the given phonemene is stressed.
163 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
165 <CODE> 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> utterance)</CODE>
\r
169 Annotates an utterance with <code>Relation.SYLLABLE</code>,
170 <code>Relation.SYLLABLE_STRUCTURE</code>, and
171 <code>Relation.SEGMENT</code>.</TD>
\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
175 <CODE> 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
179 Returns the simple name of this class.</TD>
\r
182 <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
187 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
188 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
194 <!-- ============ FIELD DETAIL =========== -->
\r
197 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\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
207 <A NAME="Segmenter()"><!-- --></A><H3>
\r
210 public <B>Segmenter</B>()</PRE>
\r
214 <!-- ============ METHOD DETAIL ========== -->
\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
224 <A NAME="processUtterance(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>
\r
225 processUtterance</H3>
\r
227 public void <B>processUtterance</B>(<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> utterance)
228 throws <A HREF="../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></PRE>
\r
230 <DD>Annotates an utterance with <code>Relation.SYLLABLE</code>,
231 <code>Relation.SYLLABLE_STRUCTURE</code>, and
232 <code>Relation.SEGMENT</code>.
\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
238 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the utterance to process/tokenize
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
248 <A NAME="isStressed(java.lang.String)"><!-- --></A><H3>
\r
251 protected boolean <B>isStressed</B>(java.lang.String phone)</PRE>
\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
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
268 <A NAME="deStress(java.lang.String)"><!-- --></A><H3>
\r
271 protected java.lang.String <B>deStress</B>(java.lang.String phone)</PRE>
\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
281 <DT><B>Parameters:</B><DD><CODE>phone</CODE> - the phone to convert
282 <DT><B>Returns:</B><DD>de-stressed phone</DL>
\r
287 <A NAME="toString()"><!-- --></A><H3>
\r
290 public java.lang.String <B>toString</B>()</PRE>
\r
292 <DD>Returns the simple name of this class.
\r
299 <DT><B>Returns:</B><DD>the simple name of this class</DL>
\r
302 <!-- ========= END OF CLASS DATA ========= -->
\r
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
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> </TD>
\r
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
317 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
325 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
331 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
332 <A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
333 <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>
\r
336 <A HREF="Segmenter.html" target="_top"><B>NO FRAMES</B></A>
\r
337 <SCRIPT type="text/javascript">
\r
340 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
345 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
351 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
352 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
353 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
354 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
357 <A NAME="skip-navbar_bottom"></A>
358 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r