oracle.i18n.servlet.localesource
Class LocaleSource

java.lang.Object
  |
  +--oracle.i18n.servlet.localesource.LocaleSource

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ApplicationDefault, DBLocaleSource, HttpAcceptLanguage, UserInput

public abstract class LocaleSource

extends Object

implements Serializable

LocaleSource is the abstract base class for locale source objects.

The user locale is determined according to the list of LocaleSource in the GDK application configuration file. The GDK examines each LocaleSource class in the order of the list so that the first available LocaleSource is used for the user locale.

The GDK provides the following pre-defined LocaleSource:

• HttpAcceptLanguage - the locale preference set by the web client in the HTTP header.
• UserInput - the locale preference in the parameters of GET and POST methods.
• DBLocaleSource - the locale preference stored in the Oracle database.
• ApplicationDefault - the default locale for the application.

Note ApplicationDefault locale source is implicitly registered in the end of the locale source. It means if no other locale source is available, the ApplicationDefault locale source is used.

To create a custom locale source object, extend this class. The custom object may access the Oracle database to fetch and update the user locale preference, or it may access the LDAP server to get and set the language preference element. Three methods must be implemented in the custom locale source:

• public static LocaleSource getInstance(HttpServletRequest) - used to instantiate the object. It returns the object if it succeeds, otherwise null.
• public boolean load() - used to load the locale and its attributes from the locale source.
• public boolean store() - used to store the locale and its attributes into the locale source. If the locale source is read only, this method should do nothing but reutrn true.

The following method should be implemented in case the locale source is cache-able:

• public static boolean isAccessible(HttpServletRequest) - used to check if the locale source is accessible before using the cached object. It returns true if the locale source is accessible, otherwise false. If this method is not implemented, the GDK assumes that the locale source is always accessible.

In the constructor, the following parameters must be specified:

• Cache flag - indicates whether the locale soruce is cache-able or not. If the access cost to the locale source is not trivial, such as LDAP server, this flag should be true, otherwise false
• Read Only flag - indicates whether the locale source is read only or not. If the locale source is not update-able, such as Accept Language item in the HTTP header, this flag should e true, otherwise false.

For example, the locale source accessing LDAP server should be cache-able so that the GDK keeps the locale information while the user is valid. Once the user logouts, the locale information should be no longer valid.

Since:

10.1.0.2

See Also:

Serialized Form

LocaleSource

protected LocaleSource(boolean isCached,
                       boolean isReadOnly)

Constructs a LocaleSource object

Parameters:

isCached - true if the locale source is cache-able.

isReadOnly - true if the locale source is read-only

isCached

public final boolean isCached()

Checks if the LocaleSource object will be cached

Returns:

true if this object will be cached; false otherwise.

isReadOnly

public final boolean isReadOnly()

Checks if this LocaleSource object is read-only.

If this is true, creation and update operations on this object will be omitted.

Returns:

true if this object is read-only; false otherwise.

store

public abstract boolean store()

Stores the locale and all attributes of the object in the actual LocaleSource.

This method must be implemented by the concrete classes.

Returns:

true if the storing operation is successfull; false otherwise.

load

public abstract boolean load()

Loads the locale and all attributes from the actual locale source into this object.

This method must be implemented by the concrete classes.

Returns:

true if the loading operation is successfull; false otherwise.

setLocale

public final void setLocale(Locale locale)

Registers the Locale with this object

Parameters:

locale - the Locale object.

setLocale

public final void setLocale(Locale locale,
                            oracle.i18n.servlet.ApplicationContext appctx)

Registers the locale object into this object

Parameters:

locale - the Locale object

appctx - the ApplicationContext object

setISOCurrency

public final void setISOCurrency(String currency)

Registers the ISO currency to store into the actual LocaleSource.

Parameters:

currency - the ISO currency ID defined in ISO 4217.

setCharacterSet

public final void setCharacterSet(String charset)

Registers the Oracle character set name to store in the actual LocaleSource.

Parameters:

charset - the character set name of Oracle.

setLocaleSourceClass

public final void setLocaleSourceClass(Class loccls)

Registers the locale source class object.

Parameters:

loccls - a Class object

setTimeZone

public final void setTimeZone(TimeZone tz)

Registers the TimeZone ID to store in the actual LocaleSource.

Parameters:

tz - a TimeZone object to register

setDateTimeFormat

public final void setDateTimeFormat(int dtstyle,
                                    oracle.i18n.text.OraDateFormat dtfmt)

Registers the Oracle date time format object to store in the actual LocaleSource.

Parameters:

dtstyle - the date format style defined in OraDateFormat.

dtfmt - an OraDateFormat object

setDateFormat

public final void setDateFormat(int style,
                                oracle.i18n.text.OraDateFormat dtfmt)

Registers the Oracle date format object to store in the actual LocaleSource.

Parameters:

style - the date format style defined in OraDateFormat.

dtfmt - an OraDateFormat object

setTimeFormat

public final void setTimeFormat(oracle.i18n.text.OraDateFormat tmfmt)

Registers the Oracle time format object to store in the actual LocaleSource.

Parameters:

tmfmt - an OraDateFormat object

setWritingDirection

public final void setWritingDirection(LocaleSource.WritingDirection wdir)

Registers the writing direction to store in the actual LocaleSource.

Parameters:

wdir - a writing direction of text on display

setCurrencyFormat

public final void setCurrencyFormat(oracle.i18n.text.OraNumberFormat nfmt)

Registers the Oracle currency format object to store in the actual LocaleSource.

Parameters:

nfmt - an OraNumberFormat object to register

setNumberFormat

public final void setNumberFormat(oracle.i18n.text.OraNumberFormat nfmt)

Registers the Oracle number format object to store into the actual LocaleSource.

Parameters:

nfmt - an OraNumberFormat object to register

setCollator

public final void setCollator(oracle.i18n.text.OraCollator ocol)

Registers the Oracle collator to store into the actual o LocaleSource.

Parameters:

ocol - an OraCollator object to register

setAttribute

protected final void setAttribute(String key,
Object object)

Registers an attribute object in the LocaleSource.

Used in the concrete classes to set custom attributes.
Note the attribute object must be Serializable.

Parameters:

key - a String key of object

object - an object

getLocale

public final Locale getLocale()

Returns the locale object in this object.

Returns:

Locale object.

getISOCurrency

public final String getISOCurrency()

Returns the ISO 4217 currency ID in this object.

Returns:

the ISO 4217 currency ID.

getCharacterSet

public final String getCharacterSet()

Returns the character set name in this object.

Returns:

the character set name.

getLocaleSourceClass

public final Class getLocaleSourceClass()

Returns the locale source class

Returns:

the locale source class

getTimeZone

public final TimeZone getTimeZone()

Returns the TimeZone in this object.

Returns:

a TimeZone object

getDateTimeFormat

public final oracle.i18n.text.OraDateFormat getDateTimeFormat(int style)

Returns the Oracle date and time format of the specified style in this object.

Parameters:

style - the Date fromat style

Returns:

an OraDateFormat object.

getDateFormat

public final oracle.i18n.text.OraDateFormat getDateFormat(int style)

Returns the Oracle date format of the specified style in this object.

Parameters:

style - the Date fromat style

Returns:

an OraDateFormat object.

getTimeFormat

public final oracle.i18n.text.OraDateFormat getTimeFormat()

Returns the Oracle time format in this object.

Returns:

the Oracle time format.

getWritingDirection

public final LocaleSource.WritingDirection getWritingDirection()

Returns the writing direction in this object.

Returns:

a WritingDirection object

getCurrencyFormat

public final oracle.i18n.text.OraNumberFormat getCurrencyFormat()

Returns the Oracle currency format in this object.

Returns:

an OraNumberFormat object

getNumberFormat

public final oracle.i18n.text.OraNumberFormat getNumberFormat()

Returns the Oracle number format in this object.

Returns:

an OraNumberFormat object

getCollator

public final oracle.i18n.text.OraCollator getCollator()

Returns the Oracle collator object

Returns:

an OraCollator object

getAttribute

protected final Object getAttribute(String key)

Returns the attribute object.

Used in the concrete classes to retrieve custom attributes. Note the attribute object must be Serializable.

Parameters:

key - a String key of object

Returns:

an Object associated with the key

equals

public boolean equals(Object o)

Determines if a specific object equals to this object

Overrides:

equals in class Object

Parameters:

o - an Object to be compared

Returns:

boolean true if the Objects are equal; false otherwise.

hashCode

public int hashCode()

Returns the hash value of this object.

Overrides:

hashCode in class Object

Returns:

hash value