com.konakart.bl

Class CurrencyMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.CurrencyMgr

All Implemented Interfaces:

CurrencyMgrIf

public class CurrencyMgr
extends BaseMgr
implements CurrencyMgrIf

Currency Manager

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
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,CurrencyMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
CurrencyMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
Currency	fetchDefaultCurrency() The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.
java.lang.String	formatPrice(java.math.BigDecimal number, java.lang.String currencyCode) Used to create a string in order to visualise a price.
Currency[]	getCurrencies() This returns an array of currencies for all of the currencies in the currency table.
Currency	getCurrency(java.lang.String currencyCode) Returns the currency referenced by the currencyCode.
Currency	getDefaultCurrency() Returns the default currency from the cache.
java.text.DecimalFormat	getDefaultCurrencyFormatter() Gets the formatter for the default currency
int	getDefaultCurrencyScale() A utility method to return the scale of the default currency used in price calculations
protected java.text.DecimalFormat	getFormatter(Currency currency) Get a DecimalFormat object for a currency
void	refreshConfigs() Refresh the configuration of the currency 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

mutex

protected static java.lang.String mutex

Mutex for the Manager

staticDataHM

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

Hash Map that contains the static data

Constructor Detail

CurrencyMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getDefaultCurrency

public Currency getDefaultCurrency()
                            throws org.apache.torque.TorqueException,
                                   com.konakart.app.KKException,
                                   com.workingdogs.village.DataSetException

Description copied from interface: CurrencyMgrIf

Returns the default currency from the cache.

Specified by:

getDefaultCurrency in interface CurrencyMgrIf

Returns:

Returns the default currency object

Throws:

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

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

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

getDefaultCurrencyScale

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

Description copied from interface: CurrencyMgrIf

A utility method to return the scale of the default currency used in price calculations

Specified by:

getDefaultCurrencyScale in interface CurrencyMgrIf

Returns:

Returns the scale of the default currency

Throws:

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

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)

fetchDefaultCurrency

public Currency fetchDefaultCurrency()
                              throws java.lang.Exception

The default currency is referenced by a configuration variable called DEFAULT_CURRENCY. If this isn't found then we return the currency in the currency table with the lowest id. Once found, the default currency is cached.

Specified by:

fetchDefaultCurrency in interface CurrencyMgrIf

Returns:

Returns a currency

Throws:

java.lang.Exception - an unexpected exception

getDefaultCurrencyFormatter

public java.text.DecimalFormat getDefaultCurrencyFormatter()
                                                    throws org.apache.torque.TorqueException,
                                                           com.konakart.app.KKException,
                                                           com.workingdogs.village.DataSetException

Gets the formatter for the default currency

Specified by:

getDefaultCurrencyFormatter in interface CurrencyMgrIf

Returns:

Default currency formatter

Throws:

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

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

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

getCurrency

public Currency getCurrency(java.lang.String currencyCode)
                     throws com.konakart.app.KKException,
                            org.apache.torque.TorqueException,
                            com.workingdogs.village.DataSetException

Returns the currency referenced by the currencyCode.

Specified by:

getCurrency in interface CurrencyMgrIf

Parameters:

currencyCode - the currencyCode

Returns:

Returns a currency

Throws:

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

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)

getCurrencies

public Currency[] getCurrencies()
                         throws org.apache.torque.TorqueException,
                                com.workingdogs.village.DataSetException

This returns an array of currencies for all of the currencies in the currency table.

Specified by:

getCurrencies in interface CurrencyMgrIf

Returns:

Returns an array of currencies

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)

formatPrice

public java.lang.String formatPrice(java.math.BigDecimal number,
                                    java.lang.String currencyCode)
                             throws com.konakart.app.KKException,
                                    org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException

Used to create a string in order to visualise a price. It ensures that the decimal places, the thousands separator and the currency symbol are correct.

Specified by:

formatPrice in interface CurrencyMgrIf

Parameters:

number - the number

currencyCode - the currencyCode

Returns:

The formatted price

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)

getFormatter

protected java.text.DecimalFormat getFormatter(Currency currency)

Get a DecimalFormat object for a currency

Parameters:

currency - the currency

Returns:

Retuns a DecimalFormat object for the given currency

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the currency manager

Specified by:

refreshConfigs in interface CurrencyMgrIf

Throws:

java.lang.Exception - an unexpected exception