BaseLocalizer (Test 0.0.6 API)

java.lang.Object
- com.force.i18n.BaseLocalizer

Direct Known Subclasses:

GrammaticalLocalizer
```
public class BaseLocalizer
extends Object
```
An internationalization and localization utility class Handles locale specific parsing and formatting

Author:

pnakada, smawson

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseLocalizer.LocalOrGmt
Simple enum + convenience methods for asking Date questions in Local or GMT.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseLocalizer.LocalOrGmt` Simple enum + convenience methods for asking Date questions in Local or GMT.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHINESE_LANGUAGE`
`protected NumberFormat`	`currencyFormat`
`protected DateFormat`	`dateTimeFormat`
`static Date`	`EARLIEST`
`static String`	`ENGLISH_LANGUAGE`
`static BaseLocalizer.LocalOrGmt`	`GMT`
`static TimeZone`	`GMT_TZ`
`protected DateFormat`	`gmtDateFormat` these elements aren't initialized on construction.
`protected DateFormat`	`gmtTimeFormat`
`protected DateFormat`	`inputDateTimeFormat`
`protected DateFormat`	`inputGmtDateFormat`
`protected DateFormat`	`inputLocalDateFormat`
`static String`	`JAPANESE_LANGUAGE`
`static String`	`KOREAN_LANGUAGE`
`protected SharedLabelSet`	`labelSet`
`static Date`	`LATEST`
`static BaseLocalizer.LocalOrGmt`	`LOCAL`
`protected DateFormat`	`localDateFormat`
`protected DateFormat`	`localLongDateFormat`
`protected DateFormat`	`localTimeFormat`
`protected DateFormat`	`longDateTimeFormat`
`protected LruCache<String,MessageFormat>`	`messageFormatCache`
`protected NumberFormat`	`numberFormat`
`static Date`	`OLD_EARLIEST`
`static Date`	`OLD_LATEST`

Constructor Summary

Constructors
Constructor and Description
`BaseLocalizer(Locale locale, Locale currencyLocale, TimeZone timeZone, HumanLanguage language, SharedLabelSet labelSet)` This constructor is used to create a BaseLocalizer

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Date`	`doParseDate(String input, DateFormat df)` Parse the given input string using the given format, and make sure the entire string is used up during the parsing and garbage text at the end is not allowed.
`static Number`	`doParseNumber(String input, NumberFormat nf)` Parse the given input string using the given format, and make sure the entire string is used up during the parsing and garbage text at the end is not allowed.
`static Date`	`doParseTime(String input, DateFormat tf)` parse a time (or date really), but you should use doParseDate for dates as it does some extra stuff
`String`	`formatDate(Date date, BaseLocalizer.LocalOrGmt tz)` Formats a date-only Date.
`String`	`formatDateTime(Date date)` Formats a date-time Date.
`Calendar`	`getCalendar(BaseLocalizer.LocalOrGmt tz)`
`Calendar`	`getCalendar(Locale l)`
`Calendar`	`getCalendar(TimeZone tz)`
`NumberFormat`	`getCurrencyFormat()` Gets a NumberFormat for currency, using the default settings for the Locale.
`NumberFormat`	`getCurrencyFormat(int scale)` Gets a NumberFormat for currency, using the given precision and scale settings.
`protected NumberFormat`	`getCurrencyFormat(Locale currLocale)`
`protected NumberFormat`	`getCurrencyFormat(Locale currLocale, int scale)`
`Locale`	`getCurrencyLocale()`
`DateFormat`	`getDateFormat(BaseLocalizer.LocalOrGmt tz)` Get date-only DateFormat for output.
`DateFormat`	`getDateTimeFormat()` Get date-time DateFormat for output.
`DateFormat`	`getGmtTimeFormat()` Get time-only DateFormat for output.
`DateFormat`	`getInputDateFormat(BaseLocalizer.LocalOrGmt tz)` Get date-only DateFormat for input.
`DateFormat`	`getInputDateTimeFormat()` Get date-time DateFormat for input.
`String`	`getLabel(String section, String name)`
`String`	`getLabel(String section, String key, Object... args)` Convenience function that calls `java.text.MessageFormat.format()` on the label using the `Object[]` supplied.
`SharedLabelSet`	`getLabelSet()`
`String`	`getLabelThrow(String section, String name)`
`Locale`	`getLanguage()`
`List<String>`	`getList(String section, String baseName)`
`Locale`	`getLocale()` Retrieve the locale associated with this localizer.
`static DateFormat`	`getLocaleDateFormat(Locale locale, TimeZone tz)` Static method to get date-only DateFormat for output.
`static DateFormat`	`getLocaleDateTimeFormat(Locale locale, TimeZone tz)` Static method to get date-time DateFormat for output.
`static DateFormat`	`getLocaleInputDateFormat(Locale locale, TimeZone tz)` Static method to get date-only DateFormat for input.
`static DateFormat`	`getLocaleInputDateTimeFormat(Locale locale, TimeZone tz)` Static method to get date-time DateFormat for input.
`static DateFormat`	`getLocaleTimeFormat(Locale locale, TimeZone tz)` This form of getLocalDateTimeFormat is used to render times in a specific locale.
`DateFormat`	`getLongDateFormat()` Get date-only DateFormat for output.
`DateFormat`	`getLongDateTimeFormat()` Get date-time DateFormat for output.
`MessageFormat`	`getMessageFormat(String pattern)`
`NumberFormat`	`getNumberFormat()` Gets a NumberFormat, using the default settings for the Locale.
`NumberFormat`	`getNumberFormat(int scale, boolean scaleSpecified)` Gets a NumberFormat, using the given precision and scale settings.
`NumberFormat`	`getNumberFormat(int precision, int scale)` Return the number format for the locale with the given precision and scale
`NumberFormat`	`getPercentFormat()` Gets a NumberFormat for percentage, using the default settings for the Locale.
`Map<String,Object>`	`getSection(String section)` Returns a map containing the contents of an entire label section, or null if the section does not exist.
`DateFormat`	`getTimeFormat()` Get time-only DateFormat for output.
`TimeZone`	`getTimeZone()`
`HumanLanguage`	`getUserLanguage()`
`static boolean`	`isLanguageEnglish(Locale locale)`
`static boolean`	`isLanguageJapanese(Locale locale)`
`boolean`	`labelExists(String section, String name)`
`Number`	`parseCurrency(String s)` Parse the string as currency.
`Date`	`parseDate(String input, BaseLocalizer.LocalOrGmt tz)` Parses a date-only input string.
`Date`	`parseDateTime(String input)` Parses a date-time input string.
`Number`	`parseNumber(String s)` Parse the string as a number.
`Number`	`parsePercent(String s)` Parse the string as percentage.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOCAL
```
public static final BaseLocalizer.LocalOrGmt LOCAL
```
  - GMT
```
public static final BaseLocalizer.LocalOrGmt GMT
```
  - GMT_TZ
```
public static final TimeZone GMT_TZ
```
  - EARLIEST
```
public static final Date EARLIEST
```
  - LATEST
```
public static final Date LATEST
```
  - OLD_EARLIEST
```
public static final Date OLD_EARLIEST
```
  - OLD_LATEST
```
public static final Date OLD_LATEST
```
  - labelSet
```
protected SharedLabelSet labelSet
```
  - gmtDateFormat
```
protected DateFormat gmtDateFormat
```
    these elements aren't initialized on construction. They are created once the first time they are accessed
  - localDateFormat
```
protected DateFormat localDateFormat
```
  - localLongDateFormat
```
protected DateFormat localLongDateFormat
```
  - gmtTimeFormat
```
protected DateFormat gmtTimeFormat
```
  - localTimeFormat
```
protected DateFormat localTimeFormat
```
  - dateTimeFormat
```
protected DateFormat dateTimeFormat
```
  - longDateTimeFormat
```
protected DateFormat longDateTimeFormat
```
  - inputGmtDateFormat
```
protected DateFormat inputGmtDateFormat
```
  - inputLocalDateFormat
```
protected DateFormat inputLocalDateFormat
```
  - inputDateTimeFormat
```
protected DateFormat inputDateTimeFormat
```
  - numberFormat
```
protected NumberFormat numberFormat
```
  - currencyFormat
```
protected NumberFormat currencyFormat
```
  - messageFormatCache
```
protected final LruCache<String,MessageFormat> messageFormatCache
```
  - ENGLISH_LANGUAGE
```
public static final String ENGLISH_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - KOREAN_LANGUAGE
```
public static final String KOREAN_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - JAPANESE_LANGUAGE
```
public static final String JAPANESE_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - CHINESE_LANGUAGE
```
public static final String CHINESE_LANGUAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseLocalizer
```
public BaseLocalizer(Locale locale,
                     Locale currencyLocale,
                     TimeZone timeZone,
                     HumanLanguage language,
                     SharedLabelSet labelSet)
```
    This constructor is used to create a BaseLocalizer
    
    Parameters:
    
    locale - is the user's locale data
    
    currencyLocale - is org's currency locale ,
- Method Detail
  - getLabelSet
```
public SharedLabelSet getLabelSet()
```
  - getCalendar
```
public Calendar getCalendar(BaseLocalizer.LocalOrGmt tz)
```
  - getCalendar
```
public Calendar getCalendar(TimeZone tz)
```
  - getCalendar
```
public Calendar getCalendar(Locale l)
```
  - parseDate
```
public Date parseDate(String input,
                      BaseLocalizer.LocalOrGmt tz)
               throws ParseException
```
    Parses a date-only input string. Caller specified time zone. Handles 2-digit, 4-digit, single-digit years, out-of-bounds years, and trailing garbage in input string.
    
    Throws:
    
    ParseException
  - parseDateTime
```
public Date parseDateTime(String input)
                   throws ParseException
```
    Parses a date-time input string. Local time zone. Handles 2-digit, 4-digit, single-digit years, out-of-bounds years, and trailing garbage in input string.
    
    Throws:
    
    ParseException
  - getInputDateFormat
```
public DateFormat getInputDateFormat(BaseLocalizer.LocalOrGmt tz)
```
    Get date-only DateFormat for input. Caller specified time zone. This is based on a 2 digit year input mask, which also handles 4-digit year, but caller must use doParseDate() to handle single-digit years, out-of-bounds years, and trailing garbage in input string.
  - getLocaleInputDateFormat
```
public static DateFormat getLocaleInputDateFormat(Locale locale,
                                                  TimeZone tz)
```
    Static method to get date-only DateFormat for input. This is based on a 2 digit year input mask, which also handles 4-digit year, but caller must use doParseDate() to handle single-digit years, out-of-bounds years, and trailing garbage in input string. Also used by FilterItem to get DateFormat to store report dates in US locale.
  - isLanguageEnglish
```
public static boolean isLanguageEnglish(Locale locale)
```
  - isLanguageJapanese
```
public static boolean isLanguageJapanese(Locale locale)
```
  - getInputDateTimeFormat
```
public DateFormat getInputDateTimeFormat()
```
    Get date-time DateFormat for input. Locale time zone. This is based on a 2 digit year input mask, which also handles 4-digit year, but caller must use doParseDate() to handle single-digit years, out-of-bounds years, and trailing garbage in input string.
  - getLocaleInputDateTimeFormat
```
public static DateFormat getLocaleInputDateTimeFormat(Locale locale,
                                                      TimeZone tz)
```
    Static method to get date-time DateFormat for input. This is based on a 2 digit year input mask, which also handles 4-digit year, but caller must use doParseDate() to handle single-digit years, out-of-bounds years, and trailing garbage in input string. Also used by FilterItem to get DateFormat to store report dates in US locale.
  - doParseDate
```
public static Date doParseDate(String input,
                               DateFormat df)
                        throws ParseException
```
    Parse the given input string using the given format, and make sure the entire string is used up during the parsing and garbage text at the end is not allowed. Also handles single-digit years and verify out-of-bounds years. All date parsing in the app must go through this.
    
    Throws:
    
    ParseException
  - doParseTime
```
public static Date doParseTime(String input,
                               DateFormat tf)
                        throws ParseException
```
    parse a time (or date really), but you should use doParseDate for dates as it does some extra stuff
    
    Throws:
    
    ParseException
  - formatDate
```
public String formatDate(Date date,
                         BaseLocalizer.LocalOrGmt tz)
```
    Formats a date-only Date. Caller specified time zone.
  - formatDateTime
```
public String formatDateTime(Date date)
```
    Formats a date-time Date. Local time zone.
  - getDateFormat
```
public DateFormat getDateFormat(BaseLocalizer.LocalOrGmt tz)
```
    Get date-only DateFormat for output. Uses short date format, 4-digit year. Caller specified time zone.
  - getLocaleDateFormat
```
public static DateFormat getLocaleDateFormat(Locale locale,
                                             TimeZone tz)
```
    Static method to get date-only DateFormat for output. Uses short date format, 4-digit year. Also used by FilterItem to get DateFormat to store report dates in US locale.
  - getLongDateFormat
```
public DateFormat getLongDateFormat()
```
    Get date-only DateFormat for output. Uses long date format, 4-digit year. Local time zone.
  - getTimeFormat
```
public DateFormat getTimeFormat()
```
    Get time-only DateFormat for output. Uses short time format. Local time zone.
  - getGmtTimeFormat
```
public DateFormat getGmtTimeFormat()
```
    Get time-only DateFormat for output. Uses short time format. GMT time zone.
  - getDateTimeFormat
```
public DateFormat getDateTimeFormat()
```
    Get date-time DateFormat for output. Uses short date and time formats, 4-digit year. Local time zone.
  - getLocaleDateTimeFormat
```
public static DateFormat getLocaleDateTimeFormat(Locale locale,
                                                 TimeZone tz)
```
    Static method to get date-time DateFormat for output. Uses short date and time formats, 4-digit year. Also used by FilterItem to get DateFormat to store report dates in US locale.
  - getLocaleTimeFormat
```
public static DateFormat getLocaleTimeFormat(Locale locale,
                                             TimeZone tz)
```
    This form of getLocalDateTimeFormat is used to render times in a specific locale. Used to send event notification emails
  - getLongDateTimeFormat
```
public DateFormat getLongDateTimeFormat()
```
    Get date-time DateFormat for output. Uses short date and and long time formats, 4-digit year. Local time zone.
  - parseNumber
```
public Number parseNumber(String s)
                   throws ParseException
```
    Parse the string as a number.
    
    Parameters:
    
    s - the string to be parsed
    
    Returns:
    
    a number object representing the parsed number
    
    Throws:
    
    ParseException - if the string cannot be parsed
  - parsePercent
```
public Number parsePercent(String s)
                    throws ParseException
```
    Parse the string as percentage.
    
    Parameters:
    
    s - the string to be parsed
    
    Returns:
    
    a number object representing the parsed percentage
    
    Throws:
    
    ParseException - if the string cannot be parsed
  - parseCurrency
```
public Number parseCurrency(String s)
                     throws ParseException
```
    Parse the string as currency.
    
    Parameters:
    
    s - the string to be parsed
    
    Returns:
    
    a number object representing the parsed currency
    
    Throws:
    
    ParseException - if the string cannot be parsed
  - getNumberFormat
```
public NumberFormat getNumberFormat()
```
    Gets a NumberFormat, using the default settings for the Locale. Caller must use doParseNumber() to handle trailing garbage in input string.
  - getNumberFormat
```
public NumberFormat getNumberFormat(int precision,
                                    int scale)
```
    Return the number format for the locale with the given precision and scale
    
    Parameters:
    
    precision - the precision of the number to be displayed
    
    scale - the scale to be displayed
    
    Returns:
    
    a number format with the given scale
  - getNumberFormat
```
public NumberFormat getNumberFormat(int scale,
                                    boolean scaleSpecified)
```
    Gets a NumberFormat, using the given precision and scale settings. Caller must use doParseNumber() to handle trailing garbage in input string.
    
    Parameters:
    
    scale - number of digits to the right of the decimal that will be shown
  - getCurrencyFormat
```
public NumberFormat getCurrencyFormat()
```
    Gets a NumberFormat for currency, using the default settings for the Locale. Caller must use doParseNumber() to handle trailing garbage in input string.
  - getCurrencyFormat
```
protected NumberFormat getCurrencyFormat(Locale currLocale)
```
  - getCurrencyFormat
```
public NumberFormat getCurrencyFormat(int scale)
```
    Gets a NumberFormat for currency, using the given precision and scale settings. Caller must use doParseNumber() to handle trailing garbage in input string.
    
    Parameters:
    
    scale - number of digits to the right of the decimal that will be shown
  - getCurrencyFormat
```
protected NumberFormat getCurrencyFormat(Locale currLocale,
                                         int scale)
```
  - getPercentFormat
```
public NumberFormat getPercentFormat()
```
    Gets a NumberFormat for percentage, using the default settings for the Locale. Caller must use doParseNumber() to handle trailing garbage in input string.
  - doParseNumber
```
public static Number doParseNumber(String input,
                                   NumberFormat nf)
                            throws ParseException
```
    Parse the given input string using the given format, and make sure the entire string is used up during the parsing and garbage text at the end is not allowed.
    
    Throws:
    
    ParseException
  - getMessageFormat
```
public MessageFormat getMessageFormat(String pattern)
```
  - getLabel
```
public String getLabel(String section,
                       String name)
```
  - getLabelThrow
```
public String getLabelThrow(String section,
                            String name)
```
  - labelExists
```
public boolean labelExists(String section,
                           String name)
```
  - getSection
```
public Map<String,Object> getSection(String section)
```
    Returns a map containing the contents of an entire label section, or null if the section does not exist.
    
    Parameters:
    
    section - The section to retrieve
  - 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.
    
    Parameters:
    
    section - same as getLabel(section, key)
    
    key - same as getLabel(section, key)
    
    args - for java.text.MessageFormat.format()
  - getList
```
public List<String> getList(String section,
                            String baseName)
```
  - getLocale
```
public Locale getLocale()
```
    Retrieve the locale associated with this localizer. A setter shouldn't be added because it's assumed the locale is set on instantiation; otherwise, we'd need to fix getMessageFormat()
  - getTimeZone
```
public TimeZone getTimeZone()
```
  - getLanguage
```
public Locale getLanguage()
```
    Returns:
    
    the locale of the language associated with the localizer
  - getUserLanguage
```
public HumanLanguage getUserLanguage()
```
  - getCurrencyLocale
```
public Locale getCurrencyLocale()
```

Class BaseLocalizer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCAL

GMT

GMT_TZ

EARLIEST

LATEST

OLD_EARLIEST

OLD_LATEST

labelSet

gmtDateFormat

localDateFormat

localLongDateFormat

gmtTimeFormat

localTimeFormat

dateTimeFormat

longDateTimeFormat

inputGmtDateFormat

inputLocalDateFormat

inputDateTimeFormat

numberFormat

currencyFormat

messageFormatCache

ENGLISH_LANGUAGE

KOREAN_LANGUAGE

JAPANESE_LANGUAGE

CHINESE_LANGUAGE

Constructor Detail

BaseLocalizer

Method Detail

getLabelSet

getCalendar

getCalendar

getCalendar

parseDate

parseDateTime

getInputDateFormat

getLocaleInputDateFormat

isLanguageEnglish

isLanguageJapanese

getInputDateTimeFormat

getLocaleInputDateTimeFormat

doParseDate

doParseTime

formatDate

formatDateTime

getDateFormat

getLocaleDateFormat

getLongDateFormat

getTimeFormat

getGmtTimeFormat

getDateTimeFormat

getLocaleDateTimeFormat

getLocaleTimeFormat

getLongDateTimeFormat

parseNumber

parsePercent

parseCurrency

getNumberFormat

getNumberFormat

getNumberFormat

getCurrencyFormat

getCurrencyFormat

getCurrencyFormat

getCurrencyFormat

getPercentFormat

doParseNumber

getMessageFormat

getLabel

getLabelThrow

labelExists

getSection

getLabel

getList

getLocale