Localizer (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.common.Localizer

All Implemented Interfaces:

Serializable
```
public final class Localizer
extends Object
implements Serializable
```
A Localizer encapsulates internationalization information.
Many methods in the iFS API require internationalization information, such as the appropriate locale, date format, time format, or number format. This data is encapsulated in a Localizer instance, which is made available to such methods.
Each LibrarySession has a Localizer based on arguments supplied to LibraryService.connect.
A Localizer also encapsulates the iFS resource bundle. The getResourceString methods of LibrarySession and LibraryObject use this resource bundle to generate localized messages. An application can override some or all of these messages, or introduce its own messages, by invoking setExtendedResourceBundles on the Localizer returned by LibrarySession.getLocalizer.

Version:

1.0

Author:

David Pitfield

See Also:

Serialized Form

(Published)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADDEDEXTENDEDRESOURCEBUNDLENAME` Internal property name for adding an extended resource property bundle names.
`static String`	`CHARENCODING` Internal property name for the character encoding.
`static String`	`DATEFORMATTER` Internal property name for the date formatter.
`static String`	`EXTENDEDRESOURCEBUNDLENAMES` Internal property name for the extended resource property bundle names.
`static String`	`LANGUAGE` Internal property name for the context language.
`static String`	`LOCALE` Internal property name for the locale.
`protected Calendar`	`m_Calendar` The Calendar of this Localizer.
`protected String`	`m_CharEncoding` The Iana character encoding of this Localizer.
`protected DateFormat`	`m_DateFormatter` The date formatter of this Localizer.
`protected boolean`	`m_DefaultExtendedResourceBundleNamesAdded` Have the default names of the extended resource bundles been added to this Localizer?
`protected Vector`	`m_ExtendedResourceBundleNames` The names of the extended resource bundles of this Localizer.
`protected Vector`	`m_ExtendedResourceBundles` The extended resource bundles of this Localizer.
`protected String`	`m_Language` The Oracle language name for context search.
`protected Locale`	`m_Locale` The locale of this Localizer.
`protected NumberFormat`	`m_NumberFormatter` The number formatter of this Localizer.
`protected ResourceBundle`	`m_ResourceBundle` The resource bundle of this Localizer.
`protected LibrarySession`	`m_Session` The LibrarySession to which this Localizer is bound.
`protected DateFormat`	`m_TimeFormatter` The time formatter of this Localizer.
`protected TimeZone`	`m_TimeZone` The time zone of this Localizer.
`static String`	`NUMBERFORMATTER` Internal property name for the number formatter.
`static String`	`REMOVEALLEXTENDEDRESOURCEBUNDLENAMES` Internal property name for removing all extended resource property bundle names.
`static String`	`REMOVEDEXTENDEDRESOURCEBUNDLENAME` Internal property name for removing an extended resource property bundle names.
`protected static Locale`	`s_NoLanguageLocale` A static Locale (no lang or country) for forced english translations.
`protected static Localizer`	`s_UsEnglishLocalizer` A static US English Localizer.
`static String`	`TIMEFORMATTER` Internal property name for the time formatter.
`static String`	`TIMEZONE` Internal property name for the timezone.

Constructor Summary

Constructors
Constructor and Description
`Localizer()` Constructs a Localizer.
`Localizer(Locale locale)` Constructs a Localizer for the specified locale.
`Localizer(Locale locale, LibrarySession session)` Constructs a Localizer for the specified locale.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtendedResourceBundle(String bundleName)` Adds a resource bundle to the vector if it is not there already.
`static Locale`	`constructLocale(String localeString)` Construct a Locale from a String representation.
`Calendar`	`getCalendar()` Gets the Calendar of this Localizer.
`String`	`getCharEncoding()` Gets the Iana character set of this Localizer.
`DateFormat`	`getDateFormatter()` Gets the date formatter of this Localizer.
`static Localizer`	`getDefault()` Gets the default US English Localizer.
`protected Locale`	`getDefaultLocale()` Gets the default locale, first looks in the properties file, second looks at the JavaVM.
`String[]`	`getExtendedResourceBundles()` Gets the extended resource bundles for this Localizer.
`String`	`getLanguage()` Returns the language for this LibrarySession in English.
`Locale`	`getLocale()` Gets the locale of this Localizer.
`NumberFormat`	`getNumberFormatter()` Gets the number formatter of this Localizer.
`String`	`getResourceString(String key)` Gets the resource string for the specified key.
`String`	`getResourceString(String key, Object[] params)` Gets the resource string for the specified key, and substitutes the specified parameters into that resource string.
`DateFormat`	`getTimeFormatter()` Gets the time formatter of this Localizer.
`TimeZone`	`getTimeZone()` Gets the time zone of this Localizer.
`void`	`removeAllExtendedResourceBundles()` Removes all extended resource bundles.
`void`	`removeExtendedResourceBundle(String bundleName)` Removes a resource bundle from the vector.
`static void`	`resetDefaultLocalizerExtendedResourceBundles(LibrarySession session)` Initialize the default Localizer's set of Extended resource bundles
`void`	`setCharEncoding(String charEncoding)` Sets the Iana character set of this Localizer.
`void`	`setDateFormatter(DateFormat dateFormatter)` Sets the date formatter of this Localizer.
`void`	`setDefaultExtendedResourceBundles()` Sets the default set of extended resource bundle names to be used.
`void`	`setExtendedResourceBundles(String[] baseNames)` Sets the extended resource bundles for this Localizer.
`void`	`setLanguage(String language)` Sets the language to be used by context search.
`void`	`setLocale(Locale locale)` Sets the locale of this Localizer.
`void`	`setNumberFormatter(NumberFormat numberFormatter)` Sets the number formatter of this Localizer.
`void`	`setTimeFormatter(DateFormat timeFormatter)` Sets the time formatter of this Localizer.
`void`	`setTimeZone(TimeZone timeZone)` Sets the time zone of this Localizer.
`protected void`	`updateTimeZone(TimeZone timeZone)`

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

- Field Detail
  - LOCALE
```
public static final String LOCALE
```
    Internal property name for the locale.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - CHARENCODING
```
public static final String CHARENCODING
```
    Internal property name for the character encoding.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - LANGUAGE
```
public static final String LANGUAGE
```
    Internal property name for the context language.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - NUMBERFORMATTER
```
public static final String NUMBERFORMATTER
```
    Internal property name for the number formatter.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - DATEFORMATTER
```
public static final String DATEFORMATTER
```
    Internal property name for the date formatter.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - TIMEFORMATTER
```
public static final String TIMEFORMATTER
```
    Internal property name for the time formatter.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - TIMEZONE
```
public static final String TIMEZONE
```
    Internal property name for the timezone.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - EXTENDEDRESOURCEBUNDLENAMES
```
public static final String EXTENDEDRESOURCEBUNDLENAMES
```
    Internal property name for the extended resource property bundle names.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - ADDEDEXTENDEDRESOURCEBUNDLENAME
```
public static final String ADDEDEXTENDEDRESOURCEBUNDLENAME
```
    Internal property name for adding an extended resource property bundle names.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REMOVEDEXTENDEDRESOURCEBUNDLENAME
```
public static final String REMOVEDEXTENDEDRESOURCEBUNDLENAME
```
    Internal property name for removing an extended resource property bundle names.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REMOVEALLEXTENDEDRESOURCEBUNDLENAMES
```
public static final String REMOVEALLEXTENDEDRESOURCEBUNDLENAMES
```
    Internal property name for removing all extended resource property bundle names.
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - m_Session
```
protected transient LibrarySession m_Session
```
    The LibrarySession to which this Localizer is bound.
    
    (Unpublished)
  - m_Locale
```
protected Locale m_Locale
```
    The locale of this Localizer.
    
    (Unpublished)
  - m_CharEncoding
```
protected String m_CharEncoding
```
    The Iana character encoding of this Localizer.
    
    (Unpublished)
  - m_Language
```
protected String m_Language
```
    The Oracle language name for context search.
    
    (Unpublished)
  - m_NumberFormatter
```
protected NumberFormat m_NumberFormatter
```
    The number formatter of this Localizer.
    
    (Unpublished)
  - m_DateFormatter
```
protected DateFormat m_DateFormatter
```
    The date formatter of this Localizer.
    
    (Unpublished)
  - m_TimeFormatter
```
protected DateFormat m_TimeFormatter
```
    The time formatter of this Localizer.
    
    (Unpublished)
  - m_Calendar
```
protected Calendar m_Calendar
```
    The Calendar of this Localizer.
    
    (Unpublished)
  - m_TimeZone
```
protected TimeZone m_TimeZone
```
    The time zone of this Localizer.
    
    (Unpublished)
  - m_ResourceBundle
```
protected transient ResourceBundle m_ResourceBundle
```
    The resource bundle of this Localizer.
    
    (Unpublished)
  - m_ExtendedResourceBundles
```
protected transient Vector m_ExtendedResourceBundles
```
    The extended resource bundles of this Localizer.
    
    (Unpublished)
  - m_ExtendedResourceBundleNames
```
protected transient Vector m_ExtendedResourceBundleNames
```
    The names of the extended resource bundles of this Localizer.
    
    (Unpublished)
  - m_DefaultExtendedResourceBundleNamesAdded
```
protected boolean m_DefaultExtendedResourceBundleNamesAdded
```
    Have the default names of the extended resource bundles been added to this Localizer?
    
    (Unpublished)
  - s_UsEnglishLocalizer
```
protected static Localizer s_UsEnglishLocalizer
```
    A static US English Localizer.
    
    (Unpublished)
  - s_NoLanguageLocale
```
protected static Locale s_NoLanguageLocale
```
    A static Locale (no lang or country) for forced english translations.
    
    (Unpublished)
- Constructor Detail
  - Localizer
```
public Localizer()
          throws IfsException
```
    Constructs a Localizer.
    The Localizer's locale is the default locale of the Java VM. The Localizer has default number, date, and time formatters for that locale, and uses 8859_1 (ISO Latin1) character encoding.
    
    Throws:
    
    IfsException - (IFS-12000) if the operation fails
    
    (Published)
  - Localizer
```
public Localizer(Locale locale)
          throws IfsException
```
    Constructs a Localizer for the specified locale.
    The Localizer has default number, date, time formatters; and default Timezone and character encoding settings.
    
    Parameters:
    
    locale - the locale of the Localizer. If null, the default locale of the Java VM is used.
    
    Throws:
    
    IfsException - (IFS-12000) if the operation fails
    
    (Published)
  - Localizer
```
public Localizer(Locale locale,
                 LibrarySession session)
          throws IfsException
```
    Constructs a Localizer for the specified locale.
    The Localizer has default number, date, time formatters; and default Timezone and character encoding settings.
    
    Parameters:
    
    locale - the locale of the Localizer. If null, the default locale of the Java VM is used.
    
    session - the LibrarySession to which the Localizer is bound; any changes to this Localizer will trigger identical changes in the Localizer of the corresponding S_LibrarySession
    
    Throws:
    
    IfsException - (IFS-12000) if the operation fails
    
    (Published)
- Method Detail
  - setDefaultExtendedResourceBundles
```
public void setDefaultExtendedResourceBundles()
                                       throws IfsException
```
    Sets the default set of extended resource bundle names to be used.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - resetDefaultLocalizerExtendedResourceBundles
```
public static void resetDefaultLocalizerExtendedResourceBundles(LibrarySession session)
                                                         throws IfsException
```
    Initialize the default Localizer's set of Extended resource bundles
    
    Parameters:
    
    session - the session context
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getLocale
```
public Locale getLocale()
                 throws IfsException
```
    Gets the locale of this Localizer.
    
    Returns:
    
    the locale
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - constructLocale
```
public static Locale constructLocale(String localeString)
```
    Construct a Locale from a String representation.
    The string should be one of:
    - lang
    - lang_COUNTRY
    - lang_COUNTRY_variant
    - lang__variant
    Where lang is the 2-letter lowercase language code, COUNTRY is the 2-letter uppercase country code, and variant is the locale variant.
    Parameters:
    
    localeString - the string representation of the Locale
    
    Returns:
    
    the locale
    
    (Unpublished)
  - setLocale
```
public void setLocale(Locale locale)
               throws IfsException
```
    Sets the locale of this Localizer.
    The number formatter, date formatter, and time formatter are set to default formatters for the specified locale.
    
    Parameters:
    
    locale - the locale
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getDefault
```
public static Localizer getDefault()
```
    Gets the default US English Localizer.
    This default is used by IfsException.getMessage.
    
    Returns:
    
    the default Localizer
    
    (Published)
  - setCharEncoding
```
public void setCharEncoding(String charEncoding)
                     throws IfsException
```
    Sets the Iana character set of this Localizer.
    
    Parameters:
    
    charEncoding - the Iana character set.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getCharEncoding
```
public String getCharEncoding()
                       throws IfsException
```
    Gets the Iana character set of this Localizer.
    
    Returns:
    
    the character encoding
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getDefaultLocale
```
protected Locale getDefaultLocale()
                           throws IfsException
```
    Gets the default locale, first looks in the properties file, second looks at the JavaVM.
    
    Returns:
    
    the Locale
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - setLanguage
```
public void setLanguage(String language)
                 throws IfsException
```
    Sets the language to be used by context search. If none set, the default is the value of DefaultLanguage from the properties file. The serverside code will determine the default to use.
    
    Parameters:
    
    language - the Oracle language name.
    
    Throws:
    
    IfsException
    
    (Published)
  - getLanguage
```
public String getLanguage()
                   throws IfsException
```
    Returns the language for this LibrarySession in English.
    
    Returns:
    
    the Oracle IMT language name. Defaults to property, DefaultLanguage, in properties file.
    
    Throws:
    
    IfsException
    
    (Published)
  - setNumberFormatter
```
public void setNumberFormatter(NumberFormat numberFormatter)
                        throws IfsException
```
    Sets the number formatter of this Localizer.
    
    Parameters:
    
    numberFormatter - the number formatter. If null, a default number formatter for the locale of this Localizer is used.
    
    Throws:
    
    IfsException - (IFS-12002) if the operation fails
    
    (Published)
  - getNumberFormatter
```
public NumberFormat getNumberFormatter()
                                throws IfsException
```
    Gets the number formatter of this Localizer.
    
    Returns:
    
    the number formatter
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setDateFormatter
```
public void setDateFormatter(DateFormat dateFormatter)
                      throws IfsException
```
    Sets the date formatter of this Localizer.
    
    Parameters:
    
    dateFormatter - the date formatter. If null, a default date formatter for the locale of this Localizer is used.
    
    Throws:
    
    IfsException - (IFS-12003) if the operation fails
    
    (Published)
  - getDateFormatter
```
public DateFormat getDateFormatter()
                            throws IfsException
```
    Gets the date formatter of this Localizer.
    
    Returns:
    
    the date formatter
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setTimeFormatter
```
public void setTimeFormatter(DateFormat timeFormatter)
                      throws IfsException
```
    Sets the time formatter of this Localizer.
    
    Parameters:
    
    timeFormatter - the time formatter. If null, a default time formatter for the locale of this Localizer is used.
    
    Throws:
    
    IfsException - (IFS-12004) if the operation fails
    
    (Published)
  - getTimeFormatter
```
public DateFormat getTimeFormatter()
                            throws IfsException
```
    Gets the time formatter of this Localizer.
    
    Returns:
    
    the time formatter
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setTimeZone
```
public void setTimeZone(TimeZone timeZone)
                 throws IfsException
```
    Sets the time zone of this Localizer.
    
    Parameters:
    
    timeZone - the time zone. If null, a default time zone for the locale of this Localizer is used.
    
    Throws:
    
    IfsException - (IFS-12005) if the operation fails
    
    (Published)
  - updateTimeZone
```
protected void updateTimeZone(TimeZone timeZone)
```
    (Unpublished)
  - getTimeZone
```
public TimeZone getTimeZone()
                     throws IfsException
```
    Gets the time zone of this Localizer.
    
    Returns:
    
    the time zone
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getCalendar
```
public Calendar getCalendar()
                     throws IfsException
```
    Gets the Calendar of this Localizer.
    
    Returns:
    
    the Calendar
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setExtendedResourceBundles
```
public void setExtendedResourceBundles(String[] baseNames)
                                throws IfsException
```
    Sets the extended resource bundles for this Localizer.
    
    Parameters:
    
    baseNames - an array of resource bundle names. Each resource bundle name must be a valid argument to ResourceBundle.getBundle(String).
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getExtendedResourceBundles
```
public String[] getExtendedResourceBundles()
                                    throws IfsException
```
    Gets the extended resource bundles for this Localizer.
    When a Localizer is constructed, its extended resource bundles default to those of the default Localizer (Localizer.getDefault()).
    
    Returns:
    
    an array of resource bundle names. Each resource bundle name is a valid argument to ResourceBundle.getBundle(String).
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addExtendedResourceBundle
```
public void addExtendedResourceBundle(String bundleName)
                               throws IfsException
```
    Adds a resource bundle to the vector if it is not there already.
    
    Parameters:
    
    bundleName - the name of the resource bundle.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeExtendedResourceBundle
```
public void removeExtendedResourceBundle(String bundleName)
                                  throws IfsException
```
    Removes a resource bundle from the vector.
    
    Parameters:
    
    bundleName - the name of the resource bundle.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeAllExtendedResourceBundles
```
public void removeAllExtendedResourceBundles()
                                      throws IfsException
```
    Removes all extended resource bundles.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getResourceString
```
public String getResourceString(String key)
                         throws IfsException
```
    Gets the resource string for the specified key.
    The method looks-up the key in each extended resource bundle, in the order specified by the array in setExtendedResourceBundles, until it finds a bundle containing the key. If no extended resource bundle contains the key, the default resource bundle (LibraryResources) is used.
    
    Parameters:
    
    key - the resource bundle key
    
    Returns:
    
    the resource string
    
    Throws:
    
    IfsException - IFS-12001 if the operation fails
    
    (Published)
  - getResourceString
```
public String getResourceString(String key,
                                Object[] params)
                         throws IfsException
```
    Gets the resource string for the specified key, and substitutes the specified parameters into that resource string.
    The method looks-up the key using getResourceString(key). Next, java.text.MessageFormat is used to substitute the parameters specified by params into the key's value. If a string element of params is delimited by brackets, i.e. "{param}", then that element is replaced with the value returned by getResourceString("param") before being passed to MessageFormat.
    
    Parameters:
    
    key - the resource bundle key
    
    params - an array of Objects to be substituted into the resource bundle message using using java.text.MessageFormat
    
    Returns:
    
    the formatted resource string
    
    Throws:
    
    IfsException - IFS-12006 if the operation fails
    
    (Published)

Class Localizer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCALE

CHARENCODING

LANGUAGE

NUMBERFORMATTER

DATEFORMATTER

TIMEFORMATTER

TIMEZONE

EXTENDEDRESOURCEBUNDLENAMES

ADDEDEXTENDEDRESOURCEBUNDLENAME

REMOVEDEXTENDEDRESOURCEBUNDLENAME

REMOVEALLEXTENDEDRESOURCEBUNDLENAMES

m_Session

m_Locale

m_CharEncoding

m_Language

m_NumberFormatter

m_DateFormatter

m_TimeFormatter

m_Calendar

m_TimeZone

m_ResourceBundle

m_ExtendedResourceBundles

m_ExtendedResourceBundleNames

m_DefaultExtendedResourceBundleNamesAdded

s_UsEnglishLocalizer

s_NoLanguageLocale

Constructor Detail

Localizer

Localizer

Localizer

Method Detail

setDefaultExtendedResourceBundles

resetDefaultLocalizerExtendedResourceBundles

getLocale

constructLocale

setLocale

getDefault

setCharEncoding

getCharEncoding

getDefaultLocale

setLanguage

getLanguage

setNumberFormatter

getNumberFormatter

setDateFormatter

getDateFormatter

setTimeFormatter

getTimeFormatter

setTimeZone

updateTimeZone

getTimeZone

getCalendar

setExtendedResourceBundles

getExtendedResourceBundles

addExtendedResourceBundle

removeExtendedResourceBundle

removeAllExtendedResourceBundles

getResourceString

getResourceString