git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/freetts/en/us/WordRelation.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:30 CET 2009 -->\r
   6 <TITLE>\r
   7 WordRelation (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.en.us.WordRelation 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="WordRelation (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/en/us/USEnglish.html" title="class in com.sun.speech.freetts.en.us"><B>PREV CLASS</B></A>&nbsp;\r
  53 &nbsp;NEXT CLASS</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="WordRelation.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;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;FIELD&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.en.us</FONT>\r
  85 <BR>\r
  86 Class WordRelation</H2>\r
  87 <PRE>\r
  88 java.lang.Object\r
  89   <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.en.us.WordRelation</B>\r
  90 </PRE>\r
  91 <HR>\r
  92 <DL>\r
  93 <DT>public class <B>WordRelation</B><DT>extends java.lang.Object</DL>\r
  94 \r
  95 <P>\r
  96 Helper class to add words and breaks into a Relation object.\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 \r
 112 <!-- ========== METHOD SUMMARY =========== -->\r
 113 \r
 114 <A NAME="method_summary"><!-- --></A>
 115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 117 <TD COLSPAN=2><FONT SIZE="+2">\r
 118 <B>Method Summary</B></FONT></TD>\r
 119 </TR>\r
 120 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 121 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 122 <CODE>&nbsp;void</CODE></FONT></TD>\r
 123 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/WordRelation.html#addBreak()">addBreak</A></B>()</CODE>\r
 124 \r
 125 <BR>\r
 126 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a break as a feature to the last item in the list.</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>&nbsp;void</CODE></FONT></TD>\r
 131 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/WordRelation.html#addWord(java.lang.String)">addWord</A></B>(java.lang.String&nbsp;word)</CODE>\r
 132 \r
 133 <BR>\r
 134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a word as an Item to this WordRelation object.</TD>\r
 135 </TR>\r
 136 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 137 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 138 <CODE>static&nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/WordRelation.html" title="class in com.sun.speech.freetts.en.us">WordRelation</A></CODE></FONT></TD>\r
 139 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/WordRelation.html#createWordRelation(com.sun.speech.freetts.Utterance, com.sun.speech.freetts.en.us.TokenToWords)">createWordRelation</A></B>(<A HREF="../../../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance,
 140                    <A HREF="../../../../../../com/sun/speech/freetts/en/us/TokenToWords.html" title="class in com.sun.speech.freetts.en.us">TokenToWords</A>&nbsp;tokenToWords)</CODE>\r
 141 \r
 142 <BR>\r
 143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a WordRelation object with the given utterance and
 144  TokenToWords.</TD>\r
 145 </TR>\r
 146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 148 <CODE>&nbsp;<A HREF="../../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
 149 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/WordRelation.html#getTail()">getTail</A></B>()</CODE>\r
 150 \r
 151 <BR>\r
 152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the last item in this WordRelation.</TD>\r
 153 </TR>\r
 154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 156 <CODE>&nbsp;void</CODE></FONT></TD>\r
 157 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/freetts/en/us/WordRelation.html#setLastWord(java.lang.String)">setLastWord</A></B>(java.lang.String&nbsp;word)</CODE>\r
 158 \r
 159 <BR>\r
 160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the last Item in this WordRelation to the given word.</TD>\r
 161 </TR>\r
 162 </TABLE>\r
 163 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 164 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 165 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 166 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
 167 </TR>\r
 168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 169 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 170 </TR>\r
 171 </TABLE>\r
 172 &nbsp;\r
 173 <P>\r
 174 \r
 175 <!-- ============ FIELD DETAIL =========== -->\r
 176 \r
 177 \r
 178 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 179 \r
 180 \r
 181 <!-- ============ METHOD DETAIL ========== -->\r
 182 \r
 183 <A NAME="method_detail"><!-- --></A>
 184 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 185 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 186 <TD COLSPAN=1><FONT SIZE="+2">\r
 187 <B>Method Detail</B></FONT></TD>\r
 188 </TR>\r
 189 </TABLE>\r
 190 \r
 191 <A NAME="createWordRelation(com.sun.speech.freetts.Utterance, com.sun.speech.freetts.en.us.TokenToWords)"><!-- --></A><H3>\r
 192 createWordRelation</H3>\r
 193 <PRE>\r
 194 public static <A HREF="../../../../../../com/sun/speech/freetts/en/us/WordRelation.html" title="class in com.sun.speech.freetts.en.us">WordRelation</A> <B>createWordRelation</B>(<A HREF="../../../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance,
 195                                               <A HREF="../../../../../../com/sun/speech/freetts/en/us/TokenToWords.html" title="class in com.sun.speech.freetts.en.us">TokenToWords</A>&nbsp;tokenToWords)</PRE>\r
 196 <DL>\r
 197 <DD>Creates a WordRelation object with the given utterance and
 198  TokenToWords.\r
 199 <P>\r
 200 <DD><DL>\r
 201 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the Utterance from which to create a Relation<DD><CODE>tokenToWords</CODE> - the TokenToWords object to use
 202 <DT><B>Returns:</B><DD>a WordRelation object</DL>\r
 203 </DD>\r
 204 </DL>\r
 205 <HR>\r
 206 \r
 207 <A NAME="addBreak()"><!-- --></A><H3>\r
 208 addBreak</H3>\r
 209 <PRE>\r
 210 public void <B>addBreak</B>()</PRE>\r
 211 <DL>\r
 212 <DD>Adds a break as a feature to the last item in the list.\r
 213 <P>\r
 214 <DD><DL>\r
 215 </DL>\r
 216 </DD>\r
 217 </DL>\r
 218 <HR>\r
 219 \r
 220 <A NAME="addWord(java.lang.String)"><!-- --></A><H3>\r
 221 addWord</H3>\r
 222 <PRE>\r
 223 public void <B>addWord</B>(java.lang.String&nbsp;word)</PRE>\r
 224 <DL>\r
 225 <DD>Adds a word as an Item to this WordRelation object.\r
 226 <P>\r
 227 <DD><DL>\r
 228 <DT><B>Parameters:</B><DD><CODE>word</CODE> - the word to add</DL>\r
 229 </DD>\r
 230 </DL>\r
 231 <HR>\r
 232 \r
 233 <A NAME="setLastWord(java.lang.String)"><!-- --></A><H3>\r
 234 setLastWord</H3>\r
 235 <PRE>\r
 236 public void <B>setLastWord</B>(java.lang.String&nbsp;word)</PRE>\r
 237 <DL>\r
 238 <DD>Sets the last Item in this WordRelation to the given word.\r
 239 <P>\r
 240 <DD><DL>\r
 241 <DT><B>Parameters:</B><DD><CODE>word</CODE> - the word to set</DL>\r
 242 </DD>\r
 243 </DL>\r
 244 <HR>\r
 245 \r
 246 <A NAME="getTail()"><!-- --></A><H3>\r
 247 getTail</H3>\r
 248 <PRE>\r
 249 public <A HREF="../../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getTail</B>()</PRE>\r
 250 <DL>\r
 251 <DD>Returns the last item in this WordRelation.\r
 252 <P>\r
 253 <DD><DL>\r
 254
 255 <DT><B>Returns:</B><DD>the last item</DL>\r
 256 </DD>\r
 257 </DL>\r
 258 <!-- ========= END OF CLASS DATA ========= -->\r
 259 <HR>\r
 260 \r
 261
 262 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 263 <A NAME="navbar_bottom"><!-- --></A>
 264 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 265 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 266 <TR>\r
 267 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 268 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 269 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 270   <TR ALIGN="center" VALIGN="top">\r
 271   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 272   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 273   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 274   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 275   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 276   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 277   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 278   </TR>\r
 279 </TABLE>\r
 280 </TD>\r
 281 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 282 </EM>\r
 283 </TD>\r
 284 </TR>\r
 285 \r
 286 <TR>\r
 287 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 288 &nbsp;<A HREF="../../../../../../com/sun/speech/freetts/en/us/USEnglish.html" title="class in com.sun.speech.freetts.en.us"><B>PREV CLASS</B></A>&nbsp;\r
 289 &nbsp;NEXT CLASS</FONT></TD>\r
 290 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 291   <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 292 &nbsp;<A HREF="WordRelation.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 293 &nbsp;<SCRIPT type="text/javascript">\r
 294   <!--\r
 295   if(window==top) {\r
 296     document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 297   }\r
 298   //-->\r
 299 </SCRIPT>\r
 300 <NOSCRIPT>\r
 301   <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 302 </NOSCRIPT>
 303 \r
 304 </FONT></TD>\r
 305 </TR>\r
 306 <TR>\r
 307 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 308   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 309 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 310 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 311 </TR>\r
 312 </TABLE>\r
 313 <A NAME="skip-navbar_bottom"></A>
 314 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 315 \r
 316 <HR>\r
 317 \r
 318 </BODY>\r
 319 </HTML>\r