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 Utterance (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Utterance 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="Utterance (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/Token.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/Voice.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="Utterance.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 Utterance</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.Utterance</B>
\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A>, <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A>, java.io.Serializable</DD>
\r
96 <DT>public class <B>Utterance</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A>, java.io.Serializable</DL>
\r
99 Holds all the data for an utterance to be spoken.
100 It is incrementally modified by various UtteranceProcessor
101 implementations. An utterance contains a set of Features (essential
102 a set of properties) and a set of Relations. A Relation is an
103 ordered set of Item graphs. The utterance contains a set of
104 features and implements FeatureSet so that applications can set/get
105 features directly from the utterance. If a feature query is not
106 found in the utterance feature set, the query is forwarded to the
107 FeatureSet of the voice associated with the utterance.
\r
112 <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.sun.speech.freetts.Utterance">Serialized Form</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/Utterance.html#Utterance(com.sun.speech.freetts.Voice)">Utterance</A></B>(<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A> voice)</CODE>
\r
134 Creates a new, empty utterance.</TD>
\r
136 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
137 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#Utterance(com.sun.speech.freetts.Voice, java.util.List)">Utterance</A></B>(<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A> voice,
138 java.util.List tokenList)</CODE>
\r
141 Creates an utterance with the given set of tokenized text.</TD>
\r
145 <!-- ========== METHOD SUMMARY =========== -->
\r
147 <A NAME="method_summary"><!-- --></A>
148 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
149 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
150 <TD COLSPAN=2><FONT SIZE="+2">
\r
151 <B>Method Summary</B></FONT></TD>
\r
153 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
155 <CODE> <A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A></CODE></FONT></TD>
\r
156 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#createRelation(java.lang.String)">createRelation</A></B>(java.lang.String name)</CODE>
\r
159 Creates a new relation with the given name and adds it to this
162 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
164 <CODE> void</CODE></FONT></TD>
\r
165 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></B>(java.io.PrintWriter output,
167 java.lang.String title)</CODE>
\r
170 Dumps this utterance in textual form.</TD>
\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
174 <CODE> void</CODE></FONT></TD>
\r
175 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#dump(java.io.PrintWriter, int, java.lang.String, boolean)">dump</A></B>(java.io.PrintWriter output,
177 java.lang.String title,
178 boolean justRelations)</CODE>
\r
181 Dumps this utterance in textual form.</TD>
\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
185 <CODE> void</CODE></FONT></TD>
\r
186 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#dump(java.io.PrintWriter, java.lang.String)">dump</A></B>(java.io.PrintWriter output,
187 java.lang.String title)</CODE>
\r
190 Dumps this utterance in textual form.</TD>
\r
192 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
194 <CODE> void</CODE></FONT></TD>
\r
195 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#dump(java.lang.String)">dump</A></B>(java.lang.String title)</CODE>
\r
198 Dumps this utterance in textual form.</TD>
\r
200 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
202 <CODE> void</CODE></FONT></TD>
\r
203 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#dumpRelations(java.lang.String)">dumpRelations</A></B>(java.lang.String title)</CODE>
\r
206 Dumps the utterance in textual form</TD>
\r
208 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
210 <CODE> float</CODE></FONT></TD>
\r
211 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getDuration()">getDuration</A></B>()</CODE>
\r
214 Returns the duration of this Utterance in seconds. </TD>
\r
216 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
218 <CODE> float</CODE></FONT></TD>
\r
219 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getFloat(java.lang.String)">getFloat</A></B>(java.lang.String name)</CODE>
\r
222 Convenience method that returns the named feature as a float.
225 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
227 <CODE> int</CODE></FONT></TD>
\r
228 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getInt(java.lang.String)">getInt</A></B>(java.lang.String name)</CODE>
\r
231 Convenience method that returns the named feature as a int.
234 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
235 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
236 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
237 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getItem(java.lang.String, float)">getItem</A></B>(java.lang.String relation,
238 float time)</CODE>
\r
241 Returns the Item in the given Relation associated with the given time.</TD>
\r
243 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
245 <CODE> java.lang.Object</CODE></FONT></TD>
\r
246 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getObject(java.lang.String)">getObject</A></B>(java.lang.String name)</CODE>
\r
249 Returns the named feature as an object.
252 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
253 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
254 <CODE> <A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A></CODE></FONT></TD>
\r
255 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getRelation(java.lang.String)">getRelation</A></B>(java.lang.String name)</CODE>
\r
258 Retrieves a relation from this utterance.</TD>
\r
260 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
261 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
262 <CODE> <A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></FONT></TD>
\r
263 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getSpeakable()">getSpeakable</A></B>()</CODE>
\r
266 Returns the queueitem associated with this utterance.</TD>
\r
268 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
269 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
270 <CODE> java.lang.String</CODE></FONT></TD>
\r
271 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getString(java.lang.String)">getString</A></B>(java.lang.String name)</CODE>
\r
274 Convenience method that returns the named feature as a string.
277 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
279 <CODE> <A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A></CODE></FONT></TD>
\r
280 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#getVoice()">getVoice</A></B>()</CODE>
\r
283 Retrieves the Voice associated with this Utterance.</TD>
\r
285 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
286 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
287 <CODE> boolean</CODE></FONT></TD>
\r
288 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#hasRelation(java.lang.String)">hasRelation</A></B>(java.lang.String name)</CODE>
\r
291 Determines if this utterance contains a relation with the given
294 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
295 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
296 <CODE> boolean</CODE></FONT></TD>
\r
297 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#isFirst()">isFirst</A></B>()</CODE>
\r
300 Returns true if this utterance is the first is a series of
303 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
304 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
305 <CODE> boolean</CODE></FONT></TD>
\r
306 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#isLast()">isLast</A></B>()</CODE>
\r
309 Returns true if this utterance is the last is a series of
312 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
313 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
314 <CODE> boolean</CODE></FONT></TD>
\r
315 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#isPresent(java.lang.String)">isPresent</A></B>(java.lang.String name)</CODE>
\r
318 Determines if the given feature is present. </TD>
\r
320 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
321 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
322 <CODE> void</CODE></FONT></TD>
\r
323 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#remove(java.lang.String)">remove</A></B>(java.lang.String name)</CODE>
\r
326 Removes the named feature from this set of features.</TD>
\r
328 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
329 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
330 <CODE> void</CODE></FONT></TD>
\r
331 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#setFirst(boolean)">setFirst</A></B>(boolean first)</CODE>
\r
334 Sets this utterance as the first in a series.</TD>
\r
336 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
337 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
338 <CODE> void</CODE></FONT></TD>
\r
339 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#setFloat(java.lang.String, float)">setFloat</A></B>(java.lang.String name,
340 float value)</CODE>
\r
343 Convenience method that sets the named feature as a float.</TD>
\r
345 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
346 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
347 <CODE> void</CODE></FONT></TD>
\r
348 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#setInt(java.lang.String, int)">setInt</A></B>(java.lang.String name,
349 int value)</CODE>
\r
352 Convenience method that sets the named feature as an int.</TD>
\r
354 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
355 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
356 <CODE> void</CODE></FONT></TD>
\r
357 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#setLast(boolean)">setLast</A></B>(boolean last)</CODE>
\r
360 Sets this utterance as the last in a series.</TD>
\r
362 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
363 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
364 <CODE> void</CODE></FONT></TD>
\r
365 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#setObject(java.lang.String, java.lang.Object)">setObject</A></B>(java.lang.String name,
366 java.lang.Object value)</CODE>
\r
369 Sets the named feature.</TD>
\r
371 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
372 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
373 <CODE> void</CODE></FONT></TD>
\r
374 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#setSpeakable(com.sun.speech.freetts.FreeTTSSpeakable)">setSpeakable</A></B>(<A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A> speakable)</CODE>
\r
377 Sets the speakable item for this utterance.</TD>
\r
379 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
380 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
381 <CODE> void</CODE></FONT></TD>
\r
382 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Utterance.html#setString(java.lang.String, java.lang.String)">setString</A></B>(java.lang.String name,
383 java.lang.String value)</CODE>
\r
386 Convenience method that sets the named feature as a String.</TD>
\r
389 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
390 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
391 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
392 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
394 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
395 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
401 <!-- ============ FIELD DETAIL =========== -->
\r
404 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
406 <A NAME="constructor_detail"><!-- --></A>
407 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
408 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
409 <TD COLSPAN=1><FONT SIZE="+2">
\r
410 <B>Constructor Detail</B></FONT></TD>
\r
414 <A NAME="Utterance(com.sun.speech.freetts.Voice)"><!-- --></A><H3>
\r
417 public <B>Utterance</B>(<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A> voice)</PRE>
\r
419 <DD>Creates a new, empty utterance.
\r
421 <DT><B>Parameters:</B><DD><CODE>voice</CODE> - the voice associated with the utterance</DL>
\r
424 <A NAME="Utterance(com.sun.speech.freetts.Voice, java.util.List)"><!-- --></A><H3>
\r
427 public <B>Utterance</B>(<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A> voice,
428 java.util.List tokenList)</PRE>
\r
430 <DD>Creates an utterance with the given set of tokenized text.
\r
432 <DT><B>Parameters:</B><DD><CODE>voice</CODE> - the voice associated with the utterance<DD><CODE>tokenList</CODE> - the list of tokens for this utterance</DL>
\r
434 <!-- ============ METHOD DETAIL ========== -->
\r
436 <A NAME="method_detail"><!-- --></A>
437 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
438 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
439 <TD COLSPAN=1><FONT SIZE="+2">
\r
440 <B>Method Detail</B></FONT></TD>
\r
444 <A NAME="setSpeakable(com.sun.speech.freetts.FreeTTSSpeakable)"><!-- --></A><H3>
\r
447 public void <B>setSpeakable</B>(<A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A> speakable)</PRE>
\r
449 <DD>Sets the speakable item for this utterance.
\r
455 <DT><B>Parameters:</B><DD><CODE>speakable</CODE> - the speakable item for this utterance</DL>
\r
460 <A NAME="getSpeakable()"><!-- --></A><H3>
\r
463 public <A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A> <B>getSpeakable</B>()</PRE>
\r
465 <DD>Returns the queueitem associated with this utterance.
\r
472 <DT><B>Returns:</B><DD>the queue item</DL>
\r
477 <A NAME="createRelation(java.lang.String)"><!-- --></A><H3>
\r
478 createRelation</H3>
\r
480 public <A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A> <B>createRelation</B>(java.lang.String name)</PRE>
\r
482 <DD>Creates a new relation with the given name and adds it to this
489 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the new relation
490 <DT><B>Returns:</B><DD>the newly created relation</DL>
\r
495 <A NAME="getRelation(java.lang.String)"><!-- --></A><H3>
\r
498 public <A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A> <B>getRelation</B>(java.lang.String name)</PRE>
\r
500 <DD>Retrieves a relation from this utterance.
\r
506 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the Relation
507 <DT><B>Returns:</B><DD>the relation or null if the relation is not found</DL>
\r
512 <A NAME="hasRelation(java.lang.String)"><!-- --></A><H3>
\r
515 public boolean <B>hasRelation</B>(java.lang.String name)</PRE>
\r
517 <DD>Determines if this utterance contains a relation with the given
524 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the relation of interest.</DL>
\r
529 <A NAME="getVoice()"><!-- --></A><H3>
\r
532 public <A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A> <B>getVoice</B>()</PRE>
\r
534 <DD>Retrieves the Voice associated with this Utterance.
\r
541 <DT><B>Returns:</B><DD>the voice associated with this utterance.</DL>
\r
546 <A NAME="dump(java.io.PrintWriter, int, java.lang.String, boolean)"><!-- --></A><H3>
\r
549 public void <B>dump</B>(java.io.PrintWriter output,
551 java.lang.String title,
552 boolean justRelations)</PRE>
\r
554 <DD>Dumps this utterance in textual form.
\r
560 <DT><B>Parameters:</B><DD><CODE>output</CODE> - where to send the formatted output<DD><CODE>pad</CODE> - the initial padding<DD><CODE>title</CODE> - the title to print when dumping out the utterance<DD><CODE>justRelations</CODE> - if true don't print voice features</DL>
\r
565 <A NAME="dump(java.io.PrintWriter, int, java.lang.String)"><!-- --></A><H3>
\r
568 public void <B>dump</B>(java.io.PrintWriter output,
570 java.lang.String title)</PRE>
\r
572 <DD>Dumps this utterance in textual form.
\r
575 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
578 <DT><B>Parameters:</B><DD><CODE>output</CODE> - where to send the formatted output<DD><CODE>pad</CODE> - the initial padding<DD><CODE>title</CODE> - the title to print when dumping out the utterance</DL>
\r
583 <A NAME="dump(java.io.PrintWriter, java.lang.String)"><!-- --></A><H3>
\r
586 public void <B>dump</B>(java.io.PrintWriter output,
587 java.lang.String title)</PRE>
\r
589 <DD>Dumps this utterance in textual form.
\r
595 <DT><B>Parameters:</B><DD><CODE>output</CODE> - where to send the formatted output<DD><CODE>title</CODE> - the title to print when dumping out the utterance</DL>
\r
600 <A NAME="dump(java.lang.String)"><!-- --></A><H3>
\r
603 public void <B>dump</B>(java.lang.String title)</PRE>
\r
605 <DD>Dumps this utterance in textual form.
\r
611 <DT><B>Parameters:</B><DD><CODE>title</CODE> - the title to print when dumping out the utterance</DL>
\r
616 <A NAME="dumpRelations(java.lang.String)"><!-- --></A><H3>
\r
619 public void <B>dumpRelations</B>(java.lang.String title)</PRE>
\r
621 <DD>Dumps the utterance in textual form
\r
627 <DT><B>Parameters:</B><DD><CODE>title</CODE> - the title to print when dumping out the utterance</DL>
\r
632 <A NAME="isPresent(java.lang.String)"><!-- --></A><H3>
\r
635 public boolean <B>isPresent</B>(java.lang.String name)</PRE>
\r
637 <DD>Determines if the given feature is present. If the feature is
638 not present in the utterance, the feature set of the voice is
642 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#isPresent(java.lang.String)">isPresent</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
645 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature of interest
646 <DT><B>Returns:</B><DD>true if the named feature is present</DL>
\r
651 <A NAME="remove(java.lang.String)"><!-- --></A><H3>
\r
654 public void <B>remove</B>(java.lang.String name)</PRE>
\r
656 <DD>Removes the named feature from this set of features.
\r
659 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#remove(java.lang.String)">remove</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
662 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature of interest</DL>
\r
667 <A NAME="getString(java.lang.String)"><!-- --></A><H3>
\r
670 public java.lang.String <B>getString</B>(java.lang.String name)</PRE>
\r
672 <DD>Convenience method that returns the named feature as a string.
673 If the named feature is not present in the utterance, then this
674 attempts to retrieve it from the voice.
\r
677 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#getString(java.lang.String)">getString</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
680 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature
681 <DT><B>Returns:</B><DD>the value associated with the name or null if the value
684 <DD><CODE>java.lang.ClassCastException</CODE> - if the associated value is not a
690 <A NAME="getInt(java.lang.String)"><!-- --></A><H3>
\r
693 public int <B>getInt</B>(java.lang.String name)</PRE>
\r
695 <DD>Convenience method that returns the named feature as a int.
696 If the named feature is not present in the utterance, then this
697 attempts to retrieve it from the voice.
\r
700 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#getInt(java.lang.String)">getInt</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
703 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature
704 <DT><B>Returns:</B><DD>the value associated with the name or null if the value
707 <DD><CODE>java.lang.ClassCastException</CODE> - if the associated value is not an
713 <A NAME="getFloat(java.lang.String)"><!-- --></A><H3>
\r
716 public float <B>getFloat</B>(java.lang.String name)</PRE>
\r
718 <DD>Convenience method that returns the named feature as a float.
719 If the named feature is not present in the utterance, then this
720 attempts to retrieve it from the voice.
\r
723 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#getFloat(java.lang.String)">getFloat</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
726 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature
727 <DT><B>Returns:</B><DD>the value associated with the name or null if the value
730 <DD><CODE>java.lang.ClassCastException</CODE> - if the associated value is not a
736 <A NAME="getObject(java.lang.String)"><!-- --></A><H3>
\r
739 public java.lang.Object <B>getObject</B>(java.lang.String name)</PRE>
\r
741 <DD>Returns the named feature as an object.
742 If the named feature is not present in the utterance, then this
743 attempts to retrieve it from the voice.
\r
746 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#getObject(java.lang.String)">getObject</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
749 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature
750 <DT><B>Returns:</B><DD>the value associated with the name or null if the value
756 <A NAME="setInt(java.lang.String, int)"><!-- --></A><H3>
\r
759 public void <B>setInt</B>(java.lang.String name,
760 int value)</PRE>
\r
762 <DD>Convenience method that sets the named feature as an int.
\r
765 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#setInt(java.lang.String, int)">setInt</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
768 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature<DD><CODE>value</CODE> - the value of the feature</DL>
\r
773 <A NAME="setFloat(java.lang.String, float)"><!-- --></A><H3>
\r
776 public void <B>setFloat</B>(java.lang.String name,
777 float value)</PRE>
\r
779 <DD>Convenience method that sets the named feature as a float.
\r
782 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#setFloat(java.lang.String, float)">setFloat</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
785 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature<DD><CODE>value</CODE> - the value of the feature</DL>
\r
790 <A NAME="setString(java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
793 public void <B>setString</B>(java.lang.String name,
794 java.lang.String value)</PRE>
\r
796 <DD>Convenience method that sets the named feature as a String.
\r
799 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#setString(java.lang.String, java.lang.String)">setString</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
802 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature<DD><CODE>value</CODE> - the value of the feature</DL>
\r
807 <A NAME="setObject(java.lang.String, java.lang.Object)"><!-- --></A><H3>
\r
810 public void <B>setObject</B>(java.lang.String name,
811 java.lang.Object value)</PRE>
\r
813 <DD>Sets the named feature.
\r
816 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#setObject(java.lang.String, java.lang.Object)">setObject</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></DL>
\r
819 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature<DD><CODE>value</CODE> - the value of the feature</DL>
\r
824 <A NAME="getItem(java.lang.String, float)"><!-- --></A><H3>
\r
827 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getItem</B>(java.lang.String relation,
828 float time)</PRE>
\r
830 <DD>Returns the Item in the given Relation associated with the given time.
\r
836 <DT><B>Parameters:</B><DD><CODE>relation</CODE> - the name of the relation<DD><CODE>time</CODE> - the time
838 <DD><CODE>java.lang.IllegalStateException</CODE> - if the Segment durations
839 have not been calculated in the Utterance or if the
840 given relation is not present in the Utterance</DL>
\r
845 <A NAME="getDuration()"><!-- --></A><H3>
\r
848 public float <B>getDuration</B>()</PRE>
\r
850 <DD>Returns the duration of this Utterance in seconds. It does this
851 by looking at last Item in the following Relations, in this order:
852 Segment, Target. If none of these Relations exist, or if these
853 Relations contain no Items, an IllegalStateException will be thrown.
\r
860 <DT><B>Returns:</B><DD>the duration of this Utterance in seconds</DL>
\r
865 <A NAME="isFirst()"><!-- --></A><H3>
\r
868 public boolean <B>isFirst</B>()</PRE>
\r
870 <DD>Returns true if this utterance is the first is a series of
878 <DT><B>Returns:</B><DD>true if this is the first utterance in a series of
879 connected utterances.</DL>
\r
884 <A NAME="setFirst(boolean)"><!-- --></A><H3>
\r
887 public void <B>setFirst</B>(boolean first)</PRE>
\r
889 <DD>Sets this utterance as the first in a series.
\r
895 <DT><B>Parameters:</B><DD><CODE>first</CODE> - if true, the item is the first in a series</DL>
\r
900 <A NAME="isLast()"><!-- --></A><H3>
\r
903 public boolean <B>isLast</B>()</PRE>
\r
905 <DD>Returns true if this utterance is the last is a series of
913 <DT><B>Returns:</B><DD>true if this is the last utterance in a series of
914 connected utterances.</DL>
\r
919 <A NAME="setLast(boolean)"><!-- --></A><H3>
\r
922 public void <B>setLast</B>(boolean last)</PRE>
\r
924 <DD>Sets this utterance as the last in a series.
\r
930 <DT><B>Parameters:</B><DD><CODE>last</CODE> - if true, the item is the last in a series</DL>
\r
933 <!-- ========= END OF CLASS DATA ========= -->
\r
937 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
938 <A NAME="navbar_bottom"><!-- --></A>
939 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
940 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
942 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
943 <A NAME="navbar_bottom_firstrow"><!-- --></A>
944 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
945 <TR ALIGN="center" VALIGN="top">
\r
946 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
947 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
948 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
949 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
950 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
951 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
952 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
956 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
962 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
963 <A HREF="../../../../com/sun/speech/freetts/Token.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
964 <A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
965 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
966 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
967 <A HREF="Utterance.html" target="_top"><B>NO FRAMES</B></A>
\r
968 <SCRIPT type="text/javascript">
\r
971 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
976 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
982 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
983 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
984 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
985 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
988 <A NAME="skip-navbar_bottom"></A>
989 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob