git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/freetts/ItemContents.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 ItemContents (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.ItemContents 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="ItemContents (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/Item.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
  53 &nbsp;<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>  &nbsp;\r
  56 &nbsp;<A HREF="ItemContents.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;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  75 </TR>\r
  76 </TABLE>\r
  77 <A NAME="skip-navbar_top"></A>
  78 <!-- ========= END OF TOP NAVBAR ========= -->\r
  79 \r
  80 <HR>\r
  81 <!-- ======== START OF CLASS DATA ======== -->\r
  82 <H2>\r
  83 <FONT SIZE="-1">\r
  84 com.sun.speech.freetts</FONT>\r
  85 <BR>\r
  86 Class ItemContents</H2>\r
  87 <PRE>\r
  88 java.lang.Object\r
  89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.ItemContents</B>\r
  90 </PRE>\r
  91 <HR>\r
  92 <DL>\r
  93 <DT>public class <B>ItemContents</B><DT>extends java.lang.Object</DL>\r
  94 \r
  95 <P>\r
  96 Contains the information that is shared between multiple items.\r
  97 <P>\r
  98 \r
  99 <P>\r
 100 <HR>\r
 101 \r
 102 <P>\r
 103 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 104 \r
 105 \r
 106 <!-- =========== FIELD SUMMARY =========== -->\r
 107 \r
 108 \r
 109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 110 \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
 116 </TR>\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
 119 \r
 120 <BR>\r
 121 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class Constructor.</TD>\r
 122 </TR>\r
 123 </TABLE>\r
 124 &nbsp;\r
 125 <!-- ========== METHOD SUMMARY =========== -->\r
 126 \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
 132 </TR>\r
 133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 135 <CODE>&nbsp;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&nbsp;relationName,
 137                 <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;item)</CODE>\r
 138 \r
 139 <BR>\r
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the given item to the set of relations. </TD>\r
 141 </TR>\r
 142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 144 <CODE>&nbsp;<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
 146 \r
 147 <BR>\r
 148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the feature set for this item contents.</TD>\r
 149 </TR>\r
 150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 152 <CODE>&nbsp;<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&nbsp;relationName)</CODE>\r
 154 \r
 155 <BR>\r
 156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given the name of a relation, returns the item the shares the
 157  same ItemContents.</TD>\r
 158 </TR>\r
 159 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 161 <CODE>&nbsp;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&nbsp;relationName)</CODE>\r
 163 \r
 164 <BR>\r
 165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the relation/item mapping from this ItemContents.</TD>\r
 166 </TR>\r
 167 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 169 <CODE>&nbsp;void</CODE></FONT></TD>\r
 170 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/ItemContents.html#showRelations()">showRelations</A></B>()</CODE>\r
 171 \r
 172 <BR>\r
 173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 174 </TR>\r
 175 </TABLE>\r
 176 &nbsp;<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
 180 </TR>\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
 183 </TR>\r
 184 </TABLE>\r
 185 &nbsp;\r
 186 <P>\r
 187 \r
 188 <!-- ============ FIELD DETAIL =========== -->\r
 189 \r
 190 \r
 191 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 192 \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
 198 </TR>\r
 199 </TABLE>\r
 200 \r
 201 <A NAME="ItemContents()"><!-- --></A><H3>\r
 202 ItemContents</H3>\r
 203 <PRE>\r
 204 public <B>ItemContents</B>()</PRE>\r
 205 <DL>\r
 206 <DD>Class Constructor.\r
 207 <P>\r
 208 </DL>\r
 209 \r
 210 <!-- ============ METHOD DETAIL ========== -->\r
 211 \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
 217 </TR>\r
 218 </TABLE>\r
 219 \r
 220 <A NAME="addItemRelation(java.lang.String, com.sun.speech.freetts.Item)"><!-- --></A><H3>\r
 221 addItemRelation</H3>\r
 222 <PRE>\r
 223 public void <B>addItemRelation</B>(java.lang.String&nbsp;relationName,
 224                             <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;item)</PRE>\r
 225 <DL>\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
 230 <P>\r
 231 <DD><DL>\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
 233 </DD>\r
 234 </DL>\r
 235 <HR>\r
 236 \r
 237 <A NAME="removeItemRelation(java.lang.String)"><!-- --></A><H3>\r
 238 removeItemRelation</H3>\r
 239 <PRE>\r
 240 public void <B>removeItemRelation</B>(java.lang.String&nbsp;relationName)</PRE>\r
 241 <DL>\r
 242 <DD>Removes the relation/item mapping from this ItemContents.\r
 243 <P>\r
 244 <DD><DL>\r
 245 <DT><B>Parameters:</B><DD><CODE>relationName</CODE> - the name of the relation/item to remove</DL>\r
 246 </DD>\r
 247 </DL>\r
 248 <HR>\r
 249 \r
 250 <A NAME="showRelations()"><!-- --></A><H3>\r
 251 showRelations</H3>\r
 252 <PRE>\r
 253 public void <B>showRelations</B>()</PRE>\r
 254 <DL>\r
 255 <DD><DL>\r
 256 </DL>\r
 257 </DD>\r
 258 </DL>\r
 259 <HR>\r
 260 \r
 261 <A NAME="getItemRelation(java.lang.String)"><!-- --></A><H3>\r
 262 getItemRelation</H3>\r
 263 <PRE>\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&nbsp;relationName)</PRE>\r
 265 <DL>\r
 266 <DD>Given the name of a relation, returns the item the shares the
 267  same ItemContents.\r
 268 <P>\r
 269 <DD><DL>\r
 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
 273 </DD>\r
 274 </DL>\r
 275 <HR>\r
 276 \r
 277 <A NAME="getFeatures()"><!-- --></A><H3>\r
 278 getFeatures</H3>\r
 279 <PRE>\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
 281 <DL>\r
 282 <DD>Returns the feature set for this item contents.\r
 283 <P>\r
 284 <DD><DL>\r
 285
 286 <DT><B>Returns:</B><DD>the FeatureSet for this contents</DL>\r
 287 </DD>\r
 288 </DL>\r
 289 <!-- ========= END OF CLASS DATA ========= -->\r
 290 <HR>\r
 291 \r
 292
 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
 297 <TR>\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>&nbsp;</TD>\r
 303   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 304   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 305   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 306   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 307   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 308   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 309   </TR>\r
 310 </TABLE>\r
 311 </TD>\r
 312 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 313 </EM>\r
 314 </TD>\r
 315 </TR>\r
 316 \r
 317 <TR>\r
 318 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 319 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
 320 &nbsp;<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>  &nbsp;\r
 323 &nbsp;<A HREF="ItemContents.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 324 &nbsp;<SCRIPT type="text/javascript">\r
 325   <!--\r
 326   if(window==top) {\r
 327     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 328   }\r
 329   //-->\r
 330 </SCRIPT>\r
 331 <NOSCRIPT>\r
 332   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 333 </NOSCRIPT>
 334 \r
 335 </FONT></TD>\r
 336 </TR>\r
 337 <TR>\r
 338 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 339   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 340 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 341 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 342 </TR>\r
 343 </TABLE>\r
 344 <A NAME="skip-navbar_bottom"></A>
 345 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 346 \r
 347 <HR>\r
 348 \r
 349 </BODY>\r
 350 </HTML>\r