com.force.i18n

Interface HumanLanguage

All Superinterfaces:

Serializable

public interface HumanLanguage
extends Serializable

Interface for a Human Spoken Language, into which an application should be localized. The assumption is that an enum (or enum-like object) will be created to support the set of supported languages. Usually there is a mapping from the language field of a locale to one of these languages, but due to regional variation, a company may want to use a full locale to represent the human language, especially for variants in Spanish, Portugese, German, and Chinese. For the override html language, see this page: http://www.w3.org/International/articles/bcp47/

Author:

stamm

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HumanLanguage.Helper Helper methods for implementations of HumanLanguage.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDefaultFileEncoding()
String	getDefaultLabelDirectoryPath()
String	getDefaultUserEmailEncoding() Return the user email encoding, which differs from the email encoding for Thai and Korean for reasons I don't understand.
TextDirection	getDirection()
HumanLanguage	getFallbackLanguage() NOTE: You must ensure that the fallback language returned has a lower ordinal than this language in the enum (i.e.
String	getHttpLanguageCode()
String	getLabelKey()
Locale	getLocale()
String	getLocaleString()
String	getOverrideLanguage()
String	getSystemEmailEncoding()
HumanLanguage	getTranslationFallbackLanguage()
boolean	hasTurkicCaseFolding()
int	ordinal()
boolean	shouldLogFallbackStrings()
String	toFoldedCase(String input) Return the value with the "case folded" using the unicode algorithm for lowercase based on the current user language

Method Detail

getLocale

Locale getLocale()

Returns:

the locale associated with this user language

getLocaleString

String getLocaleString()

Returns:

the string for the locale associated with this user language (convenience method)

getDirection

TextDirection getDirection()

Returns:

the text direction of the language (right now just RightToLeft vs LeftToRight)

getOverrideLanguage

String getOverrideLanguage()

Returns:

the "override" language for historical reasons. Generally, this means that the locale for the language was wrong (dutch), or Java prevents it from being correct (iw vs he)

getHttpLanguageCode

String getHttpLanguageCode()

Returns:

the language code to use for HTTP communication (see RFC 1766)

getDefaultLabelDirectoryPath

String getDefaultLabelDirectoryPath()

Returns:

the path, relative to a "base" directory of labels where the labels for this particular language will be found. This handles the special cases for Dutch, English, and Simplified Chinese

getDefaultFileEncoding

String getDefaultFileEncoding()

Returns:

the default language encoding charset to use for the language

getDefaultUserEmailEncoding

String getDefaultUserEmailEncoding()

Return the user email encoding, which differs from the email encoding for Thai and Korean for reasons I don't understand. TODO: Why is this different from alternate? Really. What the hell

Returns:

the default user email encoding charset to use for the language

getSystemEmailEncoding

String getSystemEmailEncoding()

Returns:

the email encoding to use when sending out emails in the given language Same as file encoding, except it wants to use UTF-8 whenever possible, unlike user emails.

getTranslationFallbackLanguage

HumanLanguage getTranslationFallbackLanguage()

Returns:

the language to use as the fallback language for translations The difference between this and fallback language is what the "fallback" for translations. So French doesn't fall back to English, because that would be wrong, just the fallback for _XX languages. This is only used for customer translations. Summary: Use this only for country language variants, not for anything else.

getFallbackLanguage

HumanLanguage getFallbackLanguage()

NOTE: You must ensure that the fallback language returned has a lower ordinal than this language in the enum (i.e. the extension language needs to appear afterwards if it's an enum). Note, this is usually the same as translationfallbackLanguage, and only differs for mutually intelligible languages, like Malay and Indonesian

Returns:

the language to use as the fallback language for labels that are not available in this language

shouldLogFallbackStrings

boolean shouldLogFallbackStrings()

Returns:

whether use of fallback strings in this language should be considered a problem. Note: this should only applies to non-fully translated languages that don't have a fallback to a "normal" language.

getLabelKey

String getLabelKey()

Returns:

the key for the label in the LanguageName and TranslatedLabelName label section. This differs only to handle the en_US and nl_NL historical anomalies

hasTurkicCaseFolding

boolean hasTurkicCaseFolding()

Returns:

whether turkish locale specific case folding should be used to handle the dotted/dotless i problem.

toFoldedCase

String toFoldedCase(String input)

Return the value with the "case folded" using the unicode algorithm for lowercase based on the current user language

Parameters:

input - the string to be case folded (i.e. lowercased)

Returns:

the string with converted to lowercase

See Also:

CaseFolder.toFoldedCase(String, boolean)

equals

boolean equals(Object o)

Overrides:

equals in class Object

Returns:

true if the object Note: this library assumes that the set of human languages is finite and established at the beginning of the application lifecycle (like an Enum). So equality comparisons in this library may be made using ==.

ordinal

int ordinal()

Returns:

an integer that represents this language in the total set of human values. The ordering of languages should be by ordinal. The "List" returned by the LanguageProvider.getAll() requires the ordinal is the index in that list. Note: this does assume that an Enum implements HumanLanguage. I would recommend this. In any case, t