intradoc.common
Class LocaleResources

java.lang.Object
  |
  +--intradoc.common.LocaleResources

public class LocaleResources

extends java.lang.Object

Field Summary

static int	DATE_ONLY
static java.lang.String[][]	FORMATS
static IdcDateFormat	m_bulkloadFormat
static IdcDateFormat	m_daoFormat
static IdcDateFormat	m_dbFormat
static ExecutionContext	m_defaultContext
static java.util.Properties	m_encodingAliasesMap
static IdcDateFormat	m_iso8601Format
static IdcDateFormat	m_legacyFormat
static java.util.Hashtable	m_localeDateFormats
static java.util.Hashtable	m_locales
static IdcDateFormat	m_odbcFormat
static java.lang.Object[]	m_ordinalRegexSet
static IdcDateFormat	m_rfc1123Format
static IdcDateFormat	m_rfc2822Format
static IdcDateFormat	m_rfc850Format
static IdcDateFormat	m_searchFormat
static java.util.Hashtable	m_strings
static IdcDateFormat	m_systemDateFormat
protected static IdcLocale	m_systemLocale
protected static IdcNumberFormat	m_systemNumberFormat
static IdcTimeZone	m_systemTimeZone
static TimeZoneFormat	m_systemTimeZoneFormat
static IdcTimeZone	m_utc
static int	TIME_ONLY
static int	TIMESTAMP

Constructor Summary

LocaleResources()

Method Summary

static void	addLocaleAlias(java.lang.String alias, java.lang.String localeId)
static IdcTimeZone	addTimeZone(java.util.Properties props)
static void	addTimeZone(java.lang.String name, IdcTimeZone tz)
static void	appendDateTraceReport(java.lang.StringBuffer buf, ParseStringLocation parsePosition, boolean includeErrMsg)
static IdcDateFormat	buildDateFormat(java.lang.String fmtString)
static IdcDateFormat	createDateFormat(java.lang.String id) Deprecated. Does not seem to be used.
static IdcDateFormat	createDateFormatFromPattern(java.lang.String pattern, ExecutionContext cxt)
static java.lang.String	createDateTraceReport(java.lang.String function, java.lang.String dateToParse, ParseStringLocation parsePosition)
static IdcDateFormat	getDateFormat(java.lang.String key)
protected static java.util.Date	getDateObjectForLocalization(java.lang.Object value, ExecutionContext cxt)
static java.lang.String	getEncodingFromAlias(java.lang.String alias)
static IdcLocale	getLocale(java.lang.String name)
static java.lang.String[]	getLocaleStringArrayInternal(java.lang.String resource, IdcLocale locale) Utility function to get an array of already localized values.
static java.lang.String	getLocaleStringInternal(java.lang.String resource, IdcLocale locale)
static java.lang.String	getString(java.lang.String key, ExecutionContext cxt)
static java.lang.String	getString(java.lang.String key, ExecutionContext cxt, java.lang.Object arg1)
static java.lang.String	getString(java.lang.String origkey, ExecutionContext cxt, java.lang.Object[] args)
static java.lang.String	getString(java.lang.String key, ExecutionContext cxt, java.lang.Object arg1, java.lang.Object arg2)
static java.lang.String	getStringInternal(java.lang.String resource) Note: this method can legitimately return NULL
static java.lang.String	getStringInternal(java.lang.String resource, ExecutionContext context) Note: this method can legitimately return NULL
static IdcDateFormat	getSystemDateFormat()
static IdcLocale	getSystemLocale()
static java.util.TimeZone	getSystemTimeZone()
protected static java.util.TimeZone	getTimeZone(ExecutionContext cxt)
static IdcTimeZone	getTimeZone(java.lang.String name)
static IdcDateFormat	getUserDateFormat(ExecutionContext cxt)
static IdcDateFormat	getUserDisplayDateFormat(ExecutionContext cxt)
static java.lang.String	handleArgument(java.lang.String arg, java.lang.Object[] args, ExecutionContext cxt)
static void	init()
static void	initFormats(java.util.Hashtable formats, java.util.Properties env)
static void	initializeDateForLocale(IdcDateFormat dateFormat, IdcTimeZone tz, java.lang.String pattern, IdcLocale locale)
static void	initializeInternalStrings(IdcLocale locale)
static void	initializeLocale(IdcLocale locale, java.util.Properties props)
static void	initStrings(java.util.Hashtable strings)
static void	initSystemLocale(java.lang.String name)
static java.lang.String	internationalizeDate(java.lang.Object value, ExecutionContext cxt)
static boolean	isRetryableDateParseError(ParseStringLocation location)
static void	localizeArray(java.lang.String[] array, ExecutionContext cxt)
static java.lang.String	localizeDate(java.lang.Object value, ExecutionContext cxt)
protected static java.lang.String	localizeDateInternal(java.util.Date d, ExecutionContext cxt, int type)
static java.lang.String	localizeDateOnly(java.lang.Object value, ExecutionContext cxt)
static void	localizeDoubleArray(java.lang.String[][] array, ExecutionContext cxt, int index)
static java.lang.String	localizeFloat(double d, int n, ExecutionContext cxt)
static java.lang.String	localizeInteger(long l, ExecutionContext cxt)
static java.lang.String	localizeMessage(java.lang.String msg, ExecutionContext cxt)
protected static java.lang.String	localizeMessageEx(java.lang.String msg, ExecutionContext cxt, int depth)
static java.lang.String	localizeTimeOnly(java.lang.Object value, ExecutionContext cxt)
static java.util.Date	parseDate(java.lang.String origText, ExecutionContext cxt)
static java.util.Date	parseDateDataEntry(java.lang.String origText, ExecutionContext cxt, java.lang.String traceContext)
static java.util.Date	parseDateEx(java.lang.String origText, ExecutionContext cxt, java.lang.String traceContext, boolean tryAlternateFormats)
static java.util.Date	parseDateImplement(java.lang.String origText, ExecutionContext cxt, boolean tryAlternateFormats, ParseStringLocation location) Uses a given ExecutionContext's locale to parse a date.
static IdcTimeZone	parseTimeZone(java.util.Properties props)
static java.lang.String	prependLocale(java.lang.String key, ExecutionContext cxt)
protected static java.lang.String	processOrdinalSubstitution(int value, ExecutionContext cxt)
static java.lang.String	substituteString(java.lang.String s, java.lang.Object[] args, ExecutionContext cxt)

Methods inherited from class java.lang.Object

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

Field Detail

m_strings

public static java.util.Hashtable m_strings

m_systemTimeZoneFormat

public static TimeZoneFormat m_systemTimeZoneFormat

m_locales

public static java.util.Hashtable m_locales

m_localeDateFormats

public static java.util.Hashtable m_localeDateFormats

m_ordinalRegexSet

public static java.lang.Object[] m_ordinalRegexSet

m_defaultContext

public static ExecutionContext m_defaultContext

m_utc

public static IdcTimeZone m_utc

m_systemLocale

protected static IdcLocale m_systemLocale

m_systemNumberFormat

protected static IdcNumberFormat m_systemNumberFormat

m_systemDateFormat

public static IdcDateFormat m_systemDateFormat

m_systemTimeZone

public static IdcTimeZone m_systemTimeZone

m_iso8601Format

public static IdcDateFormat m_iso8601Format

m_dbFormat

public static IdcDateFormat m_dbFormat

m_daoFormat

public static IdcDateFormat m_daoFormat

m_bulkloadFormat

public static IdcDateFormat m_bulkloadFormat

m_searchFormat

public static IdcDateFormat m_searchFormat

m_rfc850Format

public static IdcDateFormat m_rfc850Format

m_rfc1123Format

public static IdcDateFormat m_rfc1123Format

m_odbcFormat

public static IdcDateFormat m_odbcFormat

m_legacyFormat

public static IdcDateFormat m_legacyFormat

m_rfc2822Format

public static IdcDateFormat m_rfc2822Format

m_encodingAliasesMap

public static java.util.Properties m_encodingAliasesMap

TIMESTAMP

public static final int TIMESTAMP

See Also:

Constant Field Values

DATE_ONLY

public static final int DATE_ONLY

See Also:

Constant Field Values

TIME_ONLY

public static final int TIME_ONLY

See Also:

Constant Field Values

FORMATS

public static java.lang.String[][] FORMATS

Constructor Detail

LocaleResources

public LocaleResources()

Method Detail

init

public static void init()
                 throws ServiceException

ServiceException

initStrings

public static void initStrings(java.util.Hashtable strings)

initFormats

public static void initFormats(java.util.Hashtable formats,
                               java.util.Properties env)
                        throws ServiceException

ServiceException

initSystemLocale

public static void initSystemLocale(java.lang.String name)
                             throws ServiceException

ServiceException

localizeMessage

public static java.lang.String localizeMessage(java.lang.String msg,
                                               ExecutionContext cxt)

localizeArray

public static void localizeArray(java.lang.String[] array,
                                 ExecutionContext cxt)

localizeDoubleArray

public static void localizeDoubleArray(java.lang.String[][] array,
                                       ExecutionContext cxt,
                                       int index)

localizeMessageEx

protected static java.lang.String localizeMessageEx(java.lang.String msg,
                                                    ExecutionContext cxt,
                                                    int depth)

getLocaleStringArrayInternal

public static java.lang.String[] getLocaleStringArrayInternal(java.lang.String resource,
                                                              IdcLocale locale)

Utility function to get an array of already localized values. For example, an array of month names.

getLocaleStringInternal

public static java.lang.String getLocaleStringInternal(java.lang.String resource,
                                                       IdcLocale locale)

getStringInternal

public static java.lang.String getStringInternal(java.lang.String resource,
                                                 ExecutionContext context)

Note: this method can legitimately return NULL

getStringInternal

public static java.lang.String getStringInternal(java.lang.String resource)

Note: this method can legitimately return NULL

prependLocale

public static java.lang.String prependLocale(java.lang.String key,
                                             ExecutionContext cxt)

getString

public static java.lang.String getString(java.lang.String key,
                                         ExecutionContext cxt)

getString

public static java.lang.String getString(java.lang.String key,
                                         ExecutionContext cxt,
                                         java.lang.Object arg1)

getString

public static java.lang.String getString(java.lang.String key,
                                         ExecutionContext cxt,
                                         java.lang.Object arg1,
                                         java.lang.Object arg2)

getString

public static java.lang.String getString(java.lang.String origkey,
                                         ExecutionContext cxt,
                                         java.lang.Object[] args)

substituteString

public static java.lang.String substituteString(java.lang.String s,
                                                java.lang.Object[] args,
                                                ExecutionContext cxt)

handleArgument

public static java.lang.String handleArgument(java.lang.String arg,
                                              java.lang.Object[] args,
                                              ExecutionContext cxt)

processOrdinalSubstitution

protected static java.lang.String processOrdinalSubstitution(int value,
                                                             ExecutionContext cxt)

createDateFormat

public static IdcDateFormat createDateFormat(java.lang.String id)
                                      throws ServiceException

Deprecated. Does not seem to be used.

ServiceException

createDateFormatFromPattern

public static IdcDateFormat createDateFormatFromPattern(java.lang.String pattern,
                                                        ExecutionContext cxt)
                                                 throws ServiceException

ServiceException

parseTimeZone

public static IdcTimeZone parseTimeZone(java.util.Properties props)
                                 throws ServiceException

ServiceException

internationalizeDate

public static java.lang.String internationalizeDate(java.lang.Object value,
                                                    ExecutionContext cxt)

localizeDate

public static java.lang.String localizeDate(java.lang.Object value,
                                            ExecutionContext cxt)

localizeDateOnly

public static java.lang.String localizeDateOnly(java.lang.Object value,
                                                ExecutionContext cxt)

localizeTimeOnly

public static java.lang.String localizeTimeOnly(java.lang.Object value,
                                                ExecutionContext cxt)

localizeInteger

public static java.lang.String localizeInteger(long l,
                                               ExecutionContext cxt)

getUserDateFormat

public static IdcDateFormat getUserDateFormat(ExecutionContext cxt)

getUserDisplayDateFormat

public static IdcDateFormat getUserDisplayDateFormat(ExecutionContext cxt)

getDateObjectForLocalization

protected static java.util.Date getDateObjectForLocalization(java.lang.Object value,
                                                             ExecutionContext cxt)

localizeDateInternal

protected static java.lang.String localizeDateInternal(java.util.Date d,
                                                       ExecutionContext cxt,
                                                       int type)

localizeFloat

public static java.lang.String localizeFloat(double d,
                                             int n,
                                             ExecutionContext cxt)

initializeLocale

public static void initializeLocale(IdcLocale locale,
                                    java.util.Properties props)
                             throws ServiceException

ServiceException

initializeInternalStrings

public static void initializeInternalStrings(IdcLocale locale)

initializeDateForLocale

public static void initializeDateForLocale(IdcDateFormat dateFormat,
                                           IdcTimeZone tz,
                                           java.lang.String pattern,
                                           IdcLocale locale)
                                    throws ServiceException

ServiceException

addLocaleAlias

public static void addLocaleAlias(java.lang.String alias,
                                  java.lang.String localeId)

getDateFormat

public static IdcDateFormat getDateFormat(java.lang.String key)

getSystemDateFormat

public static IdcDateFormat getSystemDateFormat()

buildDateFormat

public static IdcDateFormat buildDateFormat(java.lang.String fmtString)
                                     throws ServiceException

ServiceException

getLocale

public static IdcLocale getLocale(java.lang.String name)

getSystemLocale

public static IdcLocale getSystemLocale()

addTimeZone

public static IdcTimeZone addTimeZone(java.util.Properties props)
                               throws ServiceException

ServiceException

addTimeZone

public static void addTimeZone(java.lang.String name,
                               IdcTimeZone tz)

parseDate

public static java.util.Date parseDate(java.lang.String origText,
                                       ExecutionContext cxt)
                                throws ServiceException

ServiceException

parseDateDataEntry

public static java.util.Date parseDateDataEntry(java.lang.String origText,
                                                ExecutionContext cxt,
                                                java.lang.String traceContext)
                                         throws ServiceException

ServiceException

parseDateEx

public static java.util.Date parseDateEx(java.lang.String origText,
                                         ExecutionContext cxt,
                                         java.lang.String traceContext,
                                         boolean tryAlternateFormats)
                                  throws ServiceException

ServiceException

parseDateImplement

public static java.util.Date parseDateImplement(java.lang.String origText,
                                                ExecutionContext cxt,
                                                boolean tryAlternateFormats,
                                                ParseStringLocation location)

Uses a given ExecutionContext's locale to parse a date. If 'tryAlternateFormats' is set, the 'location' parameter will still hold the error from parsing with the standard date/time format whenever the alternate formats are used regardless of whether they succeed or fail.

isRetryableDateParseError

public static boolean isRetryableDateParseError(ParseStringLocation location)

createDateTraceReport

public static java.lang.String createDateTraceReport(java.lang.String function,
                                                     java.lang.String dateToParse,
                                                     ParseStringLocation parsePosition)

appendDateTraceReport

public static void appendDateTraceReport(java.lang.StringBuffer buf,
                                         ParseStringLocation parsePosition,
                                         boolean includeErrMsg)

getTimeZone

public static IdcTimeZone getTimeZone(java.lang.String name)

getTimeZone

protected static java.util.TimeZone getTimeZone(ExecutionContext cxt)

getSystemTimeZone

public static java.util.TimeZone getSystemTimeZone()

getEncodingFromAlias

public static java.lang.String getEncodingFromAlias(java.lang.String alias)