com.force.i18n.grammar

Class GrammaticalLocalizer

java.lang.Object

com.force.i18n.BaseLocalizer

com.force.i18n.grammar.GrammaticalLocalizer

public class GrammaticalLocalizer
extends BaseLocalizer

A localizer that uses a grammatical label set for processing labels.

Author:

stamm

Nested Class Summary

Nested classes/interfaces inherited from class com.force.i18n.BaseLocalizer

BaseLocalizer.LocalOrGmt

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_NAME

Fields inherited from class com.force.i18n.BaseLocalizer

CHINESE_LANGUAGE, currencyFormat, dateTimeFormat, EARLIEST, ENGLISH_LANGUAGE, GMT, GMT_TZ, gmtDateFormat, gmtTimeFormat, inputDateTimeFormat, inputGmtDateFormat, inputLocalDateFormat, JAPANESE_LANGUAGE, KOREAN_LANGUAGE, labelSet, LATEST, LOCAL, localDateFormat, localLongDateFormat, localTimeFormat, longDateTimeFormat, messageFormatCache, numberFormat, OLD_EARLIEST, OLD_LATEST

Constructor Summary

Constructors

Constructor and Description
GrammaticalLocalizer(Locale locale, Locale currencyLocale, TimeZone timeZone, HumanLanguage language, GrammaticalLabelSet labelSet)

Method Summary

Modifier and Type	Method and Description
Collator	getCollator()
Comparator<String>	getComparator()
Comparator<String>	getComparator(int numElements)
LanguageDeclension	getDeclension() NOTE: This probably shouldn't be here, but for now it's a nice way to kill LabelInfo most places
String	getEmailEncoding()
String	getFileEncoding()
String	getLabel(LabelReference ref)
String	getLabel(String section, Renameable[] entities, String key)
String	getLabel(String section, Renameable[] entities, String key, boolean forMessageFormat)
String	getLabel(String section, Renameable[] entities, String key, Object... args)
String	getLabel(String section, String name)
String	getLabel(String section, String name, boolean forMessageFormat)
String	getLabel(String section, String key, Object... args) Convenience function that calls java.text.MessageFormat.format() on the label using the Object[] supplied.
String	getLabelNoHint(String section, String name) The following getLabelNotHint(*) methods are special cased label lookups, so even while in label debugging mode the current label request WILL NOT appended the label debug info.
String	getLabelNoHint(String section, String name, boolean forMessageFormat)
String	getLabelNoHint(String section, String name, Object... args)
String	getLabelNoThrow(LabelReference ref)
String	getLabelNoThrow(String section, Renameable[] entities, String name)
String	getLabelNoThrow(String section, String name)
String	getLabelNoThrow(String section, String name, Object... args)
GrammaticalLabelSet	getLabelSet()
String	getLabelThrow(String section, String name)
protected Collator	makeCollator()
protected Comparator<String>	makeComparator()

Methods inherited from class com.force.i18n.BaseLocalizer

doParseDate, doParseNumber, doParseTime, formatDate, formatDateTime, getCalendar, getCalendar, getCalendar, getCurrencyFormat, getCurrencyFormat, getCurrencyFormat, getCurrencyFormat, getCurrencyLocale, getDateFormat, getDateTimeFormat, getGmtTimeFormat, getInputDateFormat, getInputDateTimeFormat, getLanguage, getList, getLocale, getLocaleDateFormat, getLocaleDateTimeFormat, getLocaleInputDateFormat, getLocaleInputDateTimeFormat, getLocaleTimeFormat, getLongDateFormat, getLongDateTimeFormat, getMessageFormat, getNumberFormat, getNumberFormat, getNumberFormat, getPercentFormat, getSection, getTimeFormat, getTimeZone, getUserLanguage, isLanguageEnglish, isLanguageJapanese, labelExists, parseCurrency, parseDate, parseDateTime, parseNumber, parsePercent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_NAME

public static final String CONTEXT_NAME

See Also:

Constant Field Values

Constructor Detail

GrammaticalLocalizer

public GrammaticalLocalizer(Locale locale,
                            Locale currencyLocale,
                            TimeZone timeZone,
                            HumanLanguage language,
                            GrammaticalLabelSet labelSet)

Method Detail

getLabelSet

public GrammaticalLabelSet getLabelSet()

Overrides:

getLabelSet in class BaseLocalizer

getDeclension

public LanguageDeclension getDeclension()

NOTE: This probably shouldn't be here, but for now it's a nice way to kill LabelInfo most places

Returns:

the declension for the current language

getEmailEncoding

public String getEmailEncoding()

Returns:

email encoding based on the language for the system emails This is not the same as User's personal email encoding

getFileEncoding

public String getFileEncoding()

getLabel

public String getLabel(String section,
                       String name)

Overrides:

getLabel in class BaseLocalizer

getLabelThrow

public String getLabelThrow(String section,
                            String name)

Overrides:

getLabelThrow in class BaseLocalizer

getLabelNoHint

public String getLabelNoHint(String section,
                             String name)

The following getLabelNotHint(*) methods are special cased label lookups, so even while in label debugging mode the current label request WILL NOT appended the label debug info. This is needed for certain labels which aren't truly displayed as text, but rather are label keys to other labels. Or other weird scenarios where putting the label debug info into the returned String just breaks stuff.

getLabelNoHint

public String getLabelNoHint(String section,
                             String name,
                             Object... args)

getLabelNoHint

public String getLabelNoHint(String section,
                             String name,
                             boolean forMessageFormat)

getLabel

public String getLabel(String section,
                       String key,
                       Object... args)

Convenience function that calls java.text.MessageFormat.format() on the label using the Object[] supplied.

Overrides:

getLabel in class BaseLocalizer

Parameters:

section - same as getLabel(section, key)

key - same as getLabel(section, key)

args - for java.text.MessageFormat.format()

getLabel

public String getLabel(String section,
                       Renameable[] entities,
                       String key)

getLabel

public String getLabel(String section,
                       Renameable[] entities,
                       String key,
                       Object... args)

getLabelNoThrow

public String getLabelNoThrow(String section,
                              String name)

getLabelNoThrow

public String getLabelNoThrow(String section,
                              String name,
                              Object... args)

getLabelNoThrow

public String getLabelNoThrow(String section,
                              Renameable[] entities,
                              String name)

getLabel

public String getLabel(String section,
                       String name,
                       boolean forMessageFormat)

getLabel

public String getLabel(String section,
                       Renameable[] entities,
                       String key,
                       boolean forMessageFormat)

getLabel

public String getLabel(LabelReference ref)

getLabelNoThrow

public String getLabelNoThrow(LabelReference ref)

getCollator

public Collator getCollator()

Returns:

the Collator for the user's locale. Collators are not threadsafe, so don't reuse this across threads

getComparator

public Comparator<String> getComparator()

Returns:

a cached instance of comparator

getComparator

public Comparator<String> getComparator(int numElements)

Parameters:

numElements - the number of elements in the array

Returns:

the Collator for the user's locale

makeCollator

protected Collator makeCollator()

Returns:

an instance of a collator that isn't cached locally

makeComparator

protected Comparator<String> makeComparator()

Returns:

a noncaching comparator that can be reused