upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / Relation.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 Relation (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Relation 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="Relation (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/PhoneSetImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Segmenter.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="Relation.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;CONSTR&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;CONSTR&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 Relation</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.Relation</B>\r
90 </PRE>\r
91 <DL>\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></DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>Relation</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A></DL>\r
97 \r
98 <P>\r
99 Represents an ordered set of <code>Items</code> and their associated
100  children. A relation has a name and a list of items, and is
101  added to an <code>Utterance</code> via an <code>UtteranceProcessor</code>.\r
102 <P>\r
103 \r
104 <P>\r
105 <HR>\r
106 \r
107 <P>\r
108 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
109 \r
110 \r
111 <!-- =========== FIELD SUMMARY =========== -->\r
112 \r
113 <A NAME="field_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>Field Summary</B></FONT></TD>\r
118 </TR>\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">\r
120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
121 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
122 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#PHRASE">PHRASE</A></B></CODE>\r
123 \r
124 <BR>\r
125 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the relation that groups elements from the Word relation
126  into phrases.</TD>\r
127 </TR>\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
129 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
130 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
131 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#SEGMENT">SEGMENT</A></B></CODE>\r
132 \r
133 <BR>\r
134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the relation that contains the ordered list of the
135  smallest units of speech (typically phonemes) for the entire
136  utterance.</TD>\r
137 </TR>\r
138 <TR BGCOLOR="white" CLASS="TableRowColor">\r
139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
140 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
141 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE">SYLLABLE</A></B></CODE>\r
142 \r
143 <BR>\r
144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the relation that contains the description of the
145  syllables for the Utterance.  </TD>\r
146 </TR>\r
147 <TR BGCOLOR="white" CLASS="TableRowColor">\r
148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
149 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
150 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE_STRUCTURE">SYLLABLE_STRUCTURE</A></B></CODE>\r
151 \r
152 <BR>\r
153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the relation that contains the syllable structure
154  for the utterance.</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>static&nbsp;java.lang.String</CODE></FONT></TD>\r
159 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#TARGET">TARGET</A></B></CODE>\r
160 \r
161 <BR>\r
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the relation that maps fundamental frequency targets
163  to absolute times for wave to be generated from the utterance.</TD>\r
164 </TR>\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
167 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
168 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#TOKEN">TOKEN</A></B></CODE>\r
169 \r
170 <BR>\r
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the relation that contains tokens from the original
172  input text.  </TD>\r
173 </TR>\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
176 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
177 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#UNIT">UNIT</A></B></CODE>\r
178 \r
179 <BR>\r
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the relation that contains the ordered list of the
181  units from the unit database that will be used to create
182  the synthesized wave.</TD>\r
183 </TR>\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
186 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
187 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#WORD">WORD</A></B></CODE>\r
188 \r
189 <BR>\r
190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the relation that contains the normalized version of
191  the original input text.</TD>\r
192 </TR>\r
193 </TABLE>\r
194 &nbsp;\r
195 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
196 \r
197 \r
198 <!-- ========== METHOD SUMMARY =========== -->\r
199 \r
200 <A NAME="method_summary"><!-- --></A>
201 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
202 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
203 <TD COLSPAN=2><FONT SIZE="+2">\r
204 <B>Method Summary</B></FONT></TD>\r
205 </TR>\r
206 <TR BGCOLOR="white" CLASS="TableRowColor">\r
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
208 <CODE>&nbsp;<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
209 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#appendItem()">appendItem</A></B>()</CODE>\r
210 \r
211 <BR>\r
212 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a new item to this relation. </TD>\r
213 </TR>\r
214 <TR BGCOLOR="white" CLASS="TableRowColor">\r
215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
216 <CODE>&nbsp;<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
217 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#appendItem(com.sun.speech.freetts.Item)">appendItem</A></B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;originalItem)</CODE>\r
218 \r
219 <BR>\r
220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a new item to this relation. </TD>\r
221 </TR>\r
222 <TR BGCOLOR="white" CLASS="TableRowColor">\r
223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
224 <CODE>&nbsp;void</CODE></FONT></TD>\r
225 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></B>(java.io.PrintWriter&nbsp;pw,
226      int&nbsp;pad,
227      java.lang.String&nbsp;title)</CODE>\r
228 \r
229 <BR>\r
230 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps this relation to the print writer.</TD>\r
231 </TR>\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">\r
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
234 <CODE>&nbsp;<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
235 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#getHead()">getHead</A></B>()</CODE>\r
236 \r
237 <BR>\r
238 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the head of the item list.</TD>\r
239 </TR>\r
240 <TR BGCOLOR="white" CLASS="TableRowColor">\r
241 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
242 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
243 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#getName()">getName</A></B>()</CODE>\r
244 \r
245 <BR>\r
246 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the name of this Relation.</TD>\r
247 </TR>\r
248 <TR BGCOLOR="white" CLASS="TableRowColor">\r
249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
250 <CODE>&nbsp;<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
251 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#getTail()">getTail</A></B>()</CODE>\r
252 \r
253 <BR>\r
254 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the tail of the item list.</TD>\r
255 </TR>\r
256 <TR BGCOLOR="white" CLASS="TableRowColor">\r
257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
258 <CODE>&nbsp;<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A></CODE></FONT></TD>\r
259 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Relation.html#getUtterance()">getUtterance</A></B>()</CODE>\r
260 \r
261 <BR>\r
262 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the utterance that contains this relation.</TD>\r
263 </TR>\r
264 </TABLE>\r
265 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
266 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
267 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
268 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
269 </TR>\r
270 <TR BGCOLOR="white" CLASS="TableRowColor">\r
271 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
272 </TR>\r
273 </TABLE>\r
274 &nbsp;\r
275 <P>\r
276 \r
277 <!-- ============ FIELD DETAIL =========== -->\r
278 \r
279 <A NAME="field_detail"><!-- --></A>
280 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
281 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
282 <TD COLSPAN=1><FONT SIZE="+2">\r
283 <B>Field Detail</B></FONT></TD>\r
284 </TR>\r
285 </TABLE>\r
286 \r
287 <A NAME="TOKEN"><!-- --></A><H3>\r
288 TOKEN</H3>\r
289 <PRE>\r
290 public static final java.lang.String <B>TOKEN</B></PRE>\r
291 <DL>\r
292 <DD>Name of the relation that contains tokens from the original
293  input text.  This is the first thing to be added to the
294  utterance.\r
295 <P>\r
296 <DL>\r
297 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Relation.html#WORD"><CODE>WORD</CODE></A>, 
298 <A HREF="../../../../constant-values.html#com.sun.speech.freetts.Relation.TOKEN">Constant Field Values</A></DL>\r
299 </DL>\r
300 <HR>\r
301 \r
302 <A NAME="WORD"><!-- --></A><H3>\r
303 WORD</H3>\r
304 <PRE>\r
305 public static final java.lang.String <B>WORD</B></PRE>\r
306 <DL>\r
307 <DD>Name of the relation that contains the normalized version of
308  the original input text.\r
309 <P>\r
310 <DL>\r
311 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Relation.html#TOKEN"><CODE>TOKEN</CODE></A>, 
312 <A HREF="../../../../constant-values.html#com.sun.speech.freetts.Relation.WORD">Constant Field Values</A></DL>\r
313 </DL>\r
314 <HR>\r
315 \r
316 <A NAME="PHRASE"><!-- --></A><H3>\r
317 PHRASE</H3>\r
318 <PRE>\r
319 public static final java.lang.String <B>PHRASE</B></PRE>\r
320 <DL>\r
321 <DD>Name of the relation that groups elements from the Word relation
322  into phrases.\r
323 <P>\r
324 <DL>\r
325 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Relation.PHRASE">Constant Field Values</A></DL>\r
326 </DL>\r
327 <HR>\r
328 \r
329 <A NAME="SEGMENT"><!-- --></A><H3>\r
330 SEGMENT</H3>\r
331 <PRE>\r
332 public static final java.lang.String <B>SEGMENT</B></PRE>\r
333 <DL>\r
334 <DD>Name of the relation that contains the ordered list of the
335  smallest units of speech (typically phonemes) for the entire
336  utterance.\r
337 <P>\r
338 <DL>\r
339 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE"><CODE>SYLLABLE</CODE></A>, 
340 <A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE_STRUCTURE"><CODE>SYLLABLE_STRUCTURE</CODE></A>, 
341 <A HREF="../../../../com/sun/speech/freetts/Segmenter.html" title="class in com.sun.speech.freetts"><CODE>Segmenter</CODE></A>, 
342 <A HREF="../../../../constant-values.html#com.sun.speech.freetts.Relation.SEGMENT">Constant Field Values</A></DL>\r
343 </DL>\r
344 <HR>\r
345 \r
346 <A NAME="SYLLABLE"><!-- --></A><H3>\r
347 SYLLABLE</H3>\r
348 <PRE>\r
349 public static final java.lang.String <B>SYLLABLE</B></PRE>\r
350 <DL>\r
351 <DD>Name of the relation that contains the description of the
352  syllables for the Utterance.  This is typically added to the
353  utterance at the same time as the <code>Segment</code> and
354  <code>SylStructure</code> relations.\r
355 <P>\r
356 <DL>\r
357 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Relation.html#SEGMENT"><CODE>SEGMENT</CODE></A>, 
358 <A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE_STRUCTURE"><CODE>SYLLABLE_STRUCTURE</CODE></A>, 
359 <A HREF="../../../../com/sun/speech/freetts/Segmenter.html" title="class in com.sun.speech.freetts"><CODE>Segmenter</CODE></A>, 
360 <A HREF="../../../../constant-values.html#com.sun.speech.freetts.Relation.SYLLABLE">Constant Field Values</A></DL>\r
361 </DL>\r
362 <HR>\r
363 \r
364 <A NAME="SYLLABLE_STRUCTURE"><!-- --></A><H3>\r
365 SYLLABLE_STRUCTURE</H3>\r
366 <PRE>\r
367 public static final java.lang.String <B>SYLLABLE_STRUCTURE</B></PRE>\r
368 <DL>\r
369 <DD>Name of the relation that contains the syllable structure
370  for the utterance.\r
371 <P>\r
372 <DL>\r
373 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Relation.html#SEGMENT"><CODE>SEGMENT</CODE></A>, 
374 <A HREF="../../../../com/sun/speech/freetts/Relation.html#SYLLABLE"><CODE>SYLLABLE</CODE></A>, 
375 <A HREF="../../../../com/sun/speech/freetts/Segmenter.html" title="class in com.sun.speech.freetts"><CODE>Segmenter</CODE></A>, 
376 <A HREF="../../../../constant-values.html#com.sun.speech.freetts.Relation.SYLLABLE_STRUCTURE">Constant Field Values</A></DL>\r
377 </DL>\r
378 <HR>\r
379 \r
380 <A NAME="TARGET"><!-- --></A><H3>\r
381 TARGET</H3>\r
382 <PRE>\r
383 public static final java.lang.String <B>TARGET</B></PRE>\r
384 <DL>\r
385 <DD>Name of the relation that maps fundamental frequency targets
386  to absolute times for wave to be generated from the utterance.\r
387 <P>\r
388 <DL>\r
389 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Relation.TARGET">Constant Field Values</A></DL>\r
390 </DL>\r
391 <HR>\r
392 \r
393 <A NAME="UNIT"><!-- --></A><H3>\r
394 UNIT</H3>\r
395 <PRE>\r
396 public static final java.lang.String <B>UNIT</B></PRE>\r
397 <DL>\r
398 <DD>Name of the relation that contains the ordered list of the
399  units from the unit database that will be used to create
400  the synthesized wave.\r
401 <P>\r
402 <DL>\r
403 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Relation.UNIT">Constant Field Values</A></DL>\r
404 </DL>\r
405 \r
406 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
407 \r
408 \r
409 <!-- ============ METHOD DETAIL ========== -->\r
410 \r
411 <A NAME="method_detail"><!-- --></A>
412 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
413 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
414 <TD COLSPAN=1><FONT SIZE="+2">\r
415 <B>Method Detail</B></FONT></TD>\r
416 </TR>\r
417 </TABLE>\r
418 \r
419 <A NAME="getName()"><!-- --></A><H3>\r
420 getName</H3>\r
421 <PRE>\r
422 public java.lang.String <B>getName</B>()</PRE>\r
423 <DL>\r
424 <DD>Retrieves the name of this Relation.\r
425 <P>\r
426 <DD><DL>\r
427 </DL>\r
428 </DD>\r
429 <DD><DL>\r
430
431 <DT><B>Returns:</B><DD>the name of this Relation</DL>\r
432 </DD>\r
433 </DL>\r
434 <HR>\r
435 \r
436 <A NAME="getHead()"><!-- --></A><H3>\r
437 getHead</H3>\r
438 <PRE>\r
439 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getHead</B>()</PRE>\r
440 <DL>\r
441 <DD>Gets the head of the item list.\r
442 <P>\r
443 <DD><DL>\r
444 </DL>\r
445 </DD>\r
446 <DD><DL>\r
447
448 <DT><B>Returns:</B><DD>the head item</DL>\r
449 </DD>\r
450 </DL>\r
451 <HR>\r
452 \r
453 <A NAME="getTail()"><!-- --></A><H3>\r
454 getTail</H3>\r
455 <PRE>\r
456 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getTail</B>()</PRE>\r
457 <DL>\r
458 <DD>Gets the tail of the item list.\r
459 <P>\r
460 <DD><DL>\r
461 </DL>\r
462 </DD>\r
463 <DD><DL>\r
464
465 <DT><B>Returns:</B><DD>the tail item</DL>\r
466 </DD>\r
467 </DL>\r
468 <HR>\r
469 \r
470 <A NAME="appendItem()"><!-- --></A><H3>\r
471 appendItem</H3>\r
472 <PRE>\r
473 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>appendItem</B>()</PRE>\r
474 <DL>\r
475 <DD>Adds a new item to this relation. The item added does not share 
476  its contents with any other item.\r
477 <P>\r
478 <DD><DL>\r
479 </DL>\r
480 </DD>\r
481 <DD><DL>\r
482
483 <DT><B>Returns:</B><DD>the newly added item</DL>\r
484 </DD>\r
485 </DL>\r
486 <HR>\r
487 \r
488 <A NAME="appendItem(com.sun.speech.freetts.Item)"><!-- --></A><H3>\r
489 appendItem</H3>\r
490 <PRE>\r
491 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>appendItem</B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;originalItem)</PRE>\r
492 <DL>\r
493 <DD>Adds a new item to this relation. The item added shares its
494  contents with the original item.\r
495 <P>\r
496 <DD><DL>\r
497 </DL>\r
498 </DD>\r
499 <DD><DL>\r
500 <DT><B>Parameters:</B><DD><CODE>originalItem</CODE> - the ItemContents that will be
501  shared by the new item
502 <DT><B>Returns:</B><DD>the newly added item</DL>\r
503 </DD>\r
504 </DL>\r
505 <HR>\r
506 \r
507 <A NAME="getUtterance()"><!-- --></A><H3>\r
508 getUtterance</H3>\r
509 <PRE>\r
510 public <A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> <B>getUtterance</B>()</PRE>\r
511 <DL>\r
512 <DD>Returns the utterance that contains this relation.\r
513 <P>\r
514 <DD><DL>\r
515 </DL>\r
516 </DD>\r
517 <DD><DL>\r
518
519 <DT><B>Returns:</B><DD>the utterance that contains this relation</DL>\r
520 </DD>\r
521 </DL>\r
522 <HR>\r
523 \r
524 <A NAME="dump(java.io.PrintWriter, int, java.lang.String)"><!-- --></A><H3>\r
525 dump</H3>\r
526 <PRE>\r
527 public void <B>dump</B>(java.io.PrintWriter&nbsp;pw,
528                  int&nbsp;pad,
529                  java.lang.String&nbsp;title)</PRE>\r
530 <DL>\r
531 <DD>Dumps this relation to the print writer.\r
532 <P>\r
533 <DD><DL>\r
534 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/Dumpable.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A></CODE></DL>\r
535 </DD>\r
536 <DD><DL>\r
537 <DT><B>Parameters:</B><DD><CODE>pw</CODE> - the output stream<DD><CODE>pad</CODE> - the padding<DD><CODE>title</CODE> - the title for the dump</DL>\r
538 </DD>\r
539 </DL>\r
540 <!-- ========= END OF CLASS DATA ========= -->\r
541 <HR>\r
542 \r
543
544 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
545 <A NAME="navbar_bottom"><!-- --></A>
546 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
547 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
548 <TR>\r
549 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
550 <A NAME="navbar_bottom_firstrow"><!-- --></A>
551 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
552   <TR ALIGN="center" VALIGN="top">\r
553   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
554   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
555   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
556   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
557   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
558   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
559   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
560   </TR>\r
561 </TABLE>\r
562 </TD>\r
563 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
564 </EM>\r
565 </TD>\r
566 </TR>\r
567 \r
568 <TR>\r
569 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
570 &nbsp;<A HREF="../../../../com/sun/speech/freetts/PhoneSetImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
571 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Segmenter.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
572 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
573   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
574 &nbsp;<A HREF="Relation.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
575 &nbsp;<SCRIPT type="text/javascript">\r
576   <!--\r
577   if(window==top) {\r
578     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
579   }\r
580   //-->\r
581 </SCRIPT>\r
582 <NOSCRIPT>\r
583   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
584 </NOSCRIPT>
585 \r
586 </FONT></TD>\r
587 </TR>\r
588 <TR>\r
589 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
590   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
591 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
592 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
593 </TR>\r
594 </TABLE>\r
595 <A NAME="skip-navbar_bottom"></A>
596 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
597 \r
598 <HR>\r
599 \r
600 </BODY>\r
601 </HTML>\r