com.konakart.bl

Class LanguageMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.LanguageMgr

All Implemented Interfaces:

LanguageMgrIf

public class LanguageMgr
extends BaseMgr
implements LanguageMgrIf

Manages all business logic relevant to the management of languages within the system

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	LanguageMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LANG Default language id is selected with a value of ConstantsMgr.NOT_SET.
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	mutex Mutex for the Manager
protected static java.util.Map<java.lang.String,LanguageMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
LanguageMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	deriveDataLanguage(Language lang)
protected Language	fetchDefaultLanguage() The default language is referenced by a configuration variable called DEFAULT_LANGUAGE.
Language[]	getAllLanguages() Returns an array of language objects for all languages that have been defined in the system.
Language	getDefaultLanguage() Returns the default language object
int	getDefaultLanguageId() Returns the default language id
java.lang.String	getDefaultLocale()
Language	getLanguagePerCode(java.lang.String code) Retrieves the language object referenced by the code (i.e.
Language	getLanguagePerId(int languageId) Returns the language object with id = languageId.
Language[]	getLanguages(LanguageSearchIf _search) Returns an array of language objects for all languages that have been defined in the system that meet the defined search criteria.
NameValue[]	getMessages(int type, java.lang.String localeString) Used to fetch a message catalog for a locale and message type.
java.lang.String	getMsgValue(java.lang.String key, int type, java.lang.String localeString) Get an Application Message Value.
void	refreshConfigs() Refresh the configuration of the language manager

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

DEFAULT_LANG

public static final int DEFAULT_LANG

Default language id is selected with a value of ConstantsMgr.NOT_SET.

See Also:

Constant Field Values

mutex

protected static java.lang.String mutex

Mutex for the Manager

staticDataHM

protected static java.util.Map<java.lang.String,LanguageMgr.StaticData> staticDataHM

Hash Map that contains the static data

Constructor Detail

LanguageMgr

public LanguageMgr(KKEngIf eng)
            throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getAllLanguages

public Language[] getAllLanguages()
                           throws org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException,
                                  com.konakart.app.KKException

Returns an array of language objects for all languages that have been defined in the system.

Specified by:

getAllLanguages in interface LanguageMgrIf

Returns:

An array of language objects.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getLanguages

public Language[] getLanguages(LanguageSearchIf _search)
                        throws org.apache.torque.TorqueException,
                               com.workingdogs.village.DataSetException,
                               com.konakart.app.KKException

Description copied from interface: LanguageMgrIf

Returns an array of language objects for all languages that have been defined in the system that meet the defined search criteria.

Specified by:

getLanguages in interface LanguageMgrIf

Parameters:

_search - the languageSearchOptions

Returns:

An array of language objects.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

deriveDataLanguage

protected void deriveDataLanguage(Language lang)
                           throws com.konakart.app.KKException

Throws:

com.konakart.app.KKException

getDefaultLanguageId

public int getDefaultLanguageId()
                         throws com.konakart.app.KKException

Description copied from interface: LanguageMgrIf

Returns the default language id

Specified by:

getDefaultLanguageId in interface LanguageMgrIf

Returns:

Returns the default language id

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getDefaultLanguage

public Language getDefaultLanguage()
                            throws com.konakart.app.KKException

Description copied from interface: LanguageMgrIf

Returns the default language object

Specified by:

getDefaultLanguage in interface LanguageMgrIf

Returns:

Returns the default language object

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getDefaultLocale

public java.lang.String getDefaultLocale()
                                  throws com.konakart.app.KKException

Specified by:

getDefaultLocale in interface LanguageMgrIf

Returns:

Returns the default locale

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getLanguagePerId

public Language getLanguagePerId(int languageId)
                          throws org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException,
                                 com.konakart.app.KKException

Description copied from interface: LanguageMgrIf

Returns the language object with id = languageId. Null if no object is found.

Specified by:

getLanguagePerId in interface LanguageMgrIf

Parameters:

languageId - the languageId

Returns:

The language object with id = languageId. Null if no object is found.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getLanguagePerCode

public Language getLanguagePerCode(java.lang.String code)
                            throws com.workingdogs.village.DataSetException,
                                   org.apache.torque.TorqueException,
                                   com.konakart.app.KKException

Retrieves the language object referenced by the code (i.e. en, de, es)

Specified by:

getLanguagePerCode in interface LanguageMgrIf

Parameters:

code - the code

Returns:

Returns a language object

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

fetchDefaultLanguage

protected Language fetchDefaultLanguage()
                                 throws java.lang.Exception

The default language is referenced by a configuration variable called DEFAULT_LANGUAGE. If this variable isn't set, then the method returns the id of the language with the lowest sort order value. We assume that this language is the default language and will be used when no other language is specified. The default language is retrieved from the database first time round and is then stored in a static variable.

Returns:

the default Language object

Throws:

java.lang.Exception - an unexpected exception

getMsgValue

public java.lang.String getMsgValue(java.lang.String key,
                                    int type,
                                    java.lang.String localeString)
                             throws org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException,
                                    com.konakart.app.KKException

Get an Application Message Value. If locale is null, the default locale is used.

Specified by:

getMsgValue in interface LanguageMgrIf

Parameters:

key - the message key

type - the message type (should use KKConstants.MSG_TYP_APPLICATION for application messages)

localeString - the message locale (eg. "en_GB")

Returns:

The message for the key, type and locale. If the message isn't found the String "[key:type:locale]" is returned.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getMessages

public NameValue[] getMessages(int type,
                               java.lang.String localeString)
                        throws com.konakart.app.KKException,
                               com.workingdogs.village.DataSetException,
                               org.apache.torque.TorqueException

Used to fetch a message catalog for a locale and message type. If locale is null, the default locale is used.

Specified by:

getMessages in interface LanguageMgrIf

Parameters:

type - the message type (should use KKConstants.MSG_TYP_APPLICATION for application messages)

localeString - the message locale (eg. "en_GB")

Returns:

Returns and array of NameValue objects containing the message catalog

Throws:

com.konakart.app.KKException - an unexpected KKException exception

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the language manager

Specified by:

refreshConfigs in interface LanguageMgrIf

Throws:

java.lang.Exception - an unexpected exception