ru.curs.lyra.kernel.grid

Class LyraCollationElementIterator

java.lang.Object

ru.curs.lyra.kernel.grid.LyraCollationElementIterator

public class LyraCollationElementIterator
extends Object

This class is used as an iterator to walk through each character of an international string. Use the iterator to return the ordering priority of the positioned character. The ordering priority of a character, which we refer to as a key, defines how a character is collated in the given collation object.

Method Summary

Modifier and Type	Method and Description
boolean	next() Move to the next collation element.
int	primaryOrder() Primary order of current collation element.
int	secondaryOrder() Secondary order of current collation element.
int	tertiaryOrder() Ternary order of current collation element.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

next

public boolean next()
             throws ru.curs.lyra.kernel.grid.LyraCollatorException

Move to the next collation element.

Returns:

false if the end of the string is reached.

Throws:

LyraCollatorException - for unknown character.

primaryOrder

public int primaryOrder()

Primary order of current collation element.

secondaryOrder

public int secondaryOrder()

Secondary order of current collation element.

tertiaryOrder

public int tertiaryOrder()

Ternary order of current collation element.