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 ItemContents (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.ItemContents 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="ItemContents (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/Item.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/OutputQueue.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="ItemContents.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 ItemContents</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.ItemContents</B>
\r
93 <DT>public class <B>ItemContents</B><DT>extends java.lang.Object</DL>
\r
96 Contains the information that is shared between multiple items.
\r
103 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
106 <!-- =========== FIELD SUMMARY =========== -->
\r
109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
111 <A NAME="constructor_summary"><!-- --></A>
112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
114 <TD COLSPAN=2><FONT SIZE="+2">
\r
115 <B>Constructor Summary</B></FONT></TD>
\r
117 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
118 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/ItemContents.html#ItemContents()">ItemContents</A></B>()</CODE>
\r
121 Class Constructor.</TD>
\r
125 <!-- ========== METHOD SUMMARY =========== -->
\r
127 <A NAME="method_summary"><!-- --></A>
128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
130 <TD COLSPAN=2><FONT SIZE="+2">
\r
131 <B>Method Summary</B></FONT></TD>
\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
135 <CODE> void</CODE></FONT></TD>
\r
136 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/ItemContents.html#addItemRelation(java.lang.String, com.sun.speech.freetts.Item)">addItemRelation</A></B>(java.lang.String relationName,
137 <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> item)</CODE>
\r
140 Adds the given item to the set of relations. </TD>
\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
144 <CODE> <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></FONT></TD>
\r
145 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/ItemContents.html#getFeatures()">getFeatures</A></B>()</CODE>
\r
148 Returns the feature set for this item contents.</TD>
\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
152 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
153 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/ItemContents.html#getItemRelation(java.lang.String)">getItemRelation</A></B>(java.lang.String relationName)</CODE>
\r
156 Given the name of a relation, returns the item the shares the
157 same ItemContents.</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE> void</CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/ItemContents.html#removeItemRelation(java.lang.String)">removeItemRelation</A></B>(java.lang.String relationName)</CODE>
\r
165 Removes the relation/item mapping from this ItemContents.</TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
169 <CODE> void</CODE></FONT></TD>
\r
170 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/ItemContents.html#showRelations()">showRelations</A></B>()</CODE>
\r
173 </TD>
\r
176 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
177 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
178 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
179 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
181 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
182 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
188 <!-- ============ FIELD DETAIL =========== -->
\r
191 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
193 <A NAME="constructor_detail"><!-- --></A>
194 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
195 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
196 <TD COLSPAN=1><FONT SIZE="+2">
\r
197 <B>Constructor Detail</B></FONT></TD>
\r
201 <A NAME="ItemContents()"><!-- --></A><H3>
\r
204 public <B>ItemContents</B>()</PRE>
\r
206 <DD>Class Constructor.
\r
210 <!-- ============ METHOD DETAIL ========== -->
\r
212 <A NAME="method_detail"><!-- --></A>
213 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
214 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
215 <TD COLSPAN=1><FONT SIZE="+2">
\r
216 <B>Method Detail</B></FONT></TD>
\r
220 <A NAME="addItemRelation(java.lang.String, com.sun.speech.freetts.Item)"><!-- --></A><H3>
\r
221 addItemRelation</H3>
\r
223 public void <B>addItemRelation</B>(java.lang.String relationName,
224 <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> item)</PRE>
\r
226 <DD>Adds the given item to the set of relations. Whenever an item
227 is added to a relation, it should add the name and the Item reference
228 to this set of name/item mappings. This allows an item to find
229 out the set of all relations that it is contained in.
\r
232 <DT><B>Parameters:</B><DD><CODE>relationName</CODE> - the name of the relation<DD><CODE>item</CODE> - the item reference in the relation</DL>
\r
237 <A NAME="removeItemRelation(java.lang.String)"><!-- --></A><H3>
\r
238 removeItemRelation</H3>
\r
240 public void <B>removeItemRelation</B>(java.lang.String relationName)</PRE>
\r
242 <DD>Removes the relation/item mapping from this ItemContents.
\r
245 <DT><B>Parameters:</B><DD><CODE>relationName</CODE> - the name of the relation/item to remove</DL>
\r
250 <A NAME="showRelations()"><!-- --></A><H3>
\r
253 public void <B>showRelations</B>()</PRE>
\r
261 <A NAME="getItemRelation(java.lang.String)"><!-- --></A><H3>
\r
262 getItemRelation</H3>
\r
264 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getItemRelation</B>(java.lang.String relationName)</PRE>
\r
266 <DD>Given the name of a relation, returns the item the shares the
270 <DT><B>Parameters:</B><DD><CODE>relationName</CODE> - the name of the relation of interest
271 <DT><B>Returns:</B><DD>the item associated with this ItemContents in the named
272 relation, or null if it does not exist</DL>
\r
277 <A NAME="getFeatures()"><!-- --></A><H3>
\r
280 public <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A> <B>getFeatures</B>()</PRE>
\r
282 <DD>Returns the feature set for this item contents.
\r
286 <DT><B>Returns:</B><DD>the FeatureSet for this contents</DL>
\r
289 <!-- ========= END OF CLASS DATA ========= -->
\r
293 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
294 <A NAME="navbar_bottom"><!-- --></A>
295 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
296 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
298 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
299 <A NAME="navbar_bottom_firstrow"><!-- --></A>
300 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
301 <TR ALIGN="center" VALIGN="top">
\r
302 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
303 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
304 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
305 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
306 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
307 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
308 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
312 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
318 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
319 <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
320 <A HREF="../../../../com/sun/speech/freetts/OutputQueue.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
321 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
322 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
323 <A HREF="ItemContents.html" target="_top"><B>NO FRAMES</B></A>
\r
324 <SCRIPT type="text/javascript">
\r
327 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
332 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
338 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
339 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
340 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
341 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
344 <A NAME="skip-navbar_bottom"></A>
345 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r