/usr/share/doc/libjazzy-java/javadoc/com/swabunga/spell/event/AbstractWordFinder.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 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 | <!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>
AbstractWordFinder
</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="AbstractWordFinder";
}
}
</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">
PREV CLASS
<A HREF="../../../../com/swabunga/spell/event/AbstractWordTokenizer.html" title="class in com.swabunga.spell.event"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/swabunga/spell/event/AbstractWordFinder.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractWordFinder.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.event</FONT>
<BR>
Class AbstractWordFinder</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.swabunga.spell.event.AbstractWordFinder</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/swabunga/spell/event/DefaultWordFinder.html" title="class in com.swabunga.spell.event">DefaultWordFinder</A>, <A HREF="../../../../com/swabunga/spell/event/JavaWordFinder.html" title="class in com.swabunga.spell.event">JavaWordFinder</A>, <A HREF="../../../../com/swabunga/spell/event/TeXWordFinder.html" title="class in com.swabunga.spell.event">TeXWordFinder</A>, <A HREF="../../../../com/swabunga/spell/event/XMLWordFinder.html" title="class in com.swabunga.spell.event">XMLWordFinder</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>AbstractWordFinder</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></DL>
</PRE>
<P>
Defines common methods and behaviour for the various word finding
subclasses.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Anthony Roy (ajr@antroy.co.uk)</DD>
</DL>
<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 <A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#currentWord">currentWord</A></B></CODE>
<BR>
The word being analyzed</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#nextWord">nextWord</A></B></CODE>
<BR>
The word following the current one</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.text.BreakIterator</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#sentenceIterator">sentenceIterator</A></B></CODE>
<BR>
An iterator to work through the sentence</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#startsSentence">startsSentence</A></B></CODE>
<BR>
Indicate if the current word starts a new sentence</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#text">text</A></B></CODE>
<BR>
Holds the text to analyze</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/event/AbstractWordFinder.html#AbstractWordFinder()">AbstractWordFinder</A></B>()</CODE>
<BR>
Creates a new default AbstractWordFinder object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#AbstractWordFinder(java.lang.String)">AbstractWordFinder</A></B>(java.lang.String inText)</CODE>
<BR>
Creates a new AbstractWordFinder object.</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> <A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#current()">current</A></B>()</CODE>
<BR>
Returns the current word in the iteration .</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#getText()">getText</A></B>()</CODE>
<BR>
Return the text being searched.</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/event/AbstractWordFinder.html#hasNext()">hasNext</A></B>()</CODE>
<BR>
Indicates if there is some more word to analyze</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#ignore(int, char)">ignore</A></B>(int index,
char startIgnore)</CODE>
<BR>
Ignores or skip over text starting from the index position specified
if it contains the <code>startIgnore</code>, and until the
first non letter or digit character is encountered or end of text is
detected.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#ignore(int, java.lang.Character, java.lang.Character)">ignore</A></B>(int index,
java.lang.Character startIgnore,
java.lang.Character endIgnore)</CODE>
<BR>
Ignores or skip over text starting from the index position specified
if it contains the <code>startIgnore</code>, and until the
<code>endIgnore</code> character is encountered or end of text is
detected.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#ignore(int, char, char)">ignore</A></B>(int index,
char startIgnore,
char endIgnore)</CODE>
<BR>
Ignores or skip over text starting from the index position specified
if it contains the <code>startIgnore</code>, and until the
<code>endIgnore</code> character is encountered or end of text is
detected.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#ignore(int, java.lang.String, java.lang.String)">ignore</A></B>(int index,
java.lang.String startIgnore,
java.lang.String endIgnore)</CODE>
<BR>
Ignores or skip over text starting from the index position specified
if it contains the <code>startIgnore</code> string, and until the
<code>endIgnore</code> string is encountered or end of text is
detected.</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/event/AbstractWordFinder.html#init()">init</A></B>()</CODE>
<BR>
Initializes the sentenseIterator</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#isWordChar(char)">isWordChar</A></B>(char c)</CODE>
<BR>
Indicates if the character at the specified character is acceptable as
part of a word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#isWordChar(int)">isWordChar</A></B>(int posn)</CODE>
<BR>
Indicates if the character at the specified position is acceptable as
part of a word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#next()">next</A></B>()</CODE>
<BR>
This method scans the text from the end of the last word, and returns
a new Word object corresponding to the next word.</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/event/AbstractWordFinder.html#replace(java.lang.String)">replace</A></B>(java.lang.String newWord)</CODE>
<BR>
Replace the current word in the search with a replacement string.</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/event/AbstractWordFinder.html#setSentenceIterator(com.swabunga.spell.event.Word)">setSentenceIterator</A></B>(<A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A> wd)</CODE>
<BR>
Adjusts the sentence iterator and the startSentence flag according to the
currentWord.</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/event/AbstractWordFinder.html#setText(java.lang.String)">setText</A></B>(java.lang.String newText)</CODE>
<BR>
Defines the text to search.</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/event/AbstractWordFinder.html#startsSentence()">startsSentence</A></B>()</CODE>
<BR>
Indicates if the current word starts a new sentence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/event/AbstractWordFinder.html#toString()">toString</A></B>()</CODE>
<BR>
Return the text being searched.</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, 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="currentWord"><!-- --></A><H3>
currentWord</H3>
<PRE>
protected <A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A> <B>currentWord</B></PRE>
<DL>
<DD>The word being analyzed
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="nextWord"><!-- --></A><H3>
nextWord</H3>
<PRE>
protected <A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A> <B>nextWord</B></PRE>
<DL>
<DD>The word following the current one
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="startsSentence"><!-- --></A><H3>
startsSentence</H3>
<PRE>
protected boolean <B>startsSentence</B></PRE>
<DL>
<DD>Indicate if the current word starts a new sentence
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="text"><!-- --></A><H3>
text</H3>
<PRE>
protected java.lang.String <B>text</B></PRE>
<DL>
<DD>Holds the text to analyze
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="sentenceIterator"><!-- --></A><H3>
sentenceIterator</H3>
<PRE>
protected java.text.BreakIterator <B>sentenceIterator</B></PRE>
<DL>
<DD>An iterator to work through the sentence
<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="AbstractWordFinder(java.lang.String)"><!-- --></A><H3>
AbstractWordFinder</H3>
<PRE>
public <B>AbstractWordFinder</B>(java.lang.String inText)</PRE>
<DL>
<DD>Creates a new AbstractWordFinder object.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>inText</CODE> - the String to iterate through.</DL>
</DL>
<HR>
<A NAME="AbstractWordFinder()"><!-- --></A><H3>
AbstractWordFinder</H3>
<PRE>
public <B>AbstractWordFinder</B>()</PRE>
<DL>
<DD>Creates a new default AbstractWordFinder object.
<P>
</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="next()"><!-- --></A><H3>
next</H3>
<PRE>
public abstract <A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A> <B>next</B>()</PRE>
<DL>
<DD>This method scans the text from the end of the last word, and returns
a new Word object corresponding to the next word.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html#next()">next</A></CODE> in interface <CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the following word.</DL>
</DD>
</DL>
<HR>
<A NAME="getText()"><!-- --></A><H3>
getText</H3>
<PRE>
public java.lang.String <B>getText</B>()</PRE>
<DL>
<DD>Return the text being searched. May have changed since first set
through calls to replace.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html#getText()">getText</A></CODE> in interface <CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the text being searched.</DL>
</DD>
</DL>
<HR>
<A NAME="setText(java.lang.String)"><!-- --></A><H3>
setText</H3>
<PRE>
public void <B>setText</B>(java.lang.String newText)</PRE>
<DL>
<DD>Defines the text to search.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html#setText(java.lang.String)">setText</A></CODE> in interface <CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newText</CODE> - The text to be analyzed</DL>
</DD>
</DL>
<HR>
<A NAME="current()"><!-- --></A><H3>
current</H3>
<PRE>
public <A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A> <B>current</B>()</PRE>
<DL>
<DD>Returns the current word in the iteration .
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html#current()">current</A></CODE> in interface <CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the current word.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordNotFoundException.html" title="class in com.swabunga.spell.event">WordNotFoundException</A></CODE> - current word has not yet been set.</DL>
</DD>
</DL>
<HR>
<A NAME="hasNext()"><!-- --></A><H3>
hasNext</H3>
<PRE>
public boolean <B>hasNext</B>()</PRE>
<DL>
<DD>Indicates if there is some more word to analyze
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html#hasNext()">hasNext</A></CODE> in interface <CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if there are further words in the string.</DL>
</DD>
</DL>
<HR>
<A NAME="replace(java.lang.String)"><!-- --></A><H3>
replace</H3>
<PRE>
public void <B>replace</B>(java.lang.String newWord)</PRE>
<DL>
<DD>Replace the current word in the search with a replacement string.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html#replace(java.lang.String)">replace</A></CODE> in interface <CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newWord</CODE> - the replacement string.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordNotFoundException.html" title="class in com.swabunga.spell.event">WordNotFoundException</A></CODE> - current word has not yet been set.</DL>
</DD>
</DL>
<HR>
<A NAME="startsSentence()"><!-- --></A><H3>
startsSentence</H3>
<PRE>
public boolean <B>startsSentence</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html#startsSentence()">WordFinder</A></CODE></B></DD>
<DD>Indicates if the current word starts a new sentence.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html#startsSentence()">startsSentence</A></CODE> in interface <CODE><A HREF="../../../../com/swabunga/spell/event/WordFinder.html" title="interface in com.swabunga.spell.event">WordFinder</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the current word starts a new sentence.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/swabunga/spell/event/WordNotFoundException.html" title="class in com.swabunga.spell.event">WordNotFoundException</A></CODE> - current word has not yet been set.</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Return the text being searched. May have changed since first set
through calls to replace.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the text being searched.</DL>
</DD>
</DL>
<HR>
<A NAME="setSentenceIterator(com.swabunga.spell.event.Word)"><!-- --></A><H3>
setSentenceIterator</H3>
<PRE>
protected void <B>setSentenceIterator</B>(<A HREF="../../../../com/swabunga/spell/event/Word.html" title="class in com.swabunga.spell.event">Word</A> wd)</PRE>
<DL>
<DD>Adjusts the sentence iterator and the startSentence flag according to the
currentWord.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>wd</CODE> - the wd parameter is not presently used.</DL>
</DD>
</DL>
<HR>
<A NAME="isWordChar(int)"><!-- --></A><H3>
isWordChar</H3>
<PRE>
protected boolean <B>isWordChar</B>(int posn)</PRE>
<DL>
<DD>Indicates if the character at the specified position is acceptable as
part of a word. To be acceptable, the character need to be a letter
or a digit. It is also acceptable if the character is one of ''', '@',
'.' or '_' and is preceded and followed by letter or digit.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>posn</CODE> - The character position to analyze.
<DT><B>Returns:</B><DD>true if the character is a letter or digit</DL>
</DD>
</DL>
<HR>
<A NAME="isWordChar(char)"><!-- --></A><H3>
isWordChar</H3>
<PRE>
protected boolean <B>isWordChar</B>(char c)</PRE>
<DL>
<DD>Indicates if the character at the specified character is acceptable as
part of a word. To be acceptable, the character need to be a letter
or a digit or a ' (an apostrophe).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c</CODE> - The character to evaluates if it can be part of a word
<DT><B>Returns:</B><DD>true if the character is a letter, digit or a ' (an apostrophe).</DL>
</DD>
</DL>
<HR>
<A NAME="ignore(int, char)"><!-- --></A><H3>
ignore</H3>
<PRE>
protected int <B>ignore</B>(int index,
char startIgnore)</PRE>
<DL>
<DD>Ignores or skip over text starting from the index position specified
if it contains the <code>startIgnore</code>, and until the
first non letter or digit character is encountered or end of text is
detected.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - The start position in text.<DD><CODE>startIgnore</CODE> - The character that should be at <code>index</code>
position to start skipping through.
<DT><B>Returns:</B><DD>The index position pointing after the skipped characters or the
original index if the ignore condition could not be met.</DL>
</DD>
</DL>
<HR>
<A NAME="ignore(int, char, char)"><!-- --></A><H3>
ignore</H3>
<PRE>
protected int <B>ignore</B>(int index,
char startIgnore,
char endIgnore)</PRE>
<DL>
<DD>Ignores or skip over text starting from the index position specified
if it contains the <code>startIgnore</code>, and until the
<code>endIgnore</code> character is encountered or end of text is
detected.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - The start position in text.<DD><CODE>startIgnore</CODE> - The character that should be at <code>index</code>
position to start skipping through.<DD><CODE>endIgnore</CODE> - The character which mark the end of skipping through. If
the value of endIgnore is <code>null</code>, skipping characters stop
at first non letter or digit character.
<DT><B>Returns:</B><DD>The index position pointing after the skipped characters or the
original index if the ignore condition could not be met.</DL>
</DD>
</DL>
<HR>
<A NAME="ignore(int, java.lang.Character, java.lang.Character)"><!-- --></A><H3>
ignore</H3>
<PRE>
protected int <B>ignore</B>(int index,
java.lang.Character startIgnore,
java.lang.Character endIgnore)</PRE>
<DL>
<DD>Ignores or skip over text starting from the index position specified
if it contains the <code>startIgnore</code>, and until the
<code>endIgnore</code> character is encountered or end of text is
detected.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - The start position in text.<DD><CODE>startIgnore</CODE> - The character that should be at <code>index</code>
position to start skipping through.<DD><CODE>endIgnore</CODE> - The character which mark the end of skipping through. If
the value of endIgnore is <code>null</code>, skipping characters stop
at first non letter or digit character.
<DT><B>Returns:</B><DD>The index position pointing after the skipped characters or the
original index if the ignore condition could not be met.</DL>
</DD>
</DL>
<HR>
<A NAME="ignore(int, java.lang.String, java.lang.String)"><!-- --></A><H3>
ignore</H3>
<PRE>
protected int <B>ignore</B>(int index,
java.lang.String startIgnore,
java.lang.String endIgnore)</PRE>
<DL>
<DD>Ignores or skip over text starting from the index position specified
if it contains the <code>startIgnore</code> string, and until the
<code>endIgnore</code> string is encountered or end of text is
detected.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - The start position in text.<DD><CODE>startIgnore</CODE> - The string that should be at <code>index</code>
position to start skipping through.<DD><CODE>endIgnore</CODE> - The string which mark the end of skipping through.
<DT><B>Returns:</B><DD>The index position pointing after the skipped characters or the
original index if the ignore condition could not be met.</DL>
</DD>
</DL>
<HR>
<A NAME="init()"><!-- --></A><H3>
init</H3>
<PRE>
protected void <B>init</B>()</PRE>
<DL>
<DD>Initializes the sentenseIterator
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</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">
PREV CLASS
<A HREF="../../../../com/swabunga/spell/event/AbstractWordTokenizer.html" title="class in com.swabunga.spell.event"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/swabunga/spell/event/AbstractWordFinder.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractWordFinder.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>
|