upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / cart / Phraser.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 Phraser (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.cart.Phraser 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="Phraser (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/cart/Intonator.html" title="class in com.sun.speech.freetts.cart"><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="Phraser.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.cart</FONT>\r
85 <BR>\r
86 Class Phraser</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.cart.Phraser</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>Phraser</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 Creates a <code>Relation.PHRASE</code> relation, grouping
100  <code>Relation.WORD</code> relations by breaks.\r
101 <P>\r
102 \r
103 <P>\r
104 <DL>\r
105 <DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/freetts/Relation.html#PHRASE"><CODE>Relation.PHRASE</CODE></A>, 
106 <A HREF="../../../../../com/sun/speech/freetts/Relation.html#WORD"><CODE>Relation.WORD</CODE></A></DL>\r
107 <HR>\r
108 \r
109 <P>\r
110 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
111 \r
112 \r
113 <!-- =========== FIELD SUMMARY =========== -->\r
114 \r
115 <A NAME="field_summary"><!-- --></A>
116 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
117 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
118 <TD COLSPAN=2><FONT SIZE="+2">\r
119 <B>Field Summary</B></FONT></TD>\r
120 </TR>\r
121 <TR BGCOLOR="white" CLASS="TableRowColor">\r
122 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
123 <CODE>protected &nbsp;<A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A></CODE></FONT></TD>\r
124 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Phraser.html#cart">cart</A></B></CODE>\r
125 \r
126 <BR>\r
127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The CART used for this Phrasing UtteranceProcessor.  </TD>\r
128 </TR>\r
129 </TABLE>\r
130 &nbsp;\r
131 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
132 \r
133 <A NAME="constructor_summary"><!-- --></A>
134 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
135 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
136 <TD COLSPAN=2><FONT SIZE="+2">\r
137 <B>Constructor Summary</B></FONT></TD>\r
138 </TR>\r
139 <TR BGCOLOR="white" CLASS="TableRowColor">\r
140 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Phraser.html#Phraser(com.sun.speech.freetts.cart.CART)">Phraser</A></B>(<A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A>&nbsp;cart)</CODE>\r
141 \r
142 <BR>\r
143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new Phrasing UtteranceProcessor with the given
144  CART.  </TD>\r
145 </TR>\r
146 </TABLE>\r
147 &nbsp;\r
148 <!-- ========== METHOD SUMMARY =========== -->\r
149 \r
150 <A NAME="method_summary"><!-- --></A>
151 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
152 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
153 <TD COLSPAN=2><FONT SIZE="+2">\r
154 <B>Method Summary</B></FONT></TD>\r
155 </TR>\r
156 <TR BGCOLOR="white" CLASS="TableRowColor">\r
157 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
158 <CODE>&nbsp;void</CODE></FONT></TD>\r
159 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Phraser.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
160 \r
161 <BR>\r
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <code>Relation.PHRASE</code> relation, grouping
163  <code>Relation.WORD</code> relations by breaks.
164  </TD>\r
165 </TR>\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
168 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
169 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Phraser.html#toString()">toString</A></B>()</CODE>\r
170 \r
171 <BR>\r
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
173 </TR>\r
174 </TABLE>\r
175 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
176 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
177 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
178 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
179 </TR>\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">\r
181 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
182 </TR>\r
183 </TABLE>\r
184 &nbsp;\r
185 <P>\r
186 \r
187 <!-- ============ FIELD DETAIL =========== -->\r
188 \r
189 <A NAME="field_detail"><!-- --></A>
190 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
191 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
192 <TD COLSPAN=1><FONT SIZE="+2">\r
193 <B>Field Detail</B></FONT></TD>\r
194 </TR>\r
195 </TABLE>\r
196 \r
197 <A NAME="cart"><!-- --></A><H3>\r
198 cart</H3>\r
199 <PRE>\r
200 protected final <A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A> <B>cart</B></PRE>\r
201 <DL>\r
202 <DD>The CART used for this Phrasing UtteranceProcessor.  It is
203  passed into the constructor.\r
204 <P>\r
205 <DL>\r
206 </DL>\r
207 </DL>\r
208 \r
209 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
210 \r
211 <A NAME="constructor_detail"><!-- --></A>
212 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
213 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
214 <TD COLSPAN=1><FONT SIZE="+2">\r
215 <B>Constructor Detail</B></FONT></TD>\r
216 </TR>\r
217 </TABLE>\r
218 \r
219 <A NAME="Phraser(com.sun.speech.freetts.cart.CART)"><!-- --></A><H3>\r
220 Phraser</H3>\r
221 <PRE>\r
222 public <B>Phraser</B>(<A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A>&nbsp;cart)</PRE>\r
223 <DL>\r
224 <DD>Creates a new Phrasing UtteranceProcessor with the given
225  CART.  The phrasing CART is expected to return "BB" values
226  for big breaks.\r
227 <P>\r
228 <DT><B>Parameters:</B><DD><CODE>cart</CODE> - a phrasing CART</DL>\r
229 \r
230 <!-- ============ METHOD DETAIL ========== -->\r
231 \r
232 <A NAME="method_detail"><!-- --></A>
233 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
234 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
235 <TD COLSPAN=1><FONT SIZE="+2">\r
236 <B>Method Detail</B></FONT></TD>\r
237 </TR>\r
238 </TABLE>\r
239 \r
240 <A NAME="processUtterance(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>\r
241 processUtterance</H3>\r
242 <PRE>\r
243 public void <B>processUtterance</B>(<A HREF="../../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance)
244                       throws <A HREF="../../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></PRE>\r
245 <DL>\r
246 <DD>Creates a <code>Relation.PHRASE</code> relation, grouping
247  <code>Relation.WORD</code> relations by breaks.
248  Depends upon a phrasing CART that returns strings containing
249  "BB" for big breaks.\r
250 <P>\r
251 <DD><DL>\r
252 <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
253 </DD>\r
254 <DD><DL>\r
255 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the utterance to process
256 <DT><B>Throws:</B>
257 <DD><CODE><A HREF="../../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></CODE> - if a problem is encountered during the
258          processing of the utterance</DL>\r
259 </DD>\r
260 </DL>\r
261 <HR>\r
262 \r
263 <A NAME="toString()"><!-- --></A><H3>\r
264 toString</H3>\r
265 <PRE>\r
266 public java.lang.String <B>toString</B>()</PRE>\r
267 <DL>\r
268 <DD><DL>\r
269 </DL>\r
270 </DD>\r
271 <DD><DL>\r
272 </DL>\r
273 </DD>\r
274 </DL>\r
275 <!-- ========= END OF CLASS DATA ========= -->\r
276 <HR>\r
277 \r
278
279 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
280 <A NAME="navbar_bottom"><!-- --></A>
281 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
282 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
283 <TR>\r
284 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
285 <A NAME="navbar_bottom_firstrow"><!-- --></A>
286 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
287   <TR ALIGN="center" VALIGN="top">\r
288   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
289   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
290   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
291   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
292   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
293   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
294   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
295   </TR>\r
296 </TABLE>\r
297 </TD>\r
298 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
299 </EM>\r
300 </TD>\r
301 </TR>\r
302 \r
303 <TR>\r
304 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
305 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/cart/Intonator.html" title="class in com.sun.speech.freetts.cart"><B>PREV CLASS</B></A>&nbsp;\r
306 &nbsp;NEXT CLASS</FONT></TD>\r
307 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
308   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
309 &nbsp;<A HREF="Phraser.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
310 &nbsp;<SCRIPT type="text/javascript">\r
311   <!--\r
312   if(window==top) {\r
313     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
314   }\r
315   //-->\r
316 </SCRIPT>\r
317 <NOSCRIPT>\r
318   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
319 </NOSCRIPT>
320 \r
321 </FONT></TD>\r
322 </TR>\r
323 <TR>\r
324 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
325   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
326 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
327 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
328 </TR>\r
329 </TABLE>\r
330 <A NAME="skip-navbar_bottom"></A>
331 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
332 \r
333 <HR>\r
334 \r
335 </BODY>\r
336 </HTML>\r