git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/freetts/lexicon/LexiconImpl.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 LexiconImpl (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.lexicon.LexiconImpl 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="LexiconImpl (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/lexicon/LetterToSoundImpl.html" title="class in com.sun.speech.freetts.lexicon"><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="LexiconImpl.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;<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;<A HREF="#field_detail">FIELD</A>&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.lexicon</FONT>\r
  85 <BR>\r
  86 Class LexiconImpl</H2>\r
  87 <PRE>\r
  88 java.lang.Object\r
  89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.lexicon.LexiconImpl</B>\r
  90 </PRE>\r
  91 <DL>\r
  92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></DD>\r
  93 </DL>\r
  94 <DL>\r
  95 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/sun/speech/freetts/en/us/CMULexicon.html" title="class in com.sun.speech.freetts.en.us">CMULexicon</A></DD>\r
  96 </DL>\r
  97 <HR>\r
  98 <DL>\r
  99 <DT>public abstract class <B>LexiconImpl</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></DL>\r
 100 \r
 101 <P>\r
 102 Provides an implementation of a Lexicon.
 103
 104  <p>This implementation will either read from a straight ASCII file
 105  or a binary file.  When reading from an ASCII file, you can specify
 106  when the input line is tokenized:  load, lookup, or never.  If you
 107  specify 'load', the entire file will be parsed when it is loaded.
 108  If you specify 'lookup', the file will be loaded, but the parsing
 109  for each line will be delayed until it is referenced and the parsed
 110  form will be saved away.  If you specify 'never', the lines will
 111  parsed each time they are referenced.  The default is 'never'.  To
 112  specify the load type, set the system property as follows:
 113
 114  <pre>
 115    -Dcom.sun.speech.freetts.lexicon.LexTokenize=load
 116  </pre>
 117
 118  <p>If a binary file is used, you can also specify whether the new
 119  IO package is used.  The new IO package is new for JDK1.4, and can
 120  greatly improve the speed of loading files.  To enable new IO, use
 121  the following system property (it is enabled by default):
 122
 123  <pre>
 124    -Dcom.sun.speech.freetts.useNewIO=true
 125  </pre>
 126
 127  <p>The implementation also allows users to define their own addenda
 128  that will be used in addition to the system addenda.  If the user
 129  defines their own addenda, it values will be added to the system
 130  addenda, overriding any existing elements in the system addenda.
 131  To define a user addenda, the user needs to set the following
 132  property:
 133
 134  <pre>
 135    -Dcom.sun.speeech.freetts.lexicon.userAddenda=&lt;URLToUserAddenda>
 136  </pre>
 137
 138  Where &lt;URLToUserAddenda> is a URL pointing to an ASCII file
 139  containing addenda entries.
 140
 141  <p>[[[TODO: support multiple homographs with the same part of speech.]]]\r
 142 <P>\r
 143 \r
 144 <P>\r
 145 <HR>\r
 146 \r
 147 <P>\r
 148 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 149 \r
 150 \r
 151 <!-- =========== FIELD SUMMARY =========== -->\r
 152 \r
 153 <A NAME="field_summary"><!-- --></A>
 154 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 155 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 156 <TD COLSPAN=2><FONT SIZE="+2">\r
 157 <B>Field Summary</B></FONT></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>protected &nbsp;boolean</CODE></FONT></TD>\r
 162 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#tokenizeOnLoad">tokenizeOnLoad</A></B></CODE>\r
 163 \r
 164 <BR>\r
 165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, the phone string is replaced with the phone array in
 166  the hashmap when the phone array is loaded.  </TD>\r
 167 </TR>\r
 168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 170 <CODE>protected &nbsp;boolean</CODE></FONT></TD>\r
 171 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#tokenizeOnLookup">tokenizeOnLookup</A></B></CODE>\r
 172 \r
 173 <BR>\r
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, the phone string is replaced with the phone array in
 175  the hashmap when the phone array is first looked up.  </TD>\r
 176 </TR>\r
 177 </TABLE>\r
 178 &nbsp;\r
 179 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 180 \r
 181 <A NAME="constructor_summary"><!-- --></A>
 182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 183 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 184 <TD COLSPAN=2><FONT SIZE="+2">\r
 185 <B>Constructor Summary</B></FONT></TD>\r
 186 </TR>\r
 187 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 188 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#LexiconImpl()">LexiconImpl</A></B>()</CODE>\r
 189 \r
 190 <BR>\r
 191 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class constructor for an empty Lexicon.</TD>\r
 192 </TR>\r
 193 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 194 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#LexiconImpl(java.net.URL, java.net.URL, java.net.URL, boolean)">LexiconImpl</A></B>(java.net.URL&nbsp;compiledURL,
 195             java.net.URL&nbsp;addendaURL,
 196             java.net.URL&nbsp;letterToSoundURL,
 197             boolean&nbsp;binary)</CODE>\r
 198 \r
 199 <BR>\r
 200 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new LexiconImpl by reading from the given URLS.</TD>\r
 201 </TR>\r
 202 </TABLE>\r
 203 &nbsp;\r
 204 <!-- ========== METHOD SUMMARY =========== -->\r
 205 \r
 206 <A NAME="method_summary"><!-- --></A>
 207 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 208 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 209 <TD COLSPAN=2><FONT SIZE="+2">\r
 210 <B>Method Summary</B></FONT></TD>\r
 211 </TR>\r
 212 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 214 <CODE>&nbsp;void</CODE></FONT></TD>\r
 215 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#addAddendum(java.lang.String, java.lang.String, java.lang.String[])">addAddendum</A></B>(java.lang.String&nbsp;word,
 216             java.lang.String&nbsp;partOfSpeech,
 217             java.lang.String[]&nbsp;phones)</CODE>\r
 218 \r
 219 <BR>\r
 220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a word to the addenda.</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;boolean</CODE></FONT></TD>\r
 225 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#compare(com.sun.speech.freetts.lexicon.LexiconImpl)">compare</A></B>(<A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html" title="class in com.sun.speech.freetts.lexicon">LexiconImpl</A>&nbsp;other)</CODE>\r
 226 \r
 227 <BR>\r
 228 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests to see if this lexicon is identical to the other for
 229  debugging purposes.</TD>\r
 230 </TR>\r
 231 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 233 <CODE>protected &nbsp;java.util.Map</CODE></FONT></TD>\r
 234 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#createLexicon(java.io.InputStream, boolean, int)">createLexicon</A></B>(java.io.InputStream&nbsp;is,
 235               boolean&nbsp;binary,
 236               int&nbsp;estimatedSize)</CODE>\r
 237 \r
 238 <BR>\r
 239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the given input stream as lexicon data and returns the
 240  results in a <code>Map</code>.</TD>\r
 241 </TR>\r
 242 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 243 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 244 <CODE>&nbsp;void</CODE></FONT></TD>\r
 245 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#dumpBinary(java.lang.String)">dumpBinary</A></B>(java.lang.String&nbsp;path)</CODE>\r
 246 \r
 247 <BR>\r
 248 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps this lexicon (just the compiled form). </TD>\r
 249 </TR>\r
 250 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 251 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 252 <CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>\r
 253 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#fixPartOfSpeech(java.lang.String)">fixPartOfSpeech</A></B>(java.lang.String&nbsp;partOfSpeech)</CODE>\r
 254 \r
 255 <BR>\r
 256 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fixes the part of speech if it is <code>null</code>.  </TD>\r
 257 </TR>\r
 258 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 259 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 260 <CODE>protected &nbsp;java.lang.String[]</CODE></FONT></TD>\r
 261 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.util.Map, java.lang.String)">getPhones</A></B>(java.util.Map&nbsp;lexicon,
 262           java.lang.String&nbsp;wordAndPartOfSpeech)</CODE>\r
 263 \r
 264 <BR>\r
 265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a phone list for a word from a given lexicon.  </TD>\r
 266 </TR>\r
 267 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 269 <CODE>protected &nbsp;java.lang.String[]</CODE></FONT></TD>\r
 270 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.util.Map, java.lang.String, java.lang.String)">getPhones</A></B>(java.util.Map&nbsp;lexicon,
 271           java.lang.String&nbsp;word,
 272           java.lang.String&nbsp;partOfSpeech)</CODE>\r
 273 \r
 274 <BR>\r
 275 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a phone list for a word from a given lexicon.  </TD>\r
 276 </TR>\r
 277 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 279 <CODE>protected &nbsp;java.lang.String[]</CODE></FONT></TD>\r
 280 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.lang.String)">getPhones</A></B>(java.lang.String&nbsp;phones)</CODE>\r
 281 \r
 282 <BR>\r
 283 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Turns the phone <code>String</code> into a <code>String[]</code>,
 284  using " " as the delimiter.</TD>\r
 285 </TR>\r
 286 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 287 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 288 <CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>\r
 289 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.lang.String, java.lang.String)">getPhones</A></B>(java.lang.String&nbsp;word,
 290           java.lang.String&nbsp;partOfSpeech)</CODE>\r
 291 \r
 292 <BR>\r
 293 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the phone list for a given word.  </TD>\r
 294 </TR>\r
 295 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 296 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 297 <CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>\r
 298 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#getPhones(java.lang.String, java.lang.String, boolean)">getPhones</A></B>(java.lang.String&nbsp;word,
 299           java.lang.String&nbsp;partOfSpeech,
 300           boolean&nbsp;useLTS)</CODE>\r
 301 \r
 302 <BR>\r
 303 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the phone list for a given word.  </TD>\r
 304 </TR>\r
 305 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 306 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 307 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 308 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#isLoaded()">isLoaded</A></B>()</CODE>\r
 309 \r
 310 <BR>\r
 311 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if this lexicon is loaded.</TD>\r
 312 </TR>\r
 313 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 314 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 315 <CODE>&nbsp;void</CODE></FONT></TD>\r
 316 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#load()">load</A></B>()</CODE>\r
 317 \r
 318 <BR>\r
 319 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads the data for this lexicon.  </TD>\r
 320 </TR>\r
 321 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 322 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 323 <CODE>protected &nbsp;java.util.Map</CODE></FONT></TD>\r
 324 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#loadTextLexicon(java.io.InputStream, int)">loadTextLexicon</A></B>(java.io.InputStream&nbsp;is,
 325                 int&nbsp;estimatedSize)</CODE>\r
 326 \r
 327 <BR>\r
 328 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the given input stream as text lexicon data and returns the
 329  results in a <code>Map</code>.</TD>\r
 330 </TR>\r
 331 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 332 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 333 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
 334 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#parseAndAdd(java.util.Map, java.lang.String)">parseAndAdd</A></B>(java.util.Map&nbsp;lexicon,
 335             java.lang.String&nbsp;line)</CODE>\r
 336 \r
 337 <BR>\r
 338 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a word from the given input line and add it to the lexicon.</TD>\r
 339 </TR>\r
 340 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 341 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 342 <CODE>&nbsp;void</CODE></FONT></TD>\r
 343 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#removeAddendum(java.lang.String, java.lang.String)">removeAddendum</A></B>(java.lang.String&nbsp;word,
 344                java.lang.String&nbsp;partOfSpeech)</CODE>\r
 345 \r
 346 <BR>\r
 347 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a word from the addenda.</TD>\r
 348 </TR>\r
 349 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 350 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 351 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
 352 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html#setLexiconParameters(java.net.URL, java.net.URL, java.net.URL, boolean)">setLexiconParameters</A></B>(java.net.URL&nbsp;compiledURL,
 353                      java.net.URL&nbsp;addendaURL,
 354                      java.net.URL&nbsp;letterToSoundURL,
 355                      boolean&nbsp;binary)</CODE>\r
 356 \r
 357 <BR>\r
 358 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the lexicon parameters</TD>\r
 359 </TR>\r
 360 </TABLE>\r
 361 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 362 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 363 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 364 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
 365 </TR>\r
 366 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 367 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 368 </TR>\r
 369 </TABLE>\r
 370 &nbsp;<A NAME="methods_inherited_from_class_com.sun.speech.freetts.lexicon.Lexicon"><!-- --></A>
 371 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 372 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 373 <TD><B>Methods inherited from interface com.sun.speech.freetts.lexicon.<A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></B></TD>\r
 374 </TR>\r
 375 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 376 <TD><CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html#isSyllableBoundary(java.util.List, java.lang.String[], int)">isSyllableBoundary</A></CODE></TD>\r
 377 </TR>\r
 378 </TABLE>\r
 379 &nbsp;\r
 380 <P>\r
 381 \r
 382 <!-- ============ FIELD DETAIL =========== -->\r
 383 \r
 384 <A NAME="field_detail"><!-- --></A>
 385 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 386 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 387 <TD COLSPAN=1><FONT SIZE="+2">\r
 388 <B>Field Detail</B></FONT></TD>\r
 389 </TR>\r
 390 </TABLE>\r
 391 \r
 392 <A NAME="tokenizeOnLoad"><!-- --></A><H3>\r
 393 tokenizeOnLoad</H3>\r
 394 <PRE>\r
 395 protected boolean <B>tokenizeOnLoad</B></PRE>\r
 396 <DL>\r
 397 <DD>If true, the phone string is replaced with the phone array in
 398  the hashmap when the phone array is loaded.  The side effects
 399  of this are quicker lookups, but more memory usage and a longer
 400  startup time.\r
 401 <P>\r
 402 <DL>\r
 403 </DL>\r
 404 </DL>\r
 405 <HR>\r
 406 \r
 407 <A NAME="tokenizeOnLookup"><!-- --></A><H3>\r
 408 tokenizeOnLookup</H3>\r
 409 <PRE>\r
 410 protected boolean <B>tokenizeOnLookup</B></PRE>\r
 411 <DL>\r
 412 <DD>If true, the phone string is replaced with the phone array in
 413  the hashmap when the phone array is first looked up.  The side effects
 414  Set by cmufilelex.tokenize=lookup.\r
 415 <P>\r
 416 <DL>\r
 417 </DL>\r
 418 </DL>\r
 419 \r
 420 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 421 \r
 422 <A NAME="constructor_detail"><!-- --></A>
 423 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 424 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 425 <TD COLSPAN=1><FONT SIZE="+2">\r
 426 <B>Constructor Detail</B></FONT></TD>\r
 427 </TR>\r
 428 </TABLE>\r
 429 \r
 430 <A NAME="LexiconImpl(java.net.URL, java.net.URL, java.net.URL, boolean)"><!-- --></A><H3>\r
 431 LexiconImpl</H3>\r
 432 <PRE>\r
 433 public <B>LexiconImpl</B>(java.net.URL&nbsp;compiledURL,
 434                    java.net.URL&nbsp;addendaURL,
 435                    java.net.URL&nbsp;letterToSoundURL,
 436                    boolean&nbsp;binary)</PRE>\r
 437 <DL>\r
 438 <DD>Create a new LexiconImpl by reading from the given URLS.\r
 439 <P>\r
 440 <DT><B>Parameters:</B><DD><CODE>compiledURL</CODE> - a URL pointing to the compiled lexicon<DD><CODE>addendaURL</CODE> - a URL pointing to lexicon addenda<DD><CODE>letterToSoundURL</CODE> - a LetterToSound to use if a word cannot
 441    be found in the compiled form or the addenda<DD><CODE>binary</CODE> - if <code>true</code>, the input streams are binary;
 442    otherwise, they are text.</DL>\r
 443 <HR>\r
 444 \r
 445 <A NAME="LexiconImpl()"><!-- --></A><H3>\r
 446 LexiconImpl</H3>\r
 447 <PRE>\r
 448 public <B>LexiconImpl</B>()</PRE>\r
 449 <DL>\r
 450 <DD>Class constructor for an empty Lexicon.\r
 451 <P>\r
 452 </DL>\r
 453 \r
 454 <!-- ============ METHOD DETAIL ========== -->\r
 455 \r
 456 <A NAME="method_detail"><!-- --></A>
 457 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 458 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 459 <TD COLSPAN=1><FONT SIZE="+2">\r
 460 <B>Method Detail</B></FONT></TD>\r
 461 </TR>\r
 462 </TABLE>\r
 463 \r
 464 <A NAME="setLexiconParameters(java.net.URL, java.net.URL, java.net.URL, boolean)"><!-- --></A><H3>\r
 465 setLexiconParameters</H3>\r
 466 <PRE>\r
 467 protected void <B>setLexiconParameters</B>(java.net.URL&nbsp;compiledURL,
 468                                     java.net.URL&nbsp;addendaURL,
 469                                     java.net.URL&nbsp;letterToSoundURL,
 470                                     boolean&nbsp;binary)</PRE>\r
 471 <DL>\r
 472 <DD>Sets the lexicon parameters\r
 473 <P>\r
 474 <DD><DL>\r
 475 </DL>\r
 476 </DD>\r
 477 <DD><DL>\r
 478 <DT><B>Parameters:</B><DD><CODE>compiledURL</CODE> - a URL pointing to the compiled lexicon<DD><CODE>addendaURL</CODE> - a URL pointing to lexicon addenda<DD><CODE>letterToSoundURL</CODE> - a URL pointing to the LetterToSound to use<DD><CODE>binary</CODE> - if <code>true</code>, the input streams are binary;
 479    otherwise, they are text.</DL>\r
 480 </DD>\r
 481 </DL>\r
 482 <HR>\r
 483 \r
 484 <A NAME="isLoaded()"><!-- --></A><H3>\r
 485 isLoaded</H3>\r
 486 <PRE>\r
 487 public boolean <B>isLoaded</B>()</PRE>\r
 488 <DL>\r
 489 <DD>Determines if this lexicon is loaded.\r
 490 <P>\r
 491 <DD><DL>\r
 492 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html#isLoaded()">isLoaded</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></CODE></DL>\r
 493 </DD>\r
 494 <DD><DL>\r
 495
 496 <DT><B>Returns:</B><DD><code>true</code> if the lexicon is loaded</DL>\r
 497 </DD>\r
 498 </DL>\r
 499 <HR>\r
 500 \r
 501 <A NAME="load()"><!-- --></A><H3>\r
 502 load</H3>\r
 503 <PRE>\r
 504 public void <B>load</B>()
 505           throws java.io.IOException</PRE>\r
 506 <DL>\r
 507 <DD>Loads the data for this lexicon.  If the\r
 508 <P>\r
 509 <DD><DL>\r
 510 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html#load()">load</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></CODE></DL>\r
 511 </DD>\r
 512 <DD><DL>\r
 513
 514 <DT><B>Throws:</B>
 515 <DD><CODE>java.io.IOException</CODE> - if errors occur during loading</DL>\r
 516 </DD>\r
 517 </DL>\r
 518 <HR>\r
 519 \r
 520 <A NAME="createLexicon(java.io.InputStream, boolean, int)"><!-- --></A><H3>\r
 521 createLexicon</H3>\r
 522 <PRE>\r
 523 protected java.util.Map <B>createLexicon</B>(java.io.InputStream&nbsp;is,
 524                                       boolean&nbsp;binary,
 525                                       int&nbsp;estimatedSize)
 526                                throws java.io.IOException</PRE>\r
 527 <DL>\r
 528 <DD>Reads the given input stream as lexicon data and returns the
 529  results in a <code>Map</code>.\r
 530 <P>\r
 531 <DD><DL>\r
 532 </DL>\r
 533 </DD>\r
 534 <DD><DL>\r
 535 <DT><B>Parameters:</B><DD><CODE>is</CODE> - the input stream<DD><CODE>binary</CODE> - if <code>true</code>, the data is binary<DD><CODE>estimatedSize</CODE> - the estimated size of the lexicon
 536 <DT><B>Throws:</B>
 537 <DD><CODE>java.io.IOException</CODE> - if errors are encountered while reading the data</DL>\r
 538 </DD>\r
 539 </DL>\r
 540 <HR>\r
 541 \r
 542 <A NAME="loadTextLexicon(java.io.InputStream, int)"><!-- --></A><H3>\r
 543 loadTextLexicon</H3>\r
 544 <PRE>\r
 545 protected java.util.Map <B>loadTextLexicon</B>(java.io.InputStream&nbsp;is,
 546                                         int&nbsp;estimatedSize)
 547                                  throws java.io.IOException</PRE>\r
 548 <DL>\r
 549 <DD>Reads the given input stream as text lexicon data and returns the
 550  results in a <code>Map</code>.\r
 551 <P>\r
 552 <DD><DL>\r
 553 </DL>\r
 554 </DD>\r
 555 <DD><DL>\r
 556 <DT><B>Parameters:</B><DD><CODE>is</CODE> - the input stream<DD><CODE>estimatedSize</CODE> - the estimated number of entries of the lexicon
 557 <DT><B>Throws:</B>
 558 <DD><CODE>java.io.IOException</CODE> - if errors are encountered while reading the data</DL>\r
 559 </DD>\r
 560 </DL>\r
 561 <HR>\r
 562 \r
 563 <A NAME="parseAndAdd(java.util.Map, java.lang.String)"><!-- --></A><H3>\r
 564 parseAndAdd</H3>\r
 565 <PRE>\r
 566 protected void <B>parseAndAdd</B>(java.util.Map&nbsp;lexicon,
 567                            java.lang.String&nbsp;line)</PRE>\r
 568 <DL>\r
 569 <DD>Creates a word from the given input line and add it to the lexicon.\r
 570 <P>\r
 571 <DD><DL>\r
 572 </DL>\r
 573 </DD>\r
 574 <DD><DL>\r
 575 <DT><B>Parameters:</B><DD><CODE>lexicon</CODE> - the lexicon<DD><CODE>line</CODE> - the input text</DL>\r
 576 </DD>\r
 577 </DL>\r
 578 <HR>\r
 579 \r
 580 <A NAME="getPhones(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
 581 getPhones</H3>\r
 582 <PRE>\r
 583 public java.lang.String[] <B>getPhones</B>(java.lang.String&nbsp;word,
 584                                     java.lang.String&nbsp;partOfSpeech)</PRE>\r
 585 <DL>\r
 586 <DD>Gets the phone list for a given word.  If a phone list cannot
 587  be found, returns <code>null</code>.  The format is lexicon
 588  dependent.  If the part of speech does not matter, pass in
 589  <code>null</code>.\r
 590 <P>\r
 591 <DD><DL>\r
 592 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html#getPhones(java.lang.String, java.lang.String)">getPhones</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></CODE></DL>\r
 593 </DD>\r
 594 <DD><DL>\r
 595 <DT><B>Parameters:</B><DD><CODE>word</CODE> - the word to find<DD><CODE>partOfSpeech</CODE> - the part of speech
 596 <DT><B>Returns:</B><DD>the list of phones for word or <code>null</code></DL>\r
 597 </DD>\r
 598 </DL>\r
 599 <HR>\r
 600 \r
 601 <A NAME="getPhones(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>\r
 602 getPhones</H3>\r
 603 <PRE>\r
 604 public java.lang.String[] <B>getPhones</B>(java.lang.String&nbsp;word,
 605                                     java.lang.String&nbsp;partOfSpeech,
 606                                     boolean&nbsp;useLTS)</PRE>\r
 607 <DL>\r
 608 <DD>Gets the phone list for a given word.  If a phone list cannot
 609  be found, <code>null</code> is returned.  The
 610  <code>partOfSpeech</code> is implementation dependent, but
 611  <code>null</code> always matches.\r
 612 <P>\r
 613 <DD><DL>\r
 614 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html#getPhones(java.lang.String, java.lang.String, boolean)">getPhones</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></CODE></DL>\r
 615 </DD>\r
 616 <DD><DL>\r
 617 <DT><B>Parameters:</B><DD><CODE>word</CODE> - the word to find<DD><CODE>partOfSpeech</CODE> - the part of speech or <code>null</code><DD><CODE>useLTS</CODE> - whether to use the letter-to-sound rules when
 618         the word is not in the lexicon.
 619 <DT><B>Returns:</B><DD>the list of phones for word or null</DL>\r
 620 </DD>\r
 621 </DL>\r
 622 <HR>\r
 623 \r
 624 <A NAME="getPhones(java.util.Map, java.lang.String, java.lang.String)"><!-- --></A><H3>\r
 625 getPhones</H3>\r
 626 <PRE>\r
 627 protected java.lang.String[] <B>getPhones</B>(java.util.Map&nbsp;lexicon,
 628                                        java.lang.String&nbsp;word,
 629                                        java.lang.String&nbsp;partOfSpeech)</PRE>\r
 630 <DL>\r
 631 <DD>Gets a phone list for a word from a given lexicon.  If a phone
 632  list cannot be found, returns <code>null</code>.  The format is
 633  lexicon dependent.  If the part of speech does not matter, pass
 634  in <code>null</code>.\r
 635 <P>\r
 636 <DD><DL>\r
 637 </DL>\r
 638 </DD>\r
 639 <DD><DL>\r
 640 <DT><B>Parameters:</B><DD><CODE>lexicon</CODE> - the lexicon<DD><CODE>word</CODE> - the word to find<DD><CODE>partOfSpeech</CODE> - the part of speech
 641 <DT><B>Returns:</B><DD>the list of phones for word or <code>null</code></DL>\r
 642 </DD>\r
 643 </DL>\r
 644 <HR>\r
 645 \r
 646 <A NAME="getPhones(java.util.Map, java.lang.String)"><!-- --></A><H3>\r
 647 getPhones</H3>\r
 648 <PRE>\r
 649 protected java.lang.String[] <B>getPhones</B>(java.util.Map&nbsp;lexicon,
 650                                        java.lang.String&nbsp;wordAndPartOfSpeech)</PRE>\r
 651 <DL>\r
 652 <DD>Gets a phone list for a word from a given lexicon.  If a phone
 653  list cannot be found, returns <code>null</code>.\r
 654 <P>\r
 655 <DD><DL>\r
 656 </DL>\r
 657 </DD>\r
 658 <DD><DL>\r
 659 <DT><B>Parameters:</B><DD><CODE>lexicon</CODE> - the lexicon<DD><CODE>wordAndPartOfSpeech</CODE> - word and part of speech concatenated
 660    together
 661 <DT><B>Returns:</B><DD>the list of phones for word or <code>null</code></DL>\r
 662 </DD>\r
 663 </DL>\r
 664 <HR>\r
 665 \r
 666 <A NAME="getPhones(java.lang.String)"><!-- --></A><H3>\r
 667 getPhones</H3>\r
 668 <PRE>\r
 669 protected java.lang.String[] <B>getPhones</B>(java.lang.String&nbsp;phones)</PRE>\r
 670 <DL>\r
 671 <DD>Turns the phone <code>String</code> into a <code>String[]</code>,
 672  using " " as the delimiter.\r
 673 <P>\r
 674 <DD><DL>\r
 675 </DL>\r
 676 </DD>\r
 677 <DD><DL>\r
 678 <DT><B>Parameters:</B><DD><CODE>phones</CODE> - the phones
 679 <DT><B>Returns:</B><DD>the phones split into an array</DL>\r
 680 </DD>\r
 681 </DL>\r
 682 <HR>\r
 683 \r
 684 <A NAME="addAddendum(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>\r
 685 addAddendum</H3>\r
 686 <PRE>\r
 687 public void <B>addAddendum</B>(java.lang.String&nbsp;word,
 688                         java.lang.String&nbsp;partOfSpeech,
 689                         java.lang.String[]&nbsp;phones)</PRE>\r
 690 <DL>\r
 691 <DD>Adds a word to the addenda.\r
 692 <P>\r
 693 <DD><DL>\r
 694 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html#addAddendum(java.lang.String, java.lang.String, java.lang.String[])">addAddendum</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></CODE></DL>\r
 695 </DD>\r
 696 <DD><DL>\r
 697 <DT><B>Parameters:</B><DD><CODE>word</CODE> - the word to find<DD><CODE>partOfSpeech</CODE> - the part of speech<DD><CODE>phones</CODE> - the phones for the word</DL>\r
 698 </DD>\r
 699 </DL>\r
 700 <HR>\r
 701 \r
 702 <A NAME="removeAddendum(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
 703 removeAddendum</H3>\r
 704 <PRE>\r
 705 public void <B>removeAddendum</B>(java.lang.String&nbsp;word,
 706                            java.lang.String&nbsp;partOfSpeech)</PRE>\r
 707 <DL>\r
 708 <DD>Removes a word from the addenda.\r
 709 <P>\r
 710 <DD><DL>\r
 711 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html#removeAddendum(java.lang.String, java.lang.String)">removeAddendum</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></CODE></DL>\r
 712 </DD>\r
 713 <DD><DL>\r
 714 <DT><B>Parameters:</B><DD><CODE>word</CODE> - the word to remove<DD><CODE>partOfSpeech</CODE> - the part of speech</DL>\r
 715 </DD>\r
 716 </DL>\r
 717 <HR>\r
 718 \r
 719 <A NAME="dumpBinary(java.lang.String)"><!-- --></A><H3>\r
 720 dumpBinary</H3>\r
 721 <PRE>\r
 722 public void <B>dumpBinary</B>(java.lang.String&nbsp;path)</PRE>\r
 723 <DL>\r
 724 <DD>Dumps this lexicon (just the compiled form). Lexicon will be
 725  dumped to two binary files PATH_compiled.bin and
 726  PATH_addenda.bin\r
 727 <P>\r
 728 <DD><DL>\r
 729 </DL>\r
 730 </DD>\r
 731 <DD><DL>\r
 732 <DT><B>Parameters:</B><DD><CODE>path</CODE> - the root path to dump it to</DL>\r
 733 </DD>\r
 734 </DL>\r
 735 <HR>\r
 736 \r
 737 <A NAME="compare(com.sun.speech.freetts.lexicon.LexiconImpl)"><!-- --></A><H3>\r
 738 compare</H3>\r
 739 <PRE>\r
 740 public boolean <B>compare</B>(<A HREF="../../../../../com/sun/speech/freetts/lexicon/LexiconImpl.html" title="class in com.sun.speech.freetts.lexicon">LexiconImpl</A>&nbsp;other)</PRE>\r
 741 <DL>\r
 742 <DD>Tests to see if this lexicon is identical to the other for
 743  debugging purposes.\r
 744 <P>\r
 745 <DD><DL>\r
 746 </DL>\r
 747 </DD>\r
 748 <DD><DL>\r
 749 <DT><B>Parameters:</B><DD><CODE>other</CODE> - the other lexicon to compare to
 750 <DT><B>Returns:</B><DD>true if lexicons are identical</DL>\r
 751 </DD>\r
 752 </DL>\r
 753 <HR>\r
 754 \r
 755 <A NAME="fixPartOfSpeech(java.lang.String)"><!-- --></A><H3>\r
 756 fixPartOfSpeech</H3>\r
 757 <PRE>\r
 758 protected static java.lang.String <B>fixPartOfSpeech</B>(java.lang.String&nbsp;partOfSpeech)</PRE>\r
 759 <DL>\r
 760 <DD>Fixes the part of speech if it is <code>null</code>.  The
 761  default representation of a <code>null</code> part of speech
 762  is the number "0".\r
 763 <P>\r
 764 <DD><DL>\r
 765 </DL>\r
 766 </DD>\r
 767 <DD><DL>\r
 768 </DL>\r
 769 </DD>\r
 770 </DL>\r
 771 <!-- ========= END OF CLASS DATA ========= -->\r
 772 <HR>\r
 773 \r
 774
 775 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 776 <A NAME="navbar_bottom"><!-- --></A>
 777 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 778 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 779 <TR>\r
 780 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 781 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 782 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 783   <TR ALIGN="center" VALIGN="top">\r
 784   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 785   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 786   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 787   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 788   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 789   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 790   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 791   </TR>\r
 792 </TABLE>\r
 793 </TD>\r
 794 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 795 </EM>\r
 796 </TD>\r
 797 </TR>\r
 798 \r
 799 <TR>\r
 800 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 801 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/lexicon/LetterToSoundImpl.html" title="class in com.sun.speech.freetts.lexicon"><B>PREV CLASS</B></A>&nbsp;\r
 802 &nbsp;NEXT CLASS</FONT></TD>\r
 803 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 804   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 805 &nbsp;<A HREF="LexiconImpl.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 806 &nbsp;<SCRIPT type="text/javascript">\r
 807   <!--\r
 808   if(window==top) {\r
 809     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 810   }\r
 811   //-->\r
 812 </SCRIPT>\r
 813 <NOSCRIPT>\r
 814   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 815 </NOSCRIPT>
 816 \r
 817 </FONT></TD>\r
 818 </TR>\r
 819 <TR>\r
 820 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 821   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 822 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 823 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 824 </TR>\r
 825 </TABLE>\r
 826 <A NAME="skip-navbar_bottom"></A>
 827 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 828 \r
 829 <HR>\r
 830 \r
 831 </BODY>\r
 832 </HTML>\r