/usr/share/doc/libjazzy-java/javadoc/com/swabunga/spell/engine/SpellDictionaryHashMap.html is in libjazzy-java 0.5.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Mon Oct 17 20:17:59 UTC 2011 -->
<TITLE>
SpellDictionaryHashMap
</TITLE>
<META NAME="date" CONTENT="2011-10-17">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SpellDictionaryHashMap";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryDisk.html" title="class in com.swabunga.spell.engine"><B>PREV CLASS</B></A>
<A HREF="../../../../com/swabunga/spell/engine/Transformator.html" title="interface in com.swabunga.spell.engine"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/swabunga/spell/engine/SpellDictionaryHashMap.html" target="_top"><B>FRAMES</B></A>
<A HREF="SpellDictionaryHashMap.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.swabunga.spell.engine</FONT>
<BR>
Class SpellDictionaryHashMap</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine">com.swabunga.spell.engine.SpellDictionaryASpell</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.swabunga.spell.engine.SpellDictionaryHashMap</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/swabunga/spell/engine/SpellDictionary.html" title="interface in com.swabunga.spell.engine">SpellDictionary</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>SpellDictionaryHashMap</B><DT>extends <A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine">SpellDictionaryASpell</A></DL>
</PRE>
<P>
The SpellDictionaryHashMap holds the dictionary
<p/>
This class is thread safe. Derived classes should ensure that this preserved.
<p/>
There are many open source dictionary files. For just a few see:
http://wordlist.sourceforge.net/
<p/>
This dictionary class reads words one per line. Make sure that your word list
is formatted in this way (most are).
<p/>
Note that you must create the dictionary with a word list for the added
words to persist.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.util.Hashtable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#mainDictionary">mainDictionary</A></B></CODE>
<BR>
The hashmap that contains the word dictionary.</TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_com.swabunga.spell.engine.SpellDictionaryASpell"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class com.swabunga.spell.engine.<A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine">SpellDictionaryASpell</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html#tf">tf</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#SpellDictionaryHashMap()">SpellDictionaryHashMap</A></B>()</CODE>
<BR>
Dictionary Constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#SpellDictionaryHashMap(java.io.File)">SpellDictionaryHashMap</A></B>(java.io.File wordList)</CODE>
<BR>
Dictionary convenience Constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#SpellDictionaryHashMap(java.io.File, java.io.File)">SpellDictionaryHashMap</A></B>(java.io.File wordList,
java.io.File phonetic)</CODE>
<BR>
Dictionary constructor that uses an aspell phonetic file to
build the transformation table.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#SpellDictionaryHashMap(java.io.File, java.io.File, java.lang.String)">SpellDictionaryHashMap</A></B>(java.io.File wordList,
java.io.File phonetic,
java.lang.String phoneticEncoding)</CODE>
<BR>
Dictionary constructor that uses an aspell phonetic file to
build the transformation table.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#SpellDictionaryHashMap(java.io.Reader)">SpellDictionaryHashMap</A></B>(java.io.Reader wordList)</CODE>
<BR>
Dictionary Constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#SpellDictionaryHashMap(java.io.Reader, java.io.Reader)">SpellDictionaryHashMap</A></B>(java.io.Reader wordList,
java.io.Reader phonetic)</CODE>
<BR>
Dictionary constructor that uses an aspell phonetic file to
build the transformation table.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#addDictionary(java.io.File)">addDictionary</A></B>(java.io.File wordList)</CODE>
<BR>
Add words from a file to existing dictionary hashmap.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#addDictionary(java.io.Reader)">addDictionary</A></B>(java.io.Reader wordList)</CODE>
<BR>
Add words from a Reader to existing dictionary hashmap.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#addDictionaryHelper(java.io.BufferedReader)">addDictionaryHelper</A></B>(java.io.BufferedReader in)</CODE>
<BR>
Adds to the existing dictionary from a word list file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#addWord(java.lang.String)">addWord</A></B>(java.lang.String word)</CODE>
<BR>
Add a word permanently to the dictionary (and the dictionary file).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#createDictionary(java.io.BufferedReader)">createDictionary</A></B>(java.io.BufferedReader in)</CODE>
<BR>
Constructs the dictionary from a word list file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#getWords(java.lang.String)">getWords</A></B>(java.lang.String code)</CODE>
<BR>
Returns a list of strings (words) for the code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#isCorrect(java.lang.String)">isCorrect</A></B>(java.lang.String word)</CODE>
<BR>
Returns true if the word is correctly spelled against the current word list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#putWord(java.lang.String)">putWord</A></B>(java.lang.String word)</CODE>
<BR>
Allocates a word in the dictionary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html#putWordUnique(java.lang.String)">putWordUnique</A></B>(java.lang.String word)</CODE>
<BR>
Allocates a word, if it is not already present in the dictionary.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_com.swabunga.spell.engine.SpellDictionaryASpell"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.swabunga.spell.engine.<A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine">SpellDictionaryASpell</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html#getCode(java.lang.String)">getCode</A>, <A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html#getSuggestions(java.lang.String, int)">getSuggestions</A>, <A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html#getSuggestions(java.lang.String, int, int[][])">getSuggestions</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="mainDictionary"><!-- --></A><H3>
mainDictionary</H3>
<PRE>
protected java.util.Hashtable <B>mainDictionary</B></PRE>
<DL>
<DD>The hashmap that contains the word dictionary. The map is hashed on the doublemeta
code. The map entry contains a LinkedList of words that have the same double meta code.
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SpellDictionaryHashMap()"><!-- --></A><H3>
SpellDictionaryHashMap</H3>
<PRE>
public <B>SpellDictionaryHashMap</B>()
throws java.io.IOException</PRE>
<DL>
<DD>Dictionary Constructor.
<P>
<DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - indicates a problem with the file system</DL>
</DL>
<HR>
<A NAME="SpellDictionaryHashMap(java.io.Reader)"><!-- --></A><H3>
SpellDictionaryHashMap</H3>
<PRE>
public <B>SpellDictionaryHashMap</B>(java.io.Reader wordList)
throws java.io.IOException</PRE>
<DL>
<DD>Dictionary Constructor.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>wordList</CODE> - The file containing the words list for the dictionary
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - indicates problems reading the words list
file</DL>
</DL>
<HR>
<A NAME="SpellDictionaryHashMap(java.io.File)"><!-- --></A><H3>
SpellDictionaryHashMap</H3>
<PRE>
public <B>SpellDictionaryHashMap</B>(java.io.File wordList)
throws java.io.FileNotFoundException,
java.io.IOException</PRE>
<DL>
<DD>Dictionary convenience Constructor.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>wordList</CODE> - The file containing the words list for the dictionary
<DT><B>Throws:</B>
<DD><CODE>java.io.FileNotFoundException</CODE> - indicates problems locating the
words list file on the system
<DD><CODE>java.io.IOException</CODE> - indicates problems reading the words list
file</DL>
</DL>
<HR>
<A NAME="SpellDictionaryHashMap(java.io.File, java.io.File)"><!-- --></A><H3>
SpellDictionaryHashMap</H3>
<PRE>
public <B>SpellDictionaryHashMap</B>(java.io.File wordList,
java.io.File phonetic)
throws java.io.FileNotFoundException,
java.io.IOException</PRE>
<DL>
<DD>Dictionary constructor that uses an aspell phonetic file to
build the transformation table.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>wordList</CODE> - The file containing the words list for the dictionary<DD><CODE>phonetic</CODE> - The file to use for phonetic transformation of the
wordlist.
<DT><B>Throws:</B>
<DD><CODE>java.io.FileNotFoundException</CODE> - indicates problems locating the
file on the system
<DD><CODE>java.io.IOException</CODE> - indicates problems reading the words list
file</DL>
</DL>
<HR>
<A NAME="SpellDictionaryHashMap(java.io.File, java.io.File, java.lang.String)"><!-- --></A><H3>
SpellDictionaryHashMap</H3>
<PRE>
public <B>SpellDictionaryHashMap</B>(java.io.File wordList,
java.io.File phonetic,
java.lang.String phoneticEncoding)
throws java.io.FileNotFoundException,
java.io.IOException</PRE>
<DL>
<DD>Dictionary constructor that uses an aspell phonetic file to
build the transformation table. Encoding is used for phonetic file only;
default encoding is used for wordList
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>wordList</CODE> - The file containing the words list for the dictionary<DD><CODE>phonetic</CODE> - The file to use for phonetic transformation of the
wordlist.<DD><CODE>phoneticEncoding</CODE> - Uses the character set encoding specified
<DT><B>Throws:</B>
<DD><CODE>java.io.FileNotFoundException</CODE> - indicates problems locating the
file on the system
<DD><CODE>java.io.IOException</CODE> - indicates problems reading the words list
or phonetic information</DL>
</DL>
<HR>
<A NAME="SpellDictionaryHashMap(java.io.Reader, java.io.Reader)"><!-- --></A><H3>
SpellDictionaryHashMap</H3>
<PRE>
public <B>SpellDictionaryHashMap</B>(java.io.Reader wordList,
java.io.Reader phonetic)
throws java.io.IOException</PRE>
<DL>
<DD>Dictionary constructor that uses an aspell phonetic file to
build the transformation table.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>wordList</CODE> - The file containing the words list for the dictionary<DD><CODE>phonetic</CODE> - The reader to use for phonetic transformation of the
wordlist.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - indicates problems reading the words list
or phonetic information</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="addDictionary(java.io.File)"><!-- --></A><H3>
addDictionary</H3>
<PRE>
public void <B>addDictionary</B>(java.io.File wordList)
throws java.io.FileNotFoundException,
java.io.IOException</PRE>
<DL>
<DD>Add words from a file to existing dictionary hashmap.
This function can be called as many times as needed to
build the internal word list. Duplicates are not added.
<p>
Note that adding a dictionary does not affect the target
dictionary file for the addWord method. That is, addWord() continues
to make additions to the dictionary file specified in createDictionary()
<P>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>wordList</CODE> - a File object that contains the words, on word per line.
<DT><B>Throws:</B>
<DD><CODE>java.io.FileNotFoundException</CODE>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="addDictionary(java.io.Reader)"><!-- --></A><H3>
addDictionary</H3>
<PRE>
public void <B>addDictionary</B>(java.io.Reader wordList)
throws java.io.IOException</PRE>
<DL>
<DD>Add words from a Reader to existing dictionary hashmap.
This function can be called as many times as needed to
build the internal word list. Duplicates are not added.
<p>
Note that adding a dictionary does not affect the target
dictionary file for the addWord method. That is, addWord() continues
to make additions to the dictionary file specified in createDictionary()
<P>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>wordList</CODE> - a Reader object that contains the words, on word per line.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="addWord(java.lang.String)"><!-- --></A><H3>
addWord</H3>
<PRE>
public void <B>addWord</B>(java.lang.String word)</PRE>
<DL>
<DD>Add a word permanently to the dictionary (and the dictionary file).
<p>This needs to be made thread safe (synchronized)</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>word</CODE> - The word to add to the dictionary</DL>
</DD>
</DL>
<HR>
<A NAME="createDictionary(java.io.BufferedReader)"><!-- --></A><H3>
createDictionary</H3>
<PRE>
protected void <B>createDictionary</B>(java.io.BufferedReader in)
throws java.io.IOException</PRE>
<DL>
<DD>Constructs the dictionary from a word list file.
<p>
Each word in the reader should be on a separate line.
<p>
This is a very slow function. On my machine it takes quite a while to
load the data in. I suspect that we could speed this up quite allot.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="addDictionaryHelper(java.io.BufferedReader)"><!-- --></A><H3>
addDictionaryHelper</H3>
<PRE>
protected void <B>addDictionaryHelper</B>(java.io.BufferedReader in)
throws java.io.IOException</PRE>
<DL>
<DD>Adds to the existing dictionary from a word list file. If the word
already exists in the dictionary, a new entry is not added.
<p>
Each word in the reader should be on a separate line.
<p>
Note: for whatever reason that I haven't yet looked into, the phonetic codes
for a particular word map to a vector of words rather than a hash table.
This is a drag since in order to check for duplicates you have to iterate
through all the words that use the phonetic code.
If the vector-based implementation is important, it may be better
to subclass for the cases where duplicates are bad.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="putWord(java.lang.String)"><!-- --></A><H3>
putWord</H3>
<PRE>
protected void <B>putWord</B>(java.lang.String word)</PRE>
<DL>
<DD>Allocates a word in the dictionary
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>word</CODE> - The word to add</DL>
</DD>
</DL>
<HR>
<A NAME="putWordUnique(java.lang.String)"><!-- --></A><H3>
putWordUnique</H3>
<PRE>
protected void <B>putWordUnique</B>(java.lang.String word)</PRE>
<DL>
<DD>Allocates a word, if it is not already present in the dictionary. A word
with a different case is considered the same.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>word</CODE> - The word to add</DL>
</DD>
</DL>
<HR>
<A NAME="getWords(java.lang.String)"><!-- --></A><H3>
getWords</H3>
<PRE>
public java.util.List <B>getWords</B>(java.lang.String code)</PRE>
<DL>
<DD>Returns a list of strings (words) for the code.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html#getWords(java.lang.String)">getWords</A></CODE> in class <CODE><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine">SpellDictionaryASpell</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>code</CODE> - The phonetic code common to the list of words
<DT><B>Returns:</B><DD>A list of words having the same phonetic code</DL>
</DD>
</DL>
<HR>
<A NAME="isCorrect(java.lang.String)"><!-- --></A><H3>
isCorrect</H3>
<PRE>
public boolean <B>isCorrect</B>(java.lang.String word)</PRE>
<DL>
<DD>Returns true if the word is correctly spelled against the current word list.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/engine/SpellDictionary.html#isCorrect(java.lang.String)">isCorrect</A></CODE> in interface <CODE><A HREF="../../../../com/swabunga/spell/engine/SpellDictionary.html" title="interface in com.swabunga.spell.engine">SpellDictionary</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html#isCorrect(java.lang.String)">isCorrect</A></CODE> in class <CODE><A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine">SpellDictionaryASpell</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>word</CODE> - The word to verify if it's spelling is OK.
<DT><B>Returns:</B><DD>Indicates if the word is present in the dictionary.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryDisk.html" title="class in com.swabunga.spell.engine"><B>PREV CLASS</B></A>
<A HREF="../../../../com/swabunga/spell/engine/Transformator.html" title="interface in com.swabunga.spell.engine"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/swabunga/spell/engine/SpellDictionaryHashMap.html" target="_top"><B>FRAMES</B></A>
<A HREF="SpellDictionaryHashMap.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|