 |
Chapter 16 The java.text Package |
 |
|
Chapter 16 The java.text Package |
|
java.text.RuleBasedCollator
java.text.Collator
None
None
New as of JDK 1.1
The RuleBasedCollator class is a concrete subclass of Collator that can compare strings using a table of rules. The rules for many locales already exist. To get a useful Collator for a given locale, use the getInstance(Locale) factory method of Collator.
If you need a special-purpose Collator or a Collator for a new locale, you can create your own RuleBasedCollator from a string that represents the rules. The rules are expressed in three primary forms:
[relation] [text] [reset] [text] [modifier]
The rules can be chained together. The only modifier is the @ character, which specifies that all diacriticals are sorted backwards, as in French.
The valid relations are:
Greater than as a primary difference
Greater than as a secondary difference or difference in accent
Greater than as a tertiary difference or difference in case
Equal
For example "<a<b" is two chained rules that state that 'a' is greater than all ignorable characters, and 'b' is greater than 'a'. To expand this rule to include capitals, use "<a,A<b,B".
A reset, specified by the & character, is used to insert rules in an existing list of chained rules. For example, we can add a rule to sort 'e' with an umlaut (Unicode 0308) after plain 'e'. The existing rules might look like "<a<b<c<d<e<f". We can add the following reset, "&e;e\u0308", so that the complete rule table looks like "<a<b<c<d<e<f&e;e\u0308".
public class java.text.RuleBasedCollator extends java.text.Collator {
// Constructors
public RuleBasedCollator(String rules);
// Instance Methods
public Object clone();
public int compare(String source, String target);
public boolean equals(Object obj);
public CollationElementIterator
getCollationElementIterator( String source);
public CollationKey getCollationKey(String source);
public String getRules();
public int hashCode();
}
A string that contains the rules.
If the given rules are incorrectly formed.
This constructor creates a RuleBasedCollator with the given rules.
A copy of this RuledBasedCollator.
Collator.clone()
This method creates a copy of this RuledBasedCollator and returns it.
The source string.
The target string.
-1 if source is less than target, 0 if the strings are equal, or 1 if source is greater than target.
Collator.compare()
This method compares the given strings according to the rules for this RuleBasedCollator and returns a value that indicates their relationship. If either of the strings are compared more than once, a CollationKey should be used instead.
The object to be compared with this object.
true if the objects are equal; false if they are not.
Collator.equals()
This method returns true if obj is an instance of RuleBasedCollator and is equivalent to this RuleBasedCollator.
public CollationElementIterator getCollationElementIterator( String source)
The source string.
A CollationElementIterator for the given string.
This method generates a CollationElementIterator for the given string.
The source string.
A CollationKey for the given string.
Collator.getCollationKey()
This method generates a CollationKey for the given string. The returned object can be compared with other CollationKey objects using CollationKey.compareTo(). This comparison is faster than using RuleBasedCollator.compare(), so if the same string is used for many comparisons, you should use CollationKey objects.
The rules string for this RuleBasedCollator.
This method returns a string that contains the rules that this RuleBasedCollator is using.
A hashcode for this object.
Collator.hashCode()
This method returns a hashcode for this RuleBasedCollator.
| Method | Inherited From | Method | Inherited From |
|---|---|---|---|
|
equals(String, String) |
Collator |
finalize() |
Object |
|
getClass() |
Object |
getDecomposition() |
Collator |
|
getStrength() |
Collator |
notify() |
Object |
|
notifyAll() |
Object |
setDecomposition(int) |
Collator |
|
setStrength(int) |
Collator |
toString() |
Object |
|
wait() |
Object |
wait(long) |
Object |
|
wait(long, int) |
Object |
CollationKey, CollationElementIterator, Collator, Locale, ParseException, String
|
 |
|
| ParsePosition |  |
SimpleDateFormat |
| This HTML Help has been published using the chm2web software. |