Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
com.ibm.icu.text.BreakIterator
com.ibm.icu.text.RuleBasedBreakIterator
public class RuleBasedBreakIterator
extends BreakIterator
Field Summary | |
static int |
|
static int |
|
static int |
|
static int |
|
static int |
|
static int |
|
static int |
|
static int |
|
static int |
|
static int |
|
Fields inherited from class com.ibm.icu.text.BreakIterator | |
DONE , KIND_CHARACTER , KIND_LINE , KIND_SENTENCE , KIND_TITLE , KIND_WORD |
Constructor Summary | |
| |
|
Method Summary | |
Object |
|
int |
|
boolean |
|
int |
|
int |
|
static RuleBasedBreakIterator |
|
int |
|
int |
|
CharacterIterator |
|
int |
|
boolean |
|
int |
|
int |
|
int |
|
int |
|
int |
|
void |
|
String |
|
Methods inherited from class com.ibm.icu.text.BreakIterator | |
clone , current , first , following , getAvailableLocales , getAvailableULocales , getCharacterInstance , getCharacterInstance , getCharacterInstance , getLineInstance , getLineInstance , getLineInstance , getLocale , getSentenceInstance , getSentenceInstance , getSentenceInstance , getText , getTitleInstance , getTitleInstance , getTitleInstance , getWordInstance , getWordInstance , getWordInstance , isBoundary , last , next , next , preceding , previous , registerInstance , registerInstance , setText , setText , unregister |
public static final int WORD_IDEO
Tag value for words containing ideographic characters, lower limit
- Field Value:
- 400
public static final int WORD_IDEO_LIMIT
Tag value for words containing ideographic characters, upper limit
- Field Value:
- 500
public static final int WORD_KANA
Tag value for words containing kana characters, lower limit
- Field Value:
- 300
public static final int WORD_KANA_LIMIT
Tag value for words containing kana characters, upper limit
- Field Value:
- 400
public static final int WORD_LETTER
Tag value for words that contain letters, excluding hiragana, katakana or ideographic characters, lower limit.
- Field Value:
- 200
public static final int WORD_LETTER_LIMIT
Tag value for words containing letters, upper limit
- Field Value:
- 300
public static final int WORD_NONE
Tag value for "words" that do not fit into any of other categories. Includes spaces and most punctuation.
- Field Value:
- 0
public static final int WORD_NONE_LIMIT
Upper bound for tags for uncategorized words.
- Field Value:
- 100
public static final int WORD_NUMBER
Tag value for words that appear to be numbers, lower limit.
- Field Value:
- 100
public static final int WORD_NUMBER_LIMIT
Tag value for words that appear to be numbers, upper limit.
- Field Value:
- 200
protected RuleBasedBreakIterator()
This default constructor is used when creating derived classes of RulesBasedBreakIterator. Not intended for use by normal clients of break iterators.
public RuleBasedBreakIterator(String description)
Constructs a RuleBasedBreakIterator_Old according to the description provided. If the description is malformed, throws an IllegalArgumentException. Normally, instead of constructing a RuleBasedBreakIterator_Old directory, you'll use the factory methods on BreakIterator to create one indirectly from a description in the framework's resource files. You'd use this when you want special behavior not provided by the built-in iterators.
public Object clone()
Clones this iterator.
- Overrides:
- clone in interface BreakIterator
- Returns:
- A newly-constructed RuleBasedBreakIterator with the same behavior as this one.
public int current()
Returns the current iteration position.
- Overrides:
- current in interface BreakIterator
- Returns:
- The current iteration position.
public boolean equals(Object that)
Returns true if both BreakIterators are of the same class, have the same rules, and iterate over the same text.
public int first()
Sets the current iteration position to the beginning of the text. (i.e., the CharacterIterator's starting offset).
- Overrides:
- first in interface BreakIterator
- Returns:
- The offset of the beginning of the text.
public int following(int offset)
Sets the iterator to refer to the first boundary position following the specified position.
- Overrides:
- following in interface BreakIterator
- Parameters:
offset
- The position from which to begin searching for a break position.
- Returns:
- The position of the first break after the current position.
public static RuleBasedBreakIterator getInstanceFromCompiledRules(InputStream is) throws IOException
Get a break iterator based on a set of pre-compiled break rules.
- Parameters:
is
- An input stream that supplies the compiled rule data. The format of the rule data on the stream is that of a rule data file produced by the ICU4C tool "genbrk".
- Returns:
- A RuleBasedBreakIterator based on the supplied break rules.
public int getRuleStatus()
Return the status tag from the break rule that determined the most recently returned break position. The values appear in the rule source within brackets, {123}, for example. For rules that do not specify a status, a default value of 0 is returned. If more than one rule applies, the numerically largest of the possible status values is returned. The values used by the standard ICU break rules are defined as constants in this class, and allow distinguishing between words that contain alphabetic letters, "words" that appear to be numbers, punctuation and spaces, words containing ideographic characters, and more. CallgetRuleStatus
after obtaining a boundary position fromnext()
,
previous()
, or any other break iterator functions that returns a boundary position.
- Returns:
- the status from the break rule that determined the most recently returned break position.
public int getRuleStatusVec(int[] fillInArray)
Get the status (tag) values from the break rule(s) that determined the most recently returned break position. The values appear in the rule source within brackets, {123}, for example. The default status value for rules that do not explicitly provide one is zero. The values used by the standard ICU rules are defined as contants in this class. If the size of the output array is insufficient to hold the data, the output will be truncated to the available length. No exception will be thrown.
- Parameters:
fillInArray
- an array to be filled in with the status values.
- Returns:
- The number of rule status values from rules that determined the most recent boundary returned by the break iterator. In the event that the array is too small, the return value is the total number of status values that were available, not the reduced number that were actually returned.
public CharacterIterator getText()
Return a CharacterIterator over the text being analyzed. This version of this method returns the actual CharacterIterator we're using internally. Changing the state of this iterator can have undefined consequences. If you need to change it, clone it first.
- Overrides:
- getText in interface BreakIterator
- Returns:
- An iterator over the text being analyzed.
public int hashCode()
Compute a hashcode for this BreakIterator
- Returns:
- A hash code
public boolean isBoundary(int offset)
Returns true if the specfied position is a boundary position. As a side effect, leaves the iterator pointing to the first boundary position at or after "offset".
- Overrides:
- isBoundary in interface BreakIterator
- Parameters:
offset
- the offset to check.
- Returns:
- True if "offset" is a boundary position.
public int last()
Sets the current iteration position to the end of the text. (i.e., the CharacterIterator's ending offset).
- Overrides:
- last in interface BreakIterator
- Returns:
- The text's past-the-end offset.
public int next()
Advances the iterator to the next boundary position.
- Overrides:
- next in interface BreakIterator
- Returns:
- The position of the first boundary after this one.
public int next(int n)
Advances the iterator either forward or backward the specified number of steps. Negative values move backward, and positive values move forward. This is equivalent to repeatedly calling next() or previous().
- Overrides:
- next in interface BreakIterator
- Parameters:
n
- The number of steps to move. The sign indicates the direction (negative is backwards, and positive is forwards).
- Returns:
- The character offset of the boundary position n boundaries away from the current one.
public int preceding(int offset)
Sets the iterator to refer to the last boundary position before the specified position.
- Overrides:
- preceding in interface BreakIterator
- Parameters:
offset
- The position to begin searching for a break from.
- Returns:
- The position of the last boundary before the starting position.
public int previous()
Advances the iterator backwards, to the last boundary preceding this one.
- Overrides:
- previous in interface BreakIterator
- Returns:
- The position of the last boundary position preceding this one.
public void setText(CharacterIterator newText)
Set the iterator to analyze a new piece of text. This function resets the current iteration position to the beginning of the text.
- Overrides:
- setText in interface BreakIterator
- Parameters:
newText
- An iterator over the text to analyze.
public String toString()
Returns the description used to create this iterator