com.ibm.icu.text

Class RuleBasedBreakIterator_New

public class RuleBasedBreakIterator_New extends RuleBasedBreakIterator

Rule Based Break Iterator implementation. This is a port of the C++ class RuleBasedBreakIterator from ICU4C. A note on future plans: Once a new DictionaryBasedBreakIterator implementation is completed, the archaic implementation class RuleBasedBreakIterator_Old can be completely removed, and this class can be renamed to be simply RuleBasedBreakIterator.

UNKNOWN:

Field Summary
static booleanfTrace
Debugging flag.
Method Summary
protected static voidcheckOffset(int offset, CharacterIterator text)
Throw IllegalArgumentException unless begin <= offset < end.
Objectclone()
Clones this iterator.
intcurrent()
Returns the current iteration position.
voiddump()
Dump the contents of the state table and character classes for this break iterator.
booleanequals(Object that)
Returns true if both BreakIterators are of the same class, have the same rules, and iterate over the same text.
intfirst()
Sets the current iteration position to the beginning of the text. (i.e., the CharacterIterator's starting offset).
intfollowing(int offset)
Sets the iterator to refer to the first boundary position following the specified position.
static RuleBasedBreakIteratorgetInstanceFromCompiledRules(InputStream is)
Create a break iterator from a precompiled set of rules.
intgetRuleStatus()
Return the status tag from the break rule that determined the most recently returned break position.
intgetRuleStatusVec(int[] fillInArray)
Get the status (tag) values from the break rule(s) that determined the most recently returned break position.
CharacterIteratorgetText()
Return a CharacterIterator over the text being analyzed.
inthashCode()
Compute a hashcode for this BreakIterator
booleanisBoundary(int offset)
Returns true if the specfied position is a boundary position.
intlast()
Sets the current iteration position to the end of the text. (i.e., the CharacterIterator's ending offset).
intnext(int n)
Advances the iterator either forward or backward the specified number of steps.
intnext()
Advances the iterator to the next boundary position.
intpreceding(int offset)
Sets the iterator to refer to the last boundary position before the specified position.
intprevious()
Moves the iterator backwards, to the last boundary preceding this one.
voidsetText(CharacterIterator newText)
Set the iterator to analyze a new piece of text.
StringtoString()
Returns the description (rules) used to create this iterator.

Field Detail

fTrace

public static boolean fTrace
Debugging flag. Trace operation of state machine when true.

UNKNOWN:

Method Detail

checkOffset

protected static final void checkOffset(int offset, CharacterIterator text)
Throw IllegalArgumentException unless begin <= offset < end.

UNKNOWN: ICU 2.0

clone

public Object clone()
Clones this iterator.

Returns: A newly-constructed RuleBasedBreakIterator with the same behavior as this one.

UNKNOWN: ICU 2.0

current

public int current()
Returns the current iteration position.

Returns: The current iteration position.

UNKNOWN: ICU 2.0

dump

public void dump()
Dump the contents of the state table and character classes for this break iterator. For debugging only.

UNKNOWN:

equals

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.

UNKNOWN: ICU 2.0

first

public int first()
Sets the current iteration position to the beginning of the text. (i.e., the CharacterIterator's starting offset).

Returns: The offset of the beginning of the text.

UNKNOWN: ICU 2.0

following

public int following(int offset)
Sets the iterator to refer to the first boundary position following the specified position.

Parameters: offset The position from which to begin searching for a break position.

Returns: The position of the first break after the current position.

UNKNOWN: ICU 2.0

getInstanceFromCompiledRules

public static RuleBasedBreakIterator getInstanceFromCompiledRules(InputStream is)
Create a break iterator from a precompiled set of rules.

UNKNOWN:

getRuleStatus

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.

Of the standard types of ICU break iterators, only the word break iterator provides status values. The values are defined in class RuleBasedBreakIterator, and allow distinguishing between words that contain alphabetic letters, "words" that appear to be numbers, punctuation and spaces, words containing ideographic characters, and more. Call getRuleStatus after obtaining a boundary position from next(), 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.

UNKNOWN: ICU 3.0 This API might change or be removed in a future release.

getRuleStatusVec

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 status values used by the standard ICU break rules are defined as public constants in class RuleBasedBreakIterator.

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.

UNKNOWN: ICU 3.0 This API might change or be removed in a future release.

getText

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.

Returns: An iterator over the text being analyzed.

UNKNOWN: ICU 2.0

hashCode

public int hashCode()
Compute a hashcode for this BreakIterator

Returns: A hash code

UNKNOWN: ICU 2.0

isBoundary

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".

Parameters: offset the offset to check.

Returns: True if "offset" is a boundary position.

UNKNOWN: ICU 2.0

last

public int last()
Sets the current iteration position to the end of the text. (i.e., the CharacterIterator's ending offset).

Returns: The text's past-the-end offset.

UNKNOWN: ICU 2.0

next

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().

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.

UNKNOWN: ICU 2.0

next

public int next()
Advances the iterator to the next boundary position.

Returns: The position of the first boundary after this one.

UNKNOWN: ICU 2.0

preceding

public int preceding(int offset)
Sets the iterator to refer to the last boundary position before the specified position.

Parameters: offset The position to begin searching for a break from.

Returns: The position of the last boundary before the starting position.

UNKNOWN: ICU 2.0

previous

public int previous()
Moves the iterator backwards, to the last boundary preceding this one.

Returns: The position of the last boundary position preceding this one.

UNKNOWN: ICU 2.0

setText

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.

Parameters: newText An iterator over the text to analyze.

UNKNOWN: ICU 2.0

toString

public String toString()
Returns the description (rules) used to create this iterator. (In ICU4C, the same function is RuleBasedBreakIterator::getRules())

UNKNOWN: ICU 2.0

Copyright (c) 2006 IBM Corporation and others.