oracle.apps.fnd.appltest.diagfwk.engine.provider.nls
Class NLSProvider

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.common.DiagBaseFactory
      oracle.apps.fnd.appltest.diagfwk.engine.provider.nls.NLSProvider

All Implemented Interfaces:

DiagConstants

Direct Known Subclasses:

OANLSProviderImpl

public abstract class NLSProvider
extends DiagBaseFactory

Provides APIs for performing NLS related tasks such as getting the current Locale and translating a message given the nls bundle name, nls message key and token name values.

Since:

release specific (what release of product did this appear in)

Version:

$Header: atgpf/appltest/applications/Diagnostics/Engine/src/oracle/apps/fnd/appltest/diagfwk/engine/provider/nls/NLSProvider.java /main/4 2010/10/22 11:19:26 lwong Exp $

Author:

ppradhan

Nested Class Summary

static class

NLSProvider.BundleType Enumeration representing the various formats

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status

Field Summary

static java.lang.String	DELIM_MSG_SVC_NLS_KEY Delimitor for the Message Service related NLS Keys that is used to delimit app code from the message name
static java.lang.String	NLS_BUNDLE_DEFAULT Default Bundle name
static java.lang.String	NLS_BUNDLE_JAVA_RES Bundle name that represents the Java Resource Bundle
static java.lang.String	NLS_BUNDLE_MSG_SVC Bundle name that represents the FND Message Service
static java.lang.String	NLS_BUNDLE_RES_REF Bundle name that represents the LCM SDK Resource Refs
static java.lang.String	NLS_BUNDLE_XLIFF Bundle name that represents the ADF Resource Bundle

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

Constructor Summary

NLSProvider()

Method Summary

static void	clean() Cleans up any resources held by underlying NLSBundles during translaction activity.
protected abstract void	cleanup() Cleans up any resources held by underlying NLSBundles during translaction activity.
static java.util.Locale	getCurrentLocale() Gets the current locale based on user session.
protected abstract java.util.Locale	getLocale() Gets the current locale based on user session.
static NLSBundle	getNLSBundle(java.lang.String pNlsBundleName) Returns an instance of NLSBundle for the given bundle name that can be used to translate resources from that bundle.
protected abstract NLSBundle	getNLSBundleForName(java.lang.String pNlsBundle) Returns an instance of NLSBundle for the given bundle name that can be used to translate resources from that bundle.
protected static boolean	isSubClass(java.lang.Class pClass, java.lang.Class pSuperClass) Checks if the given class is a subclass of the given super class
static java.lang.String	translate(java.lang.String pNlsBundle, java.lang.String pNlsKey, NameValueList pTokens, java.lang.String pDefault) Returns a translated String based on the current locale for the given nls key and token values from the specified nls bundle.

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.common.DiagBaseFactory

createClassLoader, loadClassFor

Methods inherited from class java.lang.Object

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

Field Detail

NLS_BUNDLE_MSG_SVC

public static final java.lang.String NLS_BUNDLE_MSG_SVC

Bundle name that represents the FND Message Service

See Also:

Constant Field Values

NLS_BUNDLE_XLIFF

public static final java.lang.String NLS_BUNDLE_XLIFF

Bundle name that represents the ADF Resource Bundle

See Also:

Constant Field Values

NLS_BUNDLE_JAVA_RES

public static final java.lang.String NLS_BUNDLE_JAVA_RES

Bundle name that represents the Java Resource Bundle

See Also:

Constant Field Values

NLS_BUNDLE_RES_REF

public static final java.lang.String NLS_BUNDLE_RES_REF

Bundle name that represents the LCM SDK Resource Refs

See Also:

Constant Field Values

NLS_BUNDLE_DEFAULT

public static final java.lang.String NLS_BUNDLE_DEFAULT

Default Bundle name

See Also:

Constant Field Values

DELIM_MSG_SVC_NLS_KEY

public static final java.lang.String DELIM_MSG_SVC_NLS_KEY

Delimitor for the Message Service related NLS Keys that is used to delimit app code from the message name

See Also:

Constant Field Values

Constructor Detail

NLSProvider

public NLSProvider()

Method Detail

getLocale

protected abstract java.util.Locale getLocale()

Gets the current locale based on user session.

Returns:

the current locale based on user session

getNLSBundleForName

protected abstract NLSBundle getNLSBundleForName(java.lang.String pNlsBundle)

Returns an instance of NLSBundle for the given bundle name that can be used to translate resources from that bundle.

Parameters:

pNlsBundle - name of the NLS Bundle that contains translatable messages

Returns:

an instance of NLSBundle corresponding to the given name

cleanup

protected abstract void cleanup()

Cleans up any resources held by underlying NLSBundles during translaction activity. Should be called after all activities with the NLSProvider are completed.

getCurrentLocale

public static java.util.Locale getCurrentLocale()

Gets the current locale based on user session.

Returns:

the current locale based on user session

getNLSBundle

public static NLSBundle getNLSBundle(java.lang.String pNlsBundleName)

Returns an instance of NLSBundle for the given bundle name that can be used to translate resources from that bundle.

Parameters:

pNlsBundleName - name of the NLS Bundle that contains translatable messages. The bundle name can be class names for instances of Java ResourceBundle classes, or ResourceRef classes or a constant FND_MSG_SERVICE in which case a NLSBundle for fetching translated messages from the FND Message service is returned.

Returns:

an instance of NLSBundle corresponding to the given name

translate

public static java.lang.String translate(java.lang.String pNlsBundle,
                                         java.lang.String pNlsKey,
                                         NameValueList pTokens,
                                         java.lang.String pDefault)

Returns a translated String based on the current locale for the given nls key and token values from the specified nls bundle.

Parameters:

pNlsBundle - NLS Bundle where the translated resource exists

pNlsKey - Key for the nls message

pTokens - token name values (if any) that should be substitued during the translation

pDefault - default message to return in case translation fails.

Returns:

a translated String based on the current locale.

clean

public static void clean()

Cleans up any resources held by underlying NLSBundles during translaction activity. Should be called after all activities with the NLSProvider are completed.

isSubClass

protected static boolean isSubClass(java.lang.Class pClass,
                                    java.lang.Class pSuperClass)

Checks if the given class is a subclass of the given super class