|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.text.Collator
public abstract class Collator
The Collator
class performs locale-sensitive
String
comparison. You use this class to build
searching and sorting routines for natural language text.
Collator
is an abstract base class. Subclasses
implement specific collation strategies. One subclass,
RuleBasedCollator
, is currently provided with
the Java 2 platform and is applicable to a wide set of languages. Other
subclasses may be created to handle more specialized needs.
Like other locale-sensitive classes, you can use the static
factory method, getInstance
, to obtain the appropriate
Collator
object for a given locale. You will only need
to look at the subclasses of Collator
if you need
to understand the details of a particular collation strategy or
if you need to modify that strategy.
The following example shows how to compare two strings using
the Collator
for the default locale.
// Compare two strings in the default locale Collator myCollator = Collator.getInstance(); if( myCollator.compare("abc", "ABC") < 0 ) System.out.println("abc is less than ABC"); else System.out.println("abc is greater than or equal to ABC");
You can set a Collator
's strength property
to determine the level of difference considered significant in
comparisons. Four strengths are provided: PRIMARY
,
SECONDARY
, TERTIARY
, and IDENTICAL
.
The exact assignment of strengths to language features is
locale dependant. For example, in Czech, "e" and "f" are considered
primary differences, while "e" and "�" are secondary differences,
"e" and "E" are tertiary differences and "e" and "e" are identical.
The following shows how both case and accents could be ignored for
US English.
//Get the Collator for US English and set its strength to PRIMARY Collator usCollator = Collator.getInstance(Locale.US); usCollator.setStrength(Collator.PRIMARY); if( usCollator.compare("abc", "ABC") == 0 ) { System.out.println("Strings are equivalent"); }
For comparing String
s exactly once, the compare
method provides the best performance. When sorting a list of
String
s however, it is generally necessary to compare each
String
multiple times. In this case, CollationKey
s
provide better performance. The CollationKey
class converts
a String
to a series of bits that can be compared bitwise
against other CollationKey
s. A CollationKey
is
created by a Collator
object for a given String
.
Note: CollationKey
s from different
Collator
s can not be compared. See the class description
for CollationKey
for an example using CollationKey
s.
RuleBasedCollator
,
CollationKey
,
CollationElementIterator
,
Locale
Field Summary | |
---|---|
static int |
CANONICAL_DECOMPOSITION
Decomposition mode value. |
static int |
FULL_DECOMPOSITION
Decomposition mode value. |
static int |
IDENTICAL
Collator strength value. |
static int |
NO_DECOMPOSITION
Decomposition mode value. |
static int |
PRIMARY
Collator strength value. |
static int |
SECONDARY
Collator strength value. |
static int |
TERTIARY
Collator strength value. |
Constructor Summary | |
---|---|
protected |
Collator()
Default constructor. |
Method Summary | |
---|---|
Object |
clone()
Overrides Cloneable |
int |
compare(Object o1,
Object o2)
Compares its two arguments for order. |
abstract int |
compare(String source,
String target)
Compares the source string to the target string according to the collation rules for this Collator. |
boolean |
equals(Object that)
Compares the equality of two Collators. |
boolean |
equals(String source,
String target)
Convenience method for comparing the equality of two strings based on this Collator's collation rules. |
static Locale[] |
getAvailableLocales()
Returns an array of all locales for which the getInstance methods of this class can return
localized instances. |
abstract CollationKey |
getCollationKey(String source)
Transforms the String into a series of bits that can be compared bitwise to other CollationKeys. |
int |
getDecomposition()
Get the decomposition mode of this Collator. |
static Collator |
getInstance()
Gets the Collator for the current default locale. |
static Collator |
getInstance(Locale desiredLocale)
Gets the Collator for the desired locale. |
int |
getStrength()
Returns this Collator's strength property. |
abstract int |
hashCode()
Generates the hash code for this Collator. |
void |
setDecomposition(int decompositionMode)
Set the decomposition mode of this Collator. |
void |
setStrength(int newStrength)
Sets this Collator's strength property. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int PRIMARY
setStrength(int)
,
getStrength()
,
Constant Field Valuespublic static final int SECONDARY
setStrength(int)
,
getStrength()
,
Constant Field Valuespublic static final int TERTIARY
setStrength(int)
,
getStrength()
,
Constant Field Valuespublic static final int IDENTICAL
public static final int NO_DECOMPOSITION
getDecomposition()
,
setDecomposition(int)
,
Constant Field Valuespublic static final int CANONICAL_DECOMPOSITION
CANONICAL_DECOMPOSITION corresponds to Normalization Form D as described in Unicode Technical Report #15.
getDecomposition()
,
setDecomposition(int)
,
Constant Field Valuespublic static final int FULL_DECOMPOSITION
FULL_DECOMPOSITION corresponds to Normalization Form KD as described in Unicode Technical Report #15.
getDecomposition()
,
setDecomposition(int)
,
Constant Field ValuesConstructor Detail |
---|
protected Collator()
getInstance()
Method Detail |
---|
public static Collator getInstance()
Locale.getDefault()
public static Collator getInstance(Locale desiredLocale)
desiredLocale
- the desired locale.
Locale
,
ResourceBundle
public abstract int compare(String source, String target)
For a one time comparison, this method has the best performance. If a given String will be involved in multiple comparisons, CollationKey.compareTo has the best performance. See the Collator class description for an example using CollationKeys.
source
- the source string.target
- the target string.
CollationKey
,
getCollationKey(java.lang.String)
public int compare(Object o1, Object o2)
This implementation merely returns
compare((String)o1, (String)o2)
.
compare
in interface Comparator<Object>
o1
- the first object to be compared.o2
- the second object to be compared.
ClassCastException
- the arguments cannot be cast to Strings.Comparator
public abstract CollationKey getCollationKey(String source)
source
- the string to be transformed into a collation key.
CollationKey
,
compare(java.lang.String, java.lang.String)
public boolean equals(String source, String target)
source
- the source string to be compared with.target
- the target string to be compared with.
compare(java.lang.String, java.lang.String)
public int getStrength()
setStrength(int)
,
PRIMARY
,
SECONDARY
,
TERTIARY
,
IDENTICAL
public void setStrength(int newStrength)
newStrength
- the new strength value.
IllegalArgumentException
- If the new strength value is not one of
PRIMARY, SECONDARY, TERTIARY or IDENTICAL.getStrength()
,
PRIMARY
,
SECONDARY
,
TERTIARY
,
IDENTICAL
public int getDecomposition()
The three values for decomposition mode are:
setDecomposition(int)
,
NO_DECOMPOSITION
,
CANONICAL_DECOMPOSITION
,
FULL_DECOMPOSITION
public void setDecomposition(int decompositionMode)
decompositionMode
- the new decomposition mode.
IllegalArgumentException
- If the given value is not a valid decomposition
mode.getDecomposition()
,
NO_DECOMPOSITION
,
CANONICAL_DECOMPOSITION
,
FULL_DECOMPOSITION
public static Locale[] getAvailableLocales()
getInstance
methods of this class can return
localized instances.
The array returned must contain at least a Locale
instance equal to Locale.US
.
Collator
instances are available.public Object clone()
clone
in class Object
Cloneable
public boolean equals(Object that)
equals
in interface Comparator<Object>
equals
in class Object
that
- the Collator to be compared with this.
Object.hashCode()
,
Hashtable
public abstract int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
,
Hashtable
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.