| java.lang.Object
 java.text.Collator
java.text.RuleBasedCollator
| RuleBasedCollator | | public class RuleBasedCollator extends Collator (Code) | | RuleBasedCollator is a concrete subclass of
Collator. It allows customization of the
Collator via user-specified rule sets.
RuleBasedCollator is designed to be fully compliant to the Unicode Collation
Algorithm (UCA) and conforms to ISO 14651.
Create a RuleBasedCollator from a locale by calling the
getInstance(Locale) factory method in the base class
Collator.Collator.getInstance(Locale) creates
a RuleBasedCollator object based on the collation rules
defined by the argument locale. If a customized collation is required, use
the RuleBasedCollator(String) constructor with the appropriate
rules. The customized RuleBasedCollator will base its ordering
on UCA, while re-adjusting the attributes and orders of the characters in the
specified rule accordingly.
|
| RuleBasedCollator | | RuleBasedCollator(com.ibm.icu.text.Collator wrapper)(Code) | | |
| RuleBasedCollator | | public RuleBasedCollator(String rules) throws ParseException(Code) | | Constructs a new instance of RuleBasedCollator using the
specified rules.
Parameters:
rules - the collation rules.
throws:
ParseException - when the rules contains an invalid collation rule syntax. |
| clone | | public Object clone()(Code) | | Obtains the cloned object of the RuleBasedCollator
the cloned object of the RuleBasedCollator |
| compare | | public int compare(String source, String target)(Code) | | Compares the source text String to the
target text String according to the
collation rules, strength and decomposition mode for this
RuleBasedCollator. See the Collator class
description for an example of use.
General recommendation: If comparisons are to be done to the same String
multiple times, it would be more efficient to generate
CollationKeys for the String s and use
CollationKey.compareTo(CollationKey) for the comparisons.
If the each Strings are compared to only once, using the method
RuleBasedCollator.compare(String, String) will have a better performance.
Parameters:
source - the source text
Parameters:
target - the target text an integer which may be a negative value, zero, or else apositive value depending on whether source is lessthan, equivalent to, or greater than target. |
| equals | | public boolean equals(Object obj)(Code) | | Compares the equality of two RuleBasedCollator objects.
RuleBasedCollator objects are equal if they have the same
collation rules and the same attributes.
Parameters:
obj - the other object. true if this RuleBasedCollator hasexactly the same collation behaviour as obj, falseotherwise. |
| getCollationElementIterator | | public CollationElementIterator getCollationElementIterator(CharacterIterator source)(Code) | | Obtains a CollationElementIterator for the given
CharacterIterator. The source iterator's integrity will
be preserved since a new copy will be created for use.
Parameters:
source - the specified source a CollationElementIterator for the source. |
| getCollationElementIterator | | public CollationElementIterator getCollationElementIterator(String source)(Code) | | Obtains a CollationElementIterator for the given String.
Parameters:
source - the specified source a CollationElementIterator for the given String |
| getCollationKey | | public CollationKey getCollationKey(String source)(Code) | | Obtains the CollationKey for the given source text.
Parameters:
source - the specified source text the CollationKey for the given source text. |
| getRules | | public String getRules()(Code) | | Obtains the collation rules of the RuleBasedCollator.
the collation rules. |
| hashCode | | public int hashCode()(Code) | | Obtains a unique hash code for the RuleBasedCollator
the hash code for the RuleBasedCollator |
|
|