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
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Item 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="Item (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/InputMode.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/ItemContents.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="Item.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
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.Item</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></DD>
\r
96 <DT>public class <B>Item</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
99 Represents a node in a Relation. Items can have shared contents but
100 each item has its own set of Daughters. The shared contents of an
101 item (represented by ItemContents) includes the feature set for the
102 item and the set of all relations that this item is contained in.
103 An item can be contained in a number of relations and as daughters
104 to other items. This class is used to keep track of all of these
105 relationships. There may be many instances of item that reference
106 the same shared ItemContents.
\r
113 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
116 <!-- =========== FIELD SUMMARY =========== -->
\r
119 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
121 <A NAME="constructor_summary"><!-- --></A>
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
124 <TD COLSPAN=2><FONT SIZE="+2">
\r
125 <B>Constructor Summary</B></FONT></TD>
\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
128 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#Item(com.sun.speech.freetts.Relation, com.sun.speech.freetts.ItemContents)">Item</A></B>(<A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A> relation,
129 <A HREF="../../../../com/sun/speech/freetts/ItemContents.html" title="class in com.sun.speech.freetts">ItemContents</A> sharedContents)</CODE>
\r
132 Creates an item. </TD>
\r
136 <!-- ========== METHOD SUMMARY =========== -->
\r
138 <A NAME="method_summary"><!-- --></A>
139 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
140 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
141 <TD COLSPAN=2><FONT SIZE="+2">
\r
142 <B>Method Summary</B></FONT></TD>
\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
146 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
147 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#addDaughter(com.sun.speech.freetts.Item)">addDaughter</A></B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> item)</CODE>
\r
150 Adds the given item as a daughter to this item.</TD>
\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
154 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
155 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.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> originalItem)</CODE>
\r
158 Appends an item in this list after this item.</TD>
\r
160 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
162 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
163 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#createDaughter()">createDaughter</A></B>()</CODE>
\r
166 Creates a new Item, adds it as a daughter to this item
167 and returns the new item.</TD>
\r
169 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
171 <CODE> void</CODE></FONT></TD>
\r
172 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></B>(java.io.PrintWriter out,
174 java.lang.String title)</CODE>
\r
177 Dumps out this item to the given output stream.</TD>
\r
179 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
181 <CODE> boolean</CODE></FONT></TD>
\r
182 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#equalsShared(com.sun.speech.freetts.Item)">equalsShared</A></B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> otherItem)</CODE>
\r
185 Determines if the shared contents of the two items are the same.</TD>
\r
187 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
189 <CODE> java.lang.Object</CODE></FONT></TD>
\r
190 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#findFeature(java.lang.String)">findFeature</A></B>(java.lang.String pathAndFeature)</CODE>
\r
193 Finds the feature by following the given path.
196 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
198 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
199 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#findItem(java.lang.String)">findItem</A></B>(java.lang.String path)</CODE>
\r
202 Finds the item specified by the given path.
206 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
208 <CODE> <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/Item.html#getDaughter()">getDaughter</A></B>()</CODE>
\r
212 Retrieves the first daughter of this item.</TD>
\r
214 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
216 <CODE> <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></FONT></TD>
\r
217 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getFeatures()">getFeatures</A></B>()</CODE>
\r
220 Returns the feature set of this item.</TD>
\r
222 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
224 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
225 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getItemAs(java.lang.String)">getItemAs</A></B>(java.lang.String relationName)</CODE>
\r
228 Finds the item in the given relation that has the same shared
231 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
233 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
234 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getLastDaughter()">getLastDaughter</A></B>()</CODE>
\r
237 Retrieves the last daughter of this item.</TD>
\r
239 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
240 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
241 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
242 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getNext()">getNext</A></B>()</CODE>
\r
245 Gets the next item in this list.</TD>
\r
247 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
248 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
249 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
250 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getNthDaughter(int)">getNthDaughter</A></B>(int which)</CODE>
\r
253 Retrieves the Nth daughter of this item.</TD>
\r
255 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
256 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
257 <CODE> <A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A></CODE></FONT></TD>
\r
258 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getOwnerRelation()">getOwnerRelation</A></B>()</CODE>
\r
261 Retrieves the owning Relation.</TD>
\r
263 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
265 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
266 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getParent()">getParent</A></B>()</CODE>
\r
269 Returns the parent of this item.</TD>
\r
271 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
273 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
274 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getPrevious()">getPrevious</A></B>()</CODE>
\r
277 Gets the previous item in this list.</TD>
\r
279 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
280 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
281 <CODE> <A HREF="../../../../com/sun/speech/freetts/ItemContents.html" title="class in com.sun.speech.freetts">ItemContents</A></CODE></FONT></TD>
\r
282 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getSharedContents()">getSharedContents</A></B>()</CODE>
\r
285 Retrieves the shared contents for this item.</TD>
\r
287 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
288 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
289 <CODE> <A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A></CODE></FONT></TD>
\r
290 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#getUtterance()">getUtterance</A></B>()</CODE>
\r
293 Returns the utterance associated with this item.</TD>
\r
295 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
296 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
297 <CODE> boolean</CODE></FONT></TD>
\r
298 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#hasDaughters()">hasDaughters</A></B>()</CODE>
\r
301 Determines if this item has daughters.</TD>
\r
303 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
304 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
305 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
306 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#prependItem(com.sun.speech.freetts.Item)">prependItem</A></B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> originalItem)</CODE>
\r
309 Prepends an item in this list before this item.</TD>
\r
311 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
312 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
313 <CODE> java.lang.String</CODE></FONT></TD>
\r
314 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Item.html#toString()">toString</A></B>()</CODE>
\r
317 </TD>
\r
320 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
321 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
322 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
323 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
325 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
326 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
332 <!-- ============ FIELD DETAIL =========== -->
\r
335 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
337 <A NAME="constructor_detail"><!-- --></A>
338 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
339 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
340 <TD COLSPAN=1><FONT SIZE="+2">
\r
341 <B>Constructor Detail</B></FONT></TD>
\r
345 <A NAME="Item(com.sun.speech.freetts.Relation, com.sun.speech.freetts.ItemContents)"><!-- --></A><H3>
\r
348 public <B>Item</B>(<A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A> relation,
349 <A HREF="../../../../com/sun/speech/freetts/ItemContents.html" title="class in com.sun.speech.freetts">ItemContents</A> sharedContents)</PRE>
\r
351 <DD>Creates an item. The item is coupled to a particular
352 Relation. If shared contents is null a new sharedContents is
355 <DT><B>Parameters:</B><DD><CODE>relation</CODE> - the relation that owns this item<DD><CODE>sharedContents</CODE> - the contents that is shared with others.
356 If null, a new sharedContents is created.</DL>
\r
358 <!-- ============ METHOD DETAIL ========== -->
\r
360 <A NAME="method_detail"><!-- --></A>
361 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
362 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
363 <TD COLSPAN=1><FONT SIZE="+2">
\r
364 <B>Method Detail</B></FONT></TD>
\r
368 <A NAME="getItemAs(java.lang.String)"><!-- --></A><H3>
\r
371 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getItemAs</B>(java.lang.String relationName)</PRE>
\r
373 <DD>Finds the item in the given relation that has the same shared
380 <DT><B>Parameters:</B><DD><CODE>relationName</CODE> - the relation of interest
381 <DT><B>Returns:</B><DD>the item as found in the given relation or null if not
387 <A NAME="getOwnerRelation()"><!-- --></A><H3>
\r
388 getOwnerRelation</H3>
\r
390 public <A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A> <B>getOwnerRelation</B>()</PRE>
\r
392 <DD>Retrieves the owning Relation.
\r
399 <DT><B>Returns:</B><DD>the relation that owns this item</DL>
\r
404 <A NAME="getSharedContents()"><!-- --></A><H3>
\r
405 getSharedContents</H3>
\r
407 public <A HREF="../../../../com/sun/speech/freetts/ItemContents.html" title="class in com.sun.speech.freetts">ItemContents</A> <B>getSharedContents</B>()</PRE>
\r
409 <DD>Retrieves the shared contents for this item.
\r
416 <DT><B>Returns:</B><DD>the shared item contents</DL>
\r
421 <A NAME="hasDaughters()"><!-- --></A><H3>
\r
424 public boolean <B>hasDaughters</B>()</PRE>
\r
426 <DD>Determines if this item has daughters.
\r
433 <DT><B>Returns:</B><DD>true if this item has daughters</DL>
\r
438 <A NAME="getDaughter()"><!-- --></A><H3>
\r
441 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getDaughter</B>()</PRE>
\r
443 <DD>Retrieves the first daughter of this item.
\r
450 <DT><B>Returns:</B><DD>the first daughter or null if none</DL>
\r
455 <A NAME="getNthDaughter(int)"><!-- --></A><H3>
\r
456 getNthDaughter</H3>
\r
458 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getNthDaughter</B>(int which)</PRE>
\r
460 <DD>Retrieves the Nth daughter of this item.
\r
466 <DT><B>Parameters:</B><DD><CODE>which</CODE> - the index of the daughter to return
467 <DT><B>Returns:</B><DD>the Nth daughter or null if none at the given index</DL>
\r
472 <A NAME="getLastDaughter()"><!-- --></A><H3>
\r
473 getLastDaughter</H3>
\r
475 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getLastDaughter</B>()</PRE>
\r
477 <DD>Retrieves the last daughter of this item.
\r
484 <DT><B>Returns:</B><DD>the last daughter or null if none at the given index</DL>
\r
489 <A NAME="addDaughter(com.sun.speech.freetts.Item)"><!-- --></A><H3>
\r
492 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>addDaughter</B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> item)</PRE>
\r
494 <DD>Adds the given item as a daughter to this item.
\r
500 <DT><B>Parameters:</B><DD><CODE>item</CODE> - the new daughter</DL>
\r
505 <A NAME="createDaughter()"><!-- --></A><H3>
\r
506 createDaughter</H3>
\r
508 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>createDaughter</B>()</PRE>
\r
510 <DD>Creates a new Item, adds it as a daughter to this item
511 and returns the new item.
\r
518 <DT><B>Returns:</B><DD>the newly created item that was added as a daughter</DL>
\r
523 <A NAME="getParent()"><!-- --></A><H3>
\r
526 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getParent</B>()</PRE>
\r
528 <DD>Returns the parent of this item.
\r
535 <DT><B>Returns:</B><DD>the parent of this item</DL>
\r
540 <A NAME="getUtterance()"><!-- --></A><H3>
\r
543 public <A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> <B>getUtterance</B>()</PRE>
\r
545 <DD>Returns the utterance associated with this item.
\r
552 <DT><B>Returns:</B><DD>the utterance that contains this item</DL>
\r
557 <A NAME="getFeatures()"><!-- --></A><H3>
\r
560 public <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A> <B>getFeatures</B>()</PRE>
\r
562 <DD>Returns the feature set of this item.
\r
569 <DT><B>Returns:</B><DD>the feature set of this item</DL>
\r
574 <A NAME="dump(java.io.PrintWriter, int, java.lang.String)"><!-- --></A><H3>
\r
577 public void <B>dump</B>(java.io.PrintWriter out,
579 java.lang.String title)</PRE>
\r
581 <DD>Dumps out this item to the given output stream.
\r
584 <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
587 <DT><B>Parameters:</B><DD><CODE>out</CODE> - where to send the output<DD><CODE>pad</CODE> - the leading whitspace<DD><CODE>title</CODE> - the title for the dump</DL>
\r
592 <A NAME="findFeature(java.lang.String)"><!-- --></A><H3>
\r
595 public java.lang.Object <B>findFeature</B>(java.lang.String pathAndFeature)</PRE>
\r
597 <DD>Finds the feature by following the given path.
599 ":" or "." separated strings with the following interpretations:
602 <li> p - previous item
603 <li> parent - the parent
604 <li> daughter - the daughter
605 <li> daughter1 - same as daughter
606 <li> daughtern - the last daughter
607 <li> R:relname - the item as found in the given relation 'relname'
609 The last element of the path will be interpreted as a
610 voice/language specific feature function (if present) or an
611 item feature name. If the feature function exists it will be
612 called with the item specified by the path, otherwise, a
613 feature will be retrieved with the given name. If neither exist
614 than a String "0" is returned.
\r
620 <DT><B>Parameters:</B><DD><CODE>pathAndFeature</CODE> - the path to follow</DL>
\r
625 <A NAME="findItem(java.lang.String)"><!-- --></A><H3>
\r
628 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>findItem</B>(java.lang.String path)</PRE>
\r
630 <DD>Finds the item specified by the given path.
632 Path is a string of ":" or
633 "." separated strings with the following interpretations:
636 <li> p - previous item
637 <li> parent - the parent
638 <li> daughter - the daughter
639 <li> daughter1 - same as daughter
640 <li> daughtern - the last daughter
641 <li> R:relname - the item as found in the given relation 'relname'
643 If the given path takes us outside of the bounds of the item
644 graph, then list access exceptions will be thrown.
\r
650 <DT><B>Parameters:</B><DD><CODE>path</CODE> - the path to follow
651 <DT><B>Returns:</B><DD>the item at the given path</DL>
\r
656 <A NAME="getNext()"><!-- --></A><H3>
\r
659 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getNext</B>()</PRE>
\r
661 <DD>Gets the next item in this list.
\r
668 <DT><B>Returns:</B><DD>the next item or null</DL>
\r
673 <A NAME="getPrevious()"><!-- --></A><H3>
\r
676 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getPrevious</B>()</PRE>
\r
678 <DD>Gets the previous item in this list.
\r
685 <DT><B>Returns:</B><DD>the previous item or null</DL>
\r
690 <A NAME="appendItem(com.sun.speech.freetts.Item)"><!-- --></A><H3>
\r
693 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> originalItem)</PRE>
\r
695 <DD>Appends an item in this list after this item.
\r
701 <DT><B>Parameters:</B><DD><CODE>originalItem</CODE> - new item has shared contents with this
703 <DT><B>Returns:</B><DD>the newly appended item</DL>
\r
708 <A NAME="prependItem(com.sun.speech.freetts.Item)"><!-- --></A><H3>
\r
711 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>prependItem</B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> originalItem)</PRE>
\r
713 <DD>Prepends an item in this list before this item.
\r
719 <DT><B>Parameters:</B><DD><CODE>originalItem</CODE> - new item has shared contents with this
721 <DT><B>Returns:</B><DD>the newly appended item</DL>
\r
726 <A NAME="toString()"><!-- --></A><H3>
\r
729 public java.lang.String <B>toString</B>()</PRE>
\r
740 <A NAME="equalsShared(com.sun.speech.freetts.Item)"><!-- --></A><H3>
\r
743 public boolean <B>equalsShared</B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> otherItem)</PRE>
\r
745 <DD>Determines if the shared contents of the two items are the same.
\r
751 <DT><B>Parameters:</B><DD><CODE>otherItem</CODE> - the item to compare
752 <DT><B>Returns:</B><DD>true if the shared contents are the same</DL>
\r
755 <!-- ========= END OF CLASS DATA ========= -->
\r
759 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
760 <A NAME="navbar_bottom"><!-- --></A>
761 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
762 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
764 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
765 <A NAME="navbar_bottom_firstrow"><!-- --></A>
766 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
767 <TR ALIGN="center" VALIGN="top">
\r
768 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
769 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
770 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
771 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
772 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
773 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
774 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
778 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
784 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
785 <A HREF="../../../../com/sun/speech/freetts/InputMode.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
786 <A HREF="../../../../com/sun/speech/freetts/ItemContents.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
787 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
788 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
789 <A HREF="Item.html" target="_top"><B>NO FRAMES</B></A>
\r
790 <SCRIPT type="text/javascript">
\r
793 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
798 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
804 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
805 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
806 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
807 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
810 <A NAME="skip-navbar_bottom"></A>
811 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r