|
Oracle® Globalization Development Kit Java API Reference 10g Release 1(10.1) B10971-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.i18n.servlet.localesource.LocaleSource
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:
true
, otherwise false
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.
Nested Class Summary | |
static class |
LocaleSource.Alignment LocaleSource.Alignment class represents the alignment of text element. |
static class |
LocaleSource.Parameter LocaleSource.Parameter class represents locale and attribute variable names. |
static class |
LocaleSource.WritingDirection LocaleSource.WritingDirection class represents the writing direction of the locale. |
Constructor Summary | |
protected |
LocaleSource(boolean isCached, boolean isReadOnly) Constructs a LocaleSource object |
Method Summary | |
boolean |
equals(Object o) Determines if a specific object equals to this object |
protected Object |
getAttribute(String key) Returns the attribute object. |
String |
getCharacterSet() Returns the character set name in this object. |
oracle.i18n.text.OraCollator |
getCollator() Returns the Oracle collator object |
oracle.i18n.text.OraNumberFormat |
getCurrencyFormat() Returns the Oracle currency format in this object. |
oracle.i18n.text.OraDateFormat |
getDateFormat(int style) Returns the Oracle date format of the specified style in this object. |
oracle.i18n.text.OraDateFormat |
getDateTimeFormat(int style) Returns the Oracle date and time format of the specified style in this object. |
String |
getISOCurrency() Returns the ISO 4217 currency ID in this object. |
Locale |
getLocale() Returns the locale object in this object. |
Class |
getLocaleSourceClass() Returns the locale source class |
oracle.i18n.text.OraNumberFormat |
getNumberFormat() Returns the Oracle number format in this object. |
oracle.i18n.text.OraDateFormat |
getTimeFormat() Returns the Oracle time format in this object. |
TimeZone |
getTimeZone() Returns the TimeZone in this object. |
LocaleSource.WritingDirection |
getWritingDirection() Returns the writing direction in this object. |
int |
hashCode() Returns the hash value of this object. |
boolean |
isCached() Checks if the LocaleSource object will be cached |
boolean |
isReadOnly() Checks if this LocaleSource object is read-only. |
abstract boolean |
load() Loads the locale and all attributes from the actual locale source into this object. |
protected void |
setAttribute(String key, Object object) Registers an attribute object in the LocaleSource . |
void |
setCharacterSet(String charset) Registers the Oracle character set name to store in the actual LocaleSource . |
void |
setCollator(oracle.i18n.text.OraCollator ocol) Registers the Oracle collator to store into the actual o LocaleSource . |
void |
setCurrencyFormat(oracle.i18n.text.OraNumberFormat nfmt) Registers the Oracle currency format object to store in the actual LocaleSource . |
void |
setDateFormat(int style, oracle.i18n.text.OraDateFormat dtfmt) Registers the Oracle date format object to store in the actual LocaleSource . |
void |
setDateTimeFormat(int dtstyle, oracle.i18n.text.OraDateFormat dtfmt) Registers the Oracle date time format object to store in the actual LocaleSource . |
void |
setISOCurrency(String currency) Registers the ISO currency to store into the actual LocaleSource . |
void |
setLocale(Locale locale) Registers the Locale with this object |
void |
setLocale(Locale locale, oracle.i18n.servlet.ApplicationContext appctx) Registers the locale object into this object |
void |
setLocaleSourceClass(Class loccls) Registers the locale source class object. |
void |
setNumberFormat(oracle.i18n.text.OraNumberFormat nfmt) Registers the Oracle number format object to store into the actual LocaleSource . |
void |
setTimeFormat(oracle.i18n.text.OraDateFormat tmfmt) Registers the Oracle time format object to store in the actual LocaleSource . |
void |
setTimeZone(TimeZone tz) Registers the TimeZone ID to store in the actual LocaleSource . |
void |
setWritingDirection(LocaleSource.WritingDirection wdir) Registers the writing direction to store in the actual LocaleSource . |
abstract boolean |
store() Stores the locale and all attributes of the object in the actual LocaleSource . |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected LocaleSource(boolean isCached, boolean isReadOnly)
isCached
- true if the locale source is cache-able.isReadOnly
- true if the locale source is read-onlyMethod Detail |
public final boolean isCached()
LocaleSource
object will be cachedtrue
if this object will be cached; false
otherwise.public final boolean isReadOnly()
LocaleSource
object is read-only.
If this is true, creation and update operations on this object will be omitted.
true
if this object is read-only; false
otherwise.public abstract boolean store()
LocaleSource
.
This method must be implemented by the concrete classes.
true
if the storing operation is successfull; false
otherwise.public abstract boolean load()
This method must be implemented by the concrete classes.
true
if the loading operation is successfull; false
otherwise.public final void setLocale(Locale locale)
Locale
with this objectlocale
- the Locale
object.public final void setLocale(Locale locale, oracle.i18n.servlet.ApplicationContext appctx)
locale
- the Locale objectappctx
- the ApplicationContext objectpublic final void setISOCurrency(String currency)
LocaleSource
.currency
- the ISO currency ID defined in ISO 4217.public final void setCharacterSet(String charset)
LocaleSource
.charset
- the character set name of Oracle.public final void setLocaleSourceClass(Class loccls)
loccls
- a Class
objectpublic final void setTimeZone(TimeZone tz)
TimeZone
ID to store in the actual LocaleSource
.tz
- a TimeZone
object to registerpublic final void setDateTimeFormat(int dtstyle, oracle.i18n.text.OraDateFormat dtfmt)
LocaleSource
.dtstyle
- the date format style defined in OraDateFormat
.dtfmt
- an OraDateFormat
objectpublic final void setDateFormat(int style, oracle.i18n.text.OraDateFormat dtfmt)
LocaleSource
.style
- the date format style defined in OraDateFormat
.dtfmt
- an OraDateFormat
objectpublic final void setTimeFormat(oracle.i18n.text.OraDateFormat tmfmt)
LocaleSource
.tmfmt
- an OraDateFormat
objectpublic final void setWritingDirection(LocaleSource.WritingDirection wdir)
LocaleSource
.wdir
- a writing direction of text on displaypublic final void setCurrencyFormat(oracle.i18n.text.OraNumberFormat nfmt)
LocaleSource
.nfmt
- an OraNumberFormat
object to registerpublic final void setNumberFormat(oracle.i18n.text.OraNumberFormat nfmt)
LocaleSource
.nfmt
- an OraNumberFormat
object to registerpublic final void setCollator(oracle.i18n.text.OraCollator ocol)
LocaleSource
.ocol
- an OraCollator
object to registerprotected final void setAttribute(String key, Object object)
LocaleSource
.
Used in the concrete classes to set custom attributes.
Note the attribute object must be Serializable
.
key
- a String
key of objectobject
- an objectpublic final Locale getLocale()
Locale
object.public final String getISOCurrency()
public final String getCharacterSet()
public final Class getLocaleSourceClass()
public final TimeZone getTimeZone()
TimeZone
objectpublic final oracle.i18n.text.OraDateFormat getDateTimeFormat(int style)
style
- the Date
fromat styleOraDateFormat
object.public final oracle.i18n.text.OraDateFormat getDateFormat(int style)
style
- the Date
fromat styleOraDateFormat
object.public final oracle.i18n.text.OraDateFormat getTimeFormat()
public final LocaleSource.WritingDirection getWritingDirection()
WritingDirection
objectpublic final oracle.i18n.text.OraNumberFormat getCurrencyFormat()
OraNumberFormat
objectpublic final oracle.i18n.text.OraNumberFormat getNumberFormat()
OraNumberFormat
objectpublic final oracle.i18n.text.OraCollator getCollator()
OraCollator
objectprotected final Object getAttribute(String key)
Used in the concrete classes to retrieve custom attributes. Note the attribute object must be Serializable
.
key
- a String
key of objectObject
associated with the key
public boolean equals(Object o)
equals
in class Object
o
- an Object
to be comparedtrue
if the Objects
are equal; false
otherwise.public int hashCode()
hashCode
in class Object
|
Oracle® Globalization Development Kit Java API Reference 10g Release 1(10.1) B10971-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |