com.force.db.i18n

Enum LinguisticSort

java.lang.Object

java.lang.Enum<LinguisticSort>

com.force.db.i18n.LinguisticSort

All Implemented Interfaces:

Serializable, Comparable<LinguisticSort>

public enum LinguisticSort
extends Enum<LinguisticSort>

Contains all of the information about linguistic sorting. The intent of this is to provide the SQL changes to the RDBMS to ensure that the sorting uses the locale provided in Java, and to make sure that the collation in Java will correspond as much as possible to what is in the DB. Rolodex is a feature in alphabetic/syllabary languages to restrict the set of rows in a list to those that start with a certain letter. In SQL this is usually LIKE 'A%', which will include different letters. To get the list of valid nls_sorts, run this in oracle select value from v$nls_valid_values where parameter='SORT';

Author:

stamm

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARABIC
ARMENIAN
AZERBAIJANI
BASQUE
BELARUSIAN
BENGALI
BOSNIAN
BULGARIAN
CATALAN
CHINESE
CHINESE_HK
CHINESE_HK_STROKE
CHINESE_PINYIN
CHINESE_STROKE
CHINESE_TW
CHINESE_TW_STROKE
CROATIAN
CZECH
DANISH
DUTCH
ENGLISH
ESPERANTO
ESTONIAN
FINNISH
FRENCH
GEORGIAN
GERMAN
GREEK
HEBREW
HINDI
HUNGARIAN
ICELANDIC
INDONESIAN
IRISH
ITALIAN
JAPANESE
KAZAKH
KOREAN
KYRGYZ
LATVIAN
LITHUANIAN
LUXEMBOURGISH
MALAY
MALTESE
NORWEGIAN
POLISH
PORTUGUESE
ROMANIAN
ROMANSH
RUSSIAN
SERBIAN_CYRILLIC
SERBIAN_LATIN
SLOVAK
SLOVENE
SPANISH
SWEDISH
TAJIK
TAMIL
THAI
TURKISH
TURKMEN
UKRANIAN
URDU
VIETNAMESE

Method Summary

Modifier and Type	Method and Description
boolean	canUseSnlForRolodex(boolean isPostgres)
static LinguisticSort	get(Locale locale) Get sorting info for the given locale.
String	getAlphabet(int index) Returns the n-th of letter in the rolodex.
int	getAlphabetLength() Returns the number of letters to show in the rolodex.
String	getCollationKeySql(String expr, boolean isPostgres) Returns the sql expression to compute the linguistic sort collation key for the given sql expression.
Collator	getCollator()
Comparator<String>	getComparator(int size)
Collator	getGuaranteedCaseInsensitiveCollator()
Comparator<String>	getNonCachingComparator()
int	getRolodexIndexForChar(String searchTerm) Return the rolodexIndex for a string.
String	getRolodexSql(String expr, int index, boolean isPostgres)
String	getRolodexSql(String expr, int index, SortablePicklistItem[] enumItems, Collection<String> stringArrayBind) Returns the sql expression to filter the given sql expression to values beginning with the n-th of letter in the rolodex or its equivalents.
String	getSnlRolodexSql(String expr, int index, boolean isPostgres)
Collator	getUpperCaseCollator(boolean isPostgres) Apex and possibly other things collate based on upper case versions of strings.
String	getUpperCaseSql(String expr, boolean isPostgres) Returns the sql expression to convert the given sql expression to upper case.
String	getUpperCaseValue(String value, boolean isPostgres) Returns the upper case value of the given value, or what would be the result of applying the sql expression in getUpperCaseSql() to the given value.
String	getUpperCollationKeySql(String expr, boolean isPostgres) Returns the sql expression to compute the linguistic sort collation key for the upper case of given sql expression.
boolean	hasDoubleWidth()
static char	toSingleWidth(char c)
static String	toSingleWidth(String value) Convert double width ascii characters to single width.
boolean	usesUpperToGetUpperCase(boolean isPostgres)
static LinguisticSort	valueOf(String name) Returns the enum constant of this type with the specified name.
static LinguisticSort[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ENGLISH

public static final LinguisticSort ENGLISH

GERMAN

public static final LinguisticSort GERMAN

FRENCH

public static final LinguisticSort FRENCH

ITALIAN

public static final LinguisticSort ITALIAN

SPANISH

public static final LinguisticSort SPANISH

CATALAN

public static final LinguisticSort CATALAN

DUTCH

public static final LinguisticSort DUTCH

PORTUGUESE

public static final LinguisticSort PORTUGUESE

DANISH

public static final LinguisticSort DANISH

NORWEGIAN

public static final LinguisticSort NORWEGIAN

SWEDISH

public static final LinguisticSort SWEDISH

FINNISH

public static final LinguisticSort FINNISH

CZECH

public static final LinguisticSort CZECH

POLISH

public static final LinguisticSort POLISH

TURKISH

public static final LinguisticSort TURKISH

CHINESE_HK

public static final LinguisticSort CHINESE_HK

CHINESE_HK_STROKE

public static final LinguisticSort CHINESE_HK_STROKE

CHINESE_TW

public static final LinguisticSort CHINESE_TW

CHINESE_TW_STROKE

public static final LinguisticSort CHINESE_TW_STROKE

CHINESE

public static final LinguisticSort CHINESE

CHINESE_STROKE

public static final LinguisticSort CHINESE_STROKE

CHINESE_PINYIN

public static final LinguisticSort CHINESE_PINYIN

JAPANESE

public static final LinguisticSort JAPANESE

KOREAN

public static final LinguisticSort KOREAN

RUSSIAN

public static final LinguisticSort RUSSIAN

BULGARIAN

public static final LinguisticSort BULGARIAN

INDONESIAN

public static final LinguisticSort INDONESIAN

ROMANIAN

public static final LinguisticSort ROMANIAN

VIETNAMESE

public static final LinguisticSort VIETNAMESE

UKRANIAN

public static final LinguisticSort UKRANIAN

HUNGARIAN

public static final LinguisticSort HUNGARIAN

GREEK

public static final LinguisticSort GREEK

HEBREW

public static final LinguisticSort HEBREW

SLOVAK

public static final LinguisticSort SLOVAK

SERBIAN_CYRILLIC

public static final LinguisticSort SERBIAN_CYRILLIC

SERBIAN_LATIN

public static final LinguisticSort SERBIAN_LATIN

BOSNIAN

public static final LinguisticSort BOSNIAN

GEORGIAN

public static final LinguisticSort GEORGIAN

BASQUE

public static final LinguisticSort BASQUE

MALTESE

public static final LinguisticSort MALTESE

ROMANSH

public static final LinguisticSort ROMANSH

LUXEMBOURGISH

public static final LinguisticSort LUXEMBOURGISH

IRISH

public static final LinguisticSort IRISH

SLOVENE

public static final LinguisticSort SLOVENE

CROATIAN

public static final LinguisticSort CROATIAN

MALAY

public static final LinguisticSort MALAY

ARABIC

public static final LinguisticSort ARABIC

ESTONIAN

public static final LinguisticSort ESTONIAN

ICELANDIC

public static final LinguisticSort ICELANDIC

LATVIAN

public static final LinguisticSort LATVIAN

LITHUANIAN

public static final LinguisticSort LITHUANIAN

KYRGYZ

public static final LinguisticSort KYRGYZ

KAZAKH

public static final LinguisticSort KAZAKH

TAJIK

public static final LinguisticSort TAJIK

BELARUSIAN

public static final LinguisticSort BELARUSIAN

TURKMEN

public static final LinguisticSort TURKMEN

AZERBAIJANI

public static final LinguisticSort AZERBAIJANI

ARMENIAN

public static final LinguisticSort ARMENIAN

THAI

public static final LinguisticSort THAI

HINDI

public static final LinguisticSort HINDI

URDU

public static final LinguisticSort URDU

BENGALI

public static final LinguisticSort BENGALI

TAMIL

public static final LinguisticSort TAMIL

ESPERANTO

public static final LinguisticSort ESPERANTO

Method Detail

values

public static LinguisticSort[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LinguisticSort c : LinguisticSort.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LinguisticSort valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

get

public static LinguisticSort get(Locale locale)

Get sorting info for the given locale.

hasDoubleWidth

public boolean hasDoubleWidth()

getCollator

public Collator getCollator()

Returns:

a new collator for this LinguisticSort instance.

getGuaranteedCaseInsensitiveCollator

public Collator getGuaranteedCaseInsensitiveCollator()

Returns:

a new collator for this LinguisticSort instance that is guaranteed to be case insensitive. Danish collation, unfortunately, is a little odd, in that "v" and "w" are considered to be the same character. To make up for this, they made "v" and "V" a secondary difference, which makes Enum comparisons in FilterItem a little wonky. http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4174436

getNonCachingComparator

public Comparator<String> getNonCachingComparator()

Returns:

a new comparator for strings for this LinguisticSort instance.

getComparator

public Comparator<String> getComparator(int size)

Parameters:

the - number of elements to compare (default is 16).

Returns:

a new comparator for strings for this LinguisticSort instance.

getAlphabetLength

public int getAlphabetLength()

Returns the number of letters to show in the rolodex.

getAlphabet

public String getAlphabet(int index)

Returns the n-th of letter in the rolodex. Note, a 'letter' in a language be composed of more than one unicode characters, for example, letter 'ch' in Czech.

getRolodexIndexForChar

public int getRolodexIndexForChar(String searchTerm)

Return the rolodexIndex for a string.

Parameters:

searchTerm. - Must be a 1-char string

Returns:

the rolodexIndex, including Other (i.e. getAlphabetLength) if it doesn't fall into a bucket. If this langugage doesn't have a rolodex (e.g. Arabic, Latvian, etc.) return -1

Throws:

IllegalArgumentException - if the string is null or not of length 1

getUpperCaseSql

public String getUpperCaseSql(String expr,
                              boolean isPostgres)

Returns the sql expression to convert the given sql expression to upper case.

usesUpperToGetUpperCase

public boolean usesUpperToGetUpperCase(boolean isPostgres)

Returns:

true if sql UPPER() is used in getUpperCaseSql(). Note that this is always false for postgres because postgres always use the icu_upper() function for all languages.

canUseSnlForRolodex

public boolean canUseSnlForRolodex(boolean isPostgres)

Returns:

true if snl can be used for the rolodex. Currently, this is only true for english on oracle. This is always false for postgres.

getUpperCaseValue

public String getUpperCaseValue(String value,
                                boolean isPostgres)

Returns the upper case value of the given value, or what would be the result of applying the sql expression in getUpperCaseSql() to the given value.

toSingleWidth

public static char toSingleWidth(char c)

toSingleWidth

public static String toSingleWidth(String value)

Convert double width ascii characters to single width. This is the equivalent of Oracle's to_single_byte().

getCollationKeySql

public String getCollationKeySql(String expr,
                                 boolean isPostgres)

Returns the sql expression to compute the linguistic sort collation key for the given sql expression. This supports sorting in the database, where sort order of different upper and lower cases are handled linguistically.

getUpperCollationKeySql

public String getUpperCollationKeySql(String expr,
                                      boolean isPostgres)

Returns the sql expression to compute the linguistic sort collation key for the upper case of given sql expression. This supports case-insensitive filtering in the database.

getRolodexSql

public String getRolodexSql(String expr,
                            int index,
                            SortablePicklistItem[] enumItems,
                            Collection<String> stringArrayBind)

Returns the sql expression to filter the given sql expression to values beginning with the n-th of letter in the rolodex or its equivalents. get all enum items (this must include inactive ones, ie upgradeToAllEnumItems() must have been previously called)

getRolodexSql

public String getRolodexSql(String expr,
                            int index,
                            boolean isPostgres)

getSnlRolodexSql

public String getSnlRolodexSql(String expr,
                               int index,
                               boolean isPostgres)

Returns:

Sql expression for evaluating a rolodex expression against the search name lookup table, to make use of the index.

getUpperCaseCollator

public Collator getUpperCaseCollator(boolean isPostgres)

Apex and possibly other things collate based on upper case versions of strings. Always upper casing and then comparing is slow, though, so this method is intended to return a collator that is consisent with uppper-case-then-compare while perhaps doing something more efficient