com.saxonica.expr.sort

Class UCACollator

java.lang.Object

java.text.Collator

com.saxonica.expr.sort.UCACollator

All Implemented Interfaces:

Cloneable, Comparator<Object>

public class UCACollator
extends Collator

Note that in the case that the ICU libraries have not been loaded, then this class is not instantiated. However, the public static functions, e.g. getLocales() could in theory be accessed via an XSLT stylesheet (such as the documentation generators for example) and these invoke ICU features The guard function com.saxonica.config.JavaPlatformPE.hasICUCollator() can be used to check.

Field Summary

Fields inherited from class java.text.Collator

CANONICAL_DECOMPOSITION, FULL_DECOMPOSITION, IDENTICAL, NO_DECOMPOSITION, PRIMARY, SECONDARY, TERTIARY

Constructor Summary

Constructors

Constructor and Description
UCACollator()
UCACollator(String uri)

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(String source, String target)
CollationKey	getCollationKey(String source)
com.ibm.icu.util.ULocale	getLocale()
static String[]	getLocales() Return the locales supported in this version of ICU Note that with Java 6 this method has been known to throw an array index exception from RuleBasedCollator, With Java 7 this performs correctly and getAvailableLocales() does not appear to be invoked from any of the UCA or numbering support.
static String	getUCAVersion() Return the version of UCA supported
int	hashCode()
void	setProps(Properties props) Set the properties for the UCA collation
void	setStrength(int newStrength)
String	show()

Methods inherited from class java.text.Collator

clone, compare, equals, equals, getAvailableLocales, getDecomposition, getInstance, getInstance, getStrength, setDecomposition

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UCACollator

public UCACollator()

UCACollator

public UCACollator(String uri)
            throws XPathException

Throws:

XPathException

Method Detail

getUCAVersion

public static String getUCAVersion()

Return the version of UCA supported

Returns:

UCA version as nn.nn.nn.nn

getLocales

public static String[] getLocales()

Return the locales supported in this version of ICU Note that with Java 6 this method has been known to throw an array index exception from RuleBasedCollator, With Java 7 this performs correctly and getAvailableLocales() does not appear to be invoked from any of the UCA or numbering support.

Returns:

The language tags and display names separated by semicolon

compare

public int compare(String source,
          String target)

Specified by:

compare in class Collator

show

public String show()

getCollationKey

public CollationKey getCollationKey(String source)

Specified by:

getCollationKey in class Collator

hashCode

public int hashCode()

Specified by:

hashCode in class Collator

setProps

public void setProps(Properties props)
              throws XPathException

Set the properties for the UCA collation

Parameters:

props - the set of properties parsed from the UCA parameters

Throws:

XPathException

setStrength

public void setStrength(int newStrength)

Overrides:

setStrength in class Collator

getLocale

public com.ibm.icu.util.ULocale getLocale()