OSDN Git Service

913ec6c00390f124b6d0ac78fda373bd67b2ca47
[neighbornote/NeighborNote.git] / src / com / swabunga / spell / event / WordTokenizer.java
1 /*\r
2 Jazzy - a Java library for Spell Checking\r
3 Copyright (C) 2001 Mindaugas Idzelis\r
4 Full text of license can be found in LICENSE.txt\r
5 \r
6 This library is free software; you can redistribute it and/or\r
7 modify it under the terms of the GNU Lesser General Public\r
8 License as published by the Free Software Foundation; either\r
9 version 2.1 of the License, or (at your option) any later version.\r
10 \r
11 This library is distributed in the hope that it will be useful,\r
12 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\r
14 Lesser General Public License for more details.\r
15 \r
16 You should have received a copy of the GNU Lesser General Public\r
17 License along with this library; if not, write to the Free Software\r
18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA\r
19 */\r
20 package com.swabunga.spell.event;\r
21 \r
22 /**\r
23  * <p>An interface for objects which take a text-based media as input, and iterate through\r
24  * the words in the text stored in that media. Examples of such media could be Strings,\r
25  * Documents, Files, TextComponents etc.\r
26  * </P>\r
27  *\r
28  * <P>\r
29  * When the object is instantiated, and before the first call to <CODE>next()</CODE> is made,\r
30  * the following methods should throw a <CODE>WordNotFoundException</CODE>:<br>\r
31  * <CODE>getCurrentWordEnd()</CODE>, <CODE>getCurrentWordPosition()</CODE>,\r
32  *  <CODE>isNewSentence()</CODE> and <CODE>replaceWord()</CODE>.\r
33  * </P>\r
34  *\r
35  * <P>A call to <CODE>next()</CODE> when <CODE>hasMoreWords()</CODE> returns false\r
36  * should throw a <CODE>WordNotFoundException</CODE>.</P>\r
37  * @author Jason Height (jheight@chariot.net.au)\r
38  */\r
39 public interface WordTokenizer {\r
40 \r
41   //~ Methods .................................................................\r
42 \r
43   /**\r
44    * Returns the context text that is being tokenized (should include any\r
45    * changes that have been made).\r
46    * @return the text being searched.\r
47    */\r
48   public String getContext();\r
49 \r
50   /**\r
51    * Returns the number of word tokens that have been processed thus far\r
52    * @return the number of words found so far.\r
53    */\r
54   public int getCurrentWordCount();\r
55 \r
56   /**\r
57    * Returns an index representing the end location of the current word in the text.\r
58    * @return index of the end of the current word in the text.\r
59    * @throws WordNotFoundException current word has not yet been set.\r
60    */\r
61   public int getCurrentWordEnd();\r
62 \r
63   /**\r
64    * Returns an index representing the start location of the current word in the text.\r
65    * @return index of the start of the current word in the text.\r
66    * @throws WordNotFoundException current word has not yet been set.\r
67    */\r
68   public int getCurrentWordPosition();\r
69 \r
70   /**\r
71    * Returns true if the current word is at the start of a sentence\r
72    * @return true if the current word starts a sentence.\r
73    * @throws WordNotFoundException current word has not yet been set.\r
74    */\r
75   public boolean isNewSentence();\r
76 \r
77   /**\r
78    * Indicates if there are more words left\r
79    * @return true if more words can be found in the text.\r
80    */\r
81   public boolean hasMoreWords();\r
82 \r
83   /**\r
84    * This returns the next word in the iteration. Note that any implementation should return\r
85    * the current word, and then replace the current word with the next word found in the\r
86    * input text (if one exists).\r
87    * @return the next word in the iteration.\r
88    * @throws WordNotFoundException search string contains no more words.\r
89    */\r
90   public String nextWord();\r
91 \r
92   /**\r
93    * Replaces the current word token\r
94    *\r
95    * <p/>\r
96    * When a word is replaced care should be taken that the WordTokenizer\r
97    * repositions itself such that the words that were added aren't rechecked.\r
98    * Of course this is not mandatory, maybe there is a case when an\r
99    * application doesn't need to do this.\r
100    * <p/>\r
101    * @param newWord the string which should replace the current word.\r
102    * @throws WordNotFoundException current word has not yet been set.\r
103    */\r
104   public void replaceWord(String newWord);\r
105 }