com.konakart.bl

Class CategoryMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.CategoryMgr

All Implemented Interfaces:

CategoryMgrIf

public class CategoryMgr
extends BaseMgr
implements CategoryMgrIf

Manages all business logic relevant to the management of categories within the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CategoryMgr.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
protected static java.util.Map<java.lang.String,CategoryMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
CategoryMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected Category[]	cloneTree(Category[] tree)
protected Category[]	createCategoryTree(int languageId) Creates a category tree with a single query
protected void	fillCatTreeWithProductNumbers(Category[] catTree, CategoryTreeOptionsIf options) Receives an array of Categories as input and compiles the numberOfProducts field for each Category
Category[]	getCategoriesForCatalogId(java.lang.String catalogId, int languageId) Return an array of categories for the catalogId passed.
Category[]	getCategoriesFromIds(java.util.ArrayList<java.lang.Integer> catIdList, int languageId) Return an array of categories for the ids passed in through the catIdList parameter.
Category[]	getCategoriesPerManufacturer(int manufacturerId, int languageId) Returns an array of leaf Category objects for the given manufacturer.
Category[]	getCategoriesPerProduct(int productId, int languageId) Returns an array of Category objects that the product belongs to.
Category	getCategory(int categoryId, int languageId)
protected Category[]	getCategoryTree(int languageId) Calls getCategoryTree(int languageId, boolean getNumProducts)
Category[]	getCategoryTree(int languageId, boolean getNumProducts) Returns an array of top level categories each of which includes an array of child categories etc.
Category[]	getCategoryTreeWithOptions(CategoryTreeOptionsIf options) Returns a category tree structure consisting of an array of top level categories, each of which may contain an array of child categories.
int[]	getChildren(int categoryId) Returns an array of categoryId describing the children of the given category.
CategoryStats	getLastModifiedData() Retrieves the date of the last modified category and the number of categories in the database.
protected int	getNumProductsPerCategory(int categoryId) Returns the number of products for a leaf category by doing a direct query on the database.
int[]	getParents(int categoryId) Returns an array of categoryId describing the given category and its parents.
protected java.util.HashMap<java.lang.Integer,java.lang.Integer>	getProductsPerCategory(CategoryTreeOptionsIf options) Returns a HashMap with CategoryId as the key and Number of Products for that category as the value.
protected void	initStaticVariables(CategoryStats catStats) A synchronized method to initialise the static variables
void	setCategoryLevel(Category cat, int level) Recursive method to set the category level
protected void	setChildrenProductNumbers(Category parent, java.util.HashMap<java.lang.Integer,java.lang.Integer> hm) Recurses through all of the category tree setting the numberOfProducts attribute.
protected void	setCriteriaWithStandardAttributes(KKCriteria c, int languageId) Sets the criteria with the standard attributes so as not to have to repeat this code many times.
protected void	setCriteriaWithStandardAttributes(KKCriteria c, int languageId, boolean addDescription) Sets the criteria with the standard attributes so as not to have to repeat this code many times.

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

staticDataHM

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

Hash Map that contains the static data

Constructor Detail

CategoryMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getCategoryTree

protected Category[] getCategoryTree(int languageId)
                              throws java.lang.Exception

Calls getCategoryTree(int languageId, boolean getNumProducts)

Parameters:

languageId - the languageId

Returns:

Array of Category Objects

Throws:

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

java.lang.Exception - an unexpected exception

getCategoryTree

public Category[] getCategoryTree(int languageId,
                                  boolean getNumProducts)
                           throws java.lang.Exception

Returns an array of top level categories each of which includes an array of child categories etc. so that the category tree structure can be navigated. Since the categories are not changed very often and the process of building the tree requires the execution of many database queries, we keep a static version of the tree which is only changed if we realise that a category has been modified by looking at the last_modified field. Since a category may also be deleted, we look at the number of categories also to see whether it has changed.

Each Category class contains a field that describes how many products exist for that category. This field is not set in the static tree and we calculate it each time on demand since it only involves one database query and the product information is a lot more dynamic than that of the categories. We only calculate it if getNumProducts is set.

Specified by:

getCategoryTree in interface CategoryMgrIf

Parameters:

languageId - the languageId

getNumProducts - the getNumProducts

Returns:

Array of Category Objects

Throws:

java.lang.Exception - an unexpected exception

getCategoryTreeWithOptions

public Category[] getCategoryTreeWithOptions(CategoryTreeOptionsIf options)
                                      throws java.lang.Exception

Returns a category tree structure consisting of an array of top level categories, each of which may contain an array of child categories.

The name of the category is language dependent and will be returned in the language defined by the languageId parameter of the CategoryTreeObject.

Each Category class contains a numberOfProducts field that describes how many products exist for that category. It is only calculated if the getNumProducts input parameter of the CategoryTreeOptions object is set to true. For performance reasons this parameter should be set to false if numberOfProducts is not required.

If the CategoryTreeOptions object has its returnClonedTree attribute set to true a cloned version of the category tree will be returned.

Specified by:

getCategoryTreeWithOptions in interface CategoryMgrIf

Parameters:

options - Category tree options object.

Returns:

Array of Category objects

Throws:

java.lang.Exception - an unexpected exception

cloneTree

protected Category[] cloneTree(Category[] tree)
                        throws java.lang.Exception

Throws:

java.lang.Exception

initStaticVariables

protected void initStaticVariables(CategoryStats catStats)
                            throws com.konakart.app.KKException

A synchronized method to initialise the static variables

Parameters:

catStats - the catStats

Throws:

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

createCategoryTree

protected Category[] createCategoryTree(int languageId)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        com.konakart.app.KKException

Creates a category tree with a single query

Parameters:

languageId - the languageId

Returns:

Array of Category 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

setCategoryLevel

public void setCategoryLevel(Category cat,
                             int level)

Recursive method to set the category level

Parameters:

cat - the cat

level - the level

getCategoriesPerManufacturer

public Category[] getCategoriesPerManufacturer(int manufacturerId,
                                               int languageId)
                                        throws java.lang.Exception

Returns an array of leaf Category objects for the given manufacturer.

Specified by:

getCategoriesPerManufacturer in interface CategoryMgrIf

Parameters:

manufacturerId - the manufacturerId

languageId - the languageId

Returns:

Return an array of category objects

Throws:

java.lang.Exception - an unexpected exception

getCategoriesPerProduct

public Category[] getCategoriesPerProduct(int productId,
                                          int languageId)
                                   throws java.lang.Exception

Returns an array of Category objects that the product belongs to.

Specified by:

getCategoriesPerProduct in interface CategoryMgrIf

Parameters:

productId - the productId

languageId - the languageId

Returns:

Return an array of category objects

Throws:

java.lang.Exception - an unexpected exception

getProductsPerCategory

protected java.util.HashMap<java.lang.Integer,java.lang.Integer> getProductsPerCategory(CategoryTreeOptionsIf options)
                                                                                 throws org.apache.torque.TorqueException,
                                                                                        com.workingdogs.village.DataSetException,
                                                                                        com.konakart.app.KKException

Returns a HashMap with CategoryId as the key and Number of Products for that category as the value. The products need to have a non 0 status and not be invisible to be considered.

Parameters:

options - Category tree options object.

Returns:

HashMap Contains number of products per category

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

getNumProductsPerCategory

protected int getNumProductsPerCategory(int categoryId)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        com.konakart.app.KKException

Returns the number of products for a leaf category by doing a direct query on the database. The products need to have a non 0 status to be considered.

Parameters:

categoryId - the categoryId

Returns:

Return an int defining the number of products per category

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

getLastModifiedData

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

Retrieves the date of the last modified category and the number of categories in the database. It will be used to identify whether any category has been changed. If the last_modified column doesn't contain any valid dates, then we return the current date since we have to assume worst case that some category has been modified.

Returns:

CategoryStats An object containing last modification date and number of categories

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

fillCatTreeWithProductNumbers

protected void fillCatTreeWithProductNumbers(Category[] catTree,
                                             CategoryTreeOptionsIf options)
                                      throws org.apache.torque.TorqueException,
                                             com.workingdogs.village.DataSetException,
                                             com.konakart.app.KKException

Receives an array of Categories as input and compiles the numberOfProducts field for each Category

Parameters:

catTree - the catTree

options - Category tree options 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

setChildrenProductNumbers

protected void setChildrenProductNumbers(Category parent,
                                         java.util.HashMap<java.lang.Integer,java.lang.Integer> hm)
                                  throws com.workingdogs.village.DataSetException

Recurses through all of the category tree setting the numberOfProducts attribute.

Parameters:

parent - The parent category.

hm - the hm

Throws:

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

getChildren

public int[] getChildren(int categoryId)
                  throws java.lang.Exception

Returns an array of categoryId describing the children of the given category. Returns null if there are no children.

Specified by:

getChildren in interface CategoryMgrIf

Parameters:

categoryId - the categoryId

Returns:

Return an array of categoryId

Throws:

java.lang.Exception - an unexpected exception

getParents

public int[] getParents(int categoryId)
                 throws java.lang.Exception

Returns an array of categoryId describing the given category and its parents. Returns just the given category id in the array if there are no parents (i.e. It is a top level node).

Specified by:

getParents in interface CategoryMgrIf

Parameters:

categoryId - the categoryId

Returns:

Return an array of categoryId

Throws:

java.lang.Exception - an unexpected exception

getCategory

public Category getCategory(int categoryId,
                            int languageId)
                     throws java.lang.Exception

Specified by:

getCategory in interface CategoryMgrIf

Parameters:

categoryId - the categoryId

languageId - the languageId

Returns:

Return a fully populated single category object (no children)

Throws:

java.lang.Exception - an unexpected exception

setCriteriaWithStandardAttributes

protected void setCriteriaWithStandardAttributes(KKCriteria c,
                                                 int languageId)

Sets the criteria with the standard attributes so as not to have to repeat this code many times.

Parameters:

c - the c

languageId - the languageId

setCriteriaWithStandardAttributes

protected void setCriteriaWithStandardAttributes(KKCriteria c,
                                                 int languageId,
                                                 boolean addDescription)

Sets the criteria with the standard attributes so as not to have to repeat this code many times.

Parameters:

c - the c

languageId - the languageId

addDescription - the addDescription

getCategoriesFromIds

public Category[] getCategoriesFromIds(java.util.ArrayList<java.lang.Integer> catIdList,
                                       int languageId)
                                throws java.lang.Exception

Return an array of categories for the ids passed in through the catIdList parameter.

Specified by:

getCategoriesFromIds in interface CategoryMgrIf

Parameters:

catIdList - An array list containing ids of categories

languageId - the languageId

Returns:

An array of categories for the ids passed in

Throws:

java.lang.Exception - an unexpected exception

getCategoriesForCatalogId

public Category[] getCategoriesForCatalogId(java.lang.String catalogId,
                                            int languageId)
                                     throws java.lang.Exception

Return an array of categories for the catalogId passed.

Specified by:

getCategoriesForCatalogId in interface CategoryMgrIf

Parameters:

catalogId - catalog Id

languageId - language Id

Returns:

an array of Category objects for the specified category Id

Throws:

java.lang.Exception - an unexpected exception