com.konakartadmin.bl

Class AdminLanguageMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminLanguageMgr

All Implemented Interfaces:

AdminLanguageMgrIf

public class AdminLanguageMgr
extends AdminBaseMgr
implements AdminLanguageMgrIf

The AdminLanguageMgr - for Managing Language Objects for the Admin Application

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminLanguageMgr.StaticData StaticData

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_LANGUAGES All languages indicator.
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,AdminLanguageMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminLanguageMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected int	addLanguageSearchCriteria(com.konakart.db.KKCriteria c, AdminLanguageSearch search)
protected void	addOrderBy(com.konakart.db.KKCriteria c, AdminLanguageSearch search) Add Order By clauses
int	deleteLanguage(int langId) Delete a Language
protected void	deriveDataLanguage(AdminLanguage lang)
boolean	doesLanguageExistForId(int langId) Checks to see whether a language already exists with this id
AdminLanguage	fetchDefaultLanguage() This fetches the default language regardless of whether it's already set.
int	fetchNumLanguages() This fetches the number of languages from the database for the current engine/store.
AdminLanguage[]	getAllLanguages() Returns an array of language objects that have been defined in the system.
AdminLanguage	getDefaultLanguage() Returns the default language
java.lang.String	getDefaultLanguageCode()
int	getDefaultLanguageId() Returns the default language id
java.lang.String	getDefaultLocale()
AdminLanguage	getLanguageByCode(java.lang.String code) Retrieves the language object referenced by the code (i.e.
AdminLanguage	getLanguageById(int languageId) Returns the language referenced by the language id
AdminLanguage	getLanguageById(int languageId, java.sql.Connection con) Returns the language referenced by the language id
AdminLanguage	getLanguageForLocale(java.lang.String locale) Retrieves the language for the locale
int	getLanguageIdForLocale(java.lang.String locale) Retrieves the language Id for the locale
AdminLanguageSearchResult	getLanguages(AdminLanguageSearch languageSearchOptions) This returns an AdminLanguageSearchResult object.
int	getNumLanguages() Returns the total number of languages defined for the store - it does not include the display-only languages
int	insertLanguage(AdminLanguage lang) Insert a Language
void	refreshConfigs() Retrieve some commonly-used properties
protected void	setDefaultLanguage() The default language is referenced by a configuration variable called DEFAULT_LANGUAGE.
void	setDefaultLanguage(java.lang.String langCode) Sets the default language.
protected void	setNumLanguages() The number of languages is retrieved from the database first time round and is then stored in a static variable.
int	updateLanguage(AdminLanguage lang) Update a Language

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, 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

ALL_LANGUAGES

public static final int ALL_LANGUAGES

All languages indicator.

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,AdminLanguageMgr.StaticData> staticDataHM

Hash Map that contains the static data

Constructor Detail

AdminLanguageMgr

public AdminLanguageMgr(KKAdminIf eng)
                 throws java.lang.Exception

Constructor

Parameters:

eng - KKAdmin engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getAllLanguages

public AdminLanguage[] getAllLanguages()
                                throws org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException,
                                       KKAdminException

Returns an array of language objects that have been defined in the system. It returns all languages in the database except those that are marked as display only.

Specified by:

getAllLanguages in interface AdminLanguageMgrIf

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)

KKAdminException - unexpected exception in the KonaKart Admin Engine

getLanguages

public AdminLanguageSearchResult getLanguages(AdminLanguageSearch languageSearchOptions)
                                       throws org.apache.torque.TorqueException,
                                              com.workingdogs.village.DataSetException,
                                              KKAdminException

Description copied from interface: AdminLanguageMgrIf

This returns an AdminLanguageSearchResult object. It allows you to search criteria for code and name and also to define whether or not you want to retrieve the display-only languages in addition to the data languages by setting the includeDisplayOnlyLangs attribute of the AdmnLanguageSearch object to true. The default behaviour is not to return the display-only languages.

Specified by:

getLanguages in interface AdminLanguageMgrIf

Parameters:

languageSearchOptions - the languageSearchOptions

Returns:

Returns an AdminLanguageSearchResult object

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

deriveDataLanguage

protected void deriveDataLanguage(AdminLanguage lang)
                           throws KKAdminException

Throws:

KKAdminException

getDefaultLanguageId

public int getDefaultLanguageId()
                         throws java.lang.Exception

Description copied from interface: AdminLanguageMgrIf

Returns the default language id

Specified by:

getDefaultLanguageId in interface AdminLanguageMgrIf

Returns:

Returns the default language id

Throws:

java.lang.Exception - an unexpected exception

getDefaultLanguage

public AdminLanguage getDefaultLanguage()
                                 throws java.lang.Exception

Description copied from interface: AdminLanguageMgrIf

Returns the default language

Specified by:

getDefaultLanguage in interface AdminLanguageMgrIf

Returns:

Returns the default language object

Throws:

java.lang.Exception - an unexpected exception

getNumLanguages

public int getNumLanguages()
                    throws java.lang.Exception

Description copied from interface: AdminLanguageMgrIf

Returns the total number of languages defined for the store - it does not include the display-only languages

Specified by:

getNumLanguages in interface AdminLanguageMgrIf

Returns:

Returns the total number of languages defined for the store

Throws:

java.lang.Exception - an unexpected exception

getLanguageById

public AdminLanguage getLanguageById(int languageId)
                              throws java.lang.Exception

Description copied from interface: AdminLanguageMgrIf

Returns the language referenced by the language id

Specified by:

getLanguageById in interface AdminLanguageMgrIf

Parameters:

languageId - the languageId

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

getLanguageById

public AdminLanguage getLanguageById(int languageId,
                                     java.sql.Connection con)
                              throws java.lang.Exception

Description copied from interface: AdminLanguageMgrIf

Returns the language referenced by the language id

Specified by:

getLanguageById in interface AdminLanguageMgrIf

Parameters:

languageId - the languageId

con - Connection for transaction

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

getLanguageByCode

public AdminLanguage getLanguageByCode(java.lang.String code)
                                throws java.lang.Exception

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

Specified by:

getLanguageByCode in interface AdminLanguageMgrIf

Parameters:

code - the code

Returns:

Returns a language object

Throws:

java.lang.Exception - an unexpected exception

getLanguageIdForLocale

public int getLanguageIdForLocale(java.lang.String locale)
                           throws java.lang.Exception

Retrieves the language Id for the locale

Specified by:

getLanguageIdForLocale in interface AdminLanguageMgrIf

Parameters:

locale - a 2 or 4 character locale (eg. en, de, es)

Returns:

Returns the languageId of the matching language or the languageId of the default language if no matching language was found.

Throws:

java.lang.Exception - an unexpected exception

getLanguageForLocale

public AdminLanguage getLanguageForLocale(java.lang.String locale)
                                   throws java.lang.Exception

Description copied from interface: AdminLanguageMgrIf

Retrieves the language for the locale

Specified by:

getLanguageForLocale in interface AdminLanguageMgrIf

Parameters:

locale - a 2 or 4 character locale (eg. en, de, es)

Returns:

Returns the language of the matching language or the default language if no matching language was found.

Throws:

java.lang.Exception - an unexpected exception

setDefaultLanguage

public void setDefaultLanguage(java.lang.String langCode)
                        throws java.lang.Exception

Sets the default language. Sets a configuration variable called DEFAULT_LANGUAGE.

Specified by:

setDefaultLanguage in interface AdminLanguageMgrIf

Parameters:

langCode - the langCode

Throws:

java.lang.Exception - an unexpected exception

setDefaultLanguage

protected void setDefaultLanguage()
                           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.

Throws:

java.lang.Exception - an unexpected exception

setNumLanguages

protected void setNumLanguages()
                        throws java.lang.Exception

The number of languages is retrieved from the database first time round and is then stored in a static variable.

Throws:

java.lang.Exception - an unexpected exception

fetchDefaultLanguage

public AdminLanguage fetchDefaultLanguage()
                                   throws java.lang.Exception

This fetches the default language regardless of whether it's already set. 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

Throws:

java.lang.Exception - an unexpected exception

fetchNumLanguages

public int fetchNumLanguages()
                      throws java.lang.Exception

This fetches the number of languages from the database for the current engine/store. It does not include the display-only languages.

Returns:

the number of languages in the database for the current engine/store

Throws:

java.lang.Exception - an unexpected exception

addLanguageSearchCriteria

protected int addLanguageSearchCriteria(com.konakart.db.KKCriteria c,
                                        AdminLanguageSearch search)
                                 throws KKAdminException

Throws:

KKAdminException

deleteLanguage

public int deleteLanguage(int langId)
                   throws KKAdminException

Delete a Language

Specified by:

deleteLanguage in interface AdminLanguageMgrIf

Parameters:

langId - A language id

Returns:

returns the id of the deleted language

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

insertLanguage

public int insertLanguage(AdminLanguage lang)
                   throws KKAdminException

Insert a Language

Specified by:

insertLanguage in interface AdminLanguageMgrIf

Parameters:

lang - A language object

Returns:

returns the id of the inserted language

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

updateLanguage

public int updateLanguage(AdminLanguage lang)
                   throws java.lang.Exception

Update a Language

Specified by:

updateLanguage in interface AdminLanguageMgrIf

Parameters:

lang - A language object

Returns:

returns the id of the updated language

Throws:

java.lang.Exception - an unexpected exception

doesLanguageExistForId

public boolean doesLanguageExistForId(int langId)
                               throws org.apache.torque.TorqueException,
                                      KKAdminException

Checks to see whether a language already exists with this id

Specified by:

doesLanguageExistForId in interface AdminLanguageMgrIf

Parameters:

langId - the langId

Returns:

Returns true if the customer already exists

Throws:

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

KKAdminException - unexpected exception in the KonaKart Admin Engine

addOrderBy

protected void addOrderBy(com.konakart.db.KKCriteria c,
                          AdminLanguageSearch search)

Add Order By clauses

Parameters:

c - the c

search - the search

getDefaultLocale

public java.lang.String getDefaultLocale()
                                  throws KKAdminException

Specified by:

getDefaultLocale in interface AdminLanguageMgrIf

Returns:

Returns the default locale

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getDefaultLanguageCode

public java.lang.String getDefaultLanguageCode()
                                        throws KKAdminException

Specified by:

getDefaultLanguageCode in interface AdminLanguageMgrIf

Returns:

Returns the default 2-character language code

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Retrieve some commonly-used properties

Specified by:

refreshConfigs in interface AdminLanguageMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception