Package com.softslate.commerce.businessobjects.product

Class BasicProductProcessor

java.lang.Object

com.softslate.commerce.businessobjects.core.BaseBusinessObject

com.softslate.commerce.businessobjects.core.BaseBusinessProcessor

com.softslate.commerce.businessobjects.product.BasicProductProcessor

All Implemented Interfaces:

BusinessObject, BusinessProcessor, ProductProcessor

public class BasicProductProcessor
extends BaseBusinessProcessor
implements ProductProcessor

Processes business logic affecting products and other related objects. BasicProductProcessor is the default implementation of the ProductProcessor interface for the application.

Author:

David Tobey

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor	Description
BasicProductProcessor()

Method Summary

Modifier and Type	Method	Description
Map	addProduct(Map parameters)
protected void	appendToCategoryMap(Map categoryMap, Collection categories)
Collection	buildMatrix(Product product)
Collection	buildMatrix(Product product, Integer attributeLimit, List<Integer> includedAttributeIDs, List<Integer> includedOptionIds)
boolean	buildMatrix(Collection matrix, Collection options, Collection attributes, Product product, Integer attributeLimit, List<Integer> includedAttributeIDs, List<Integer> includedOptionIds)
Map	cloneProduct(Map parameters)
Map	createCategoryMapFromCategoryTree(Collection categoryTree)
Map	deleteProduct(Map parameters)
Attribute	duplicateAttribute(Attribute attribute, Map parameters)
Product	duplicateProduct(Product product, Map parameters)
Map	editDeleteProducts(Map parameters)
Map	editProduct(Map parameters)
Map	editProductAssignment(Map parameters)
HashMap	generateSettingsMap(Collection settings)
Collection	getAllAttributesAndOptions(int productID)
Category	getCategoryFromCode(Category category)	Retrieves category information from the database.
Category	getCategoryFromCode(Category category, boolean loadProducts)	Retrieves category information from the database.
Product	getProductFromCode(Product product)	Retrieves product information from the database.
Product	getProductFromSeoCode(Product product)	Retrieves product information from the database.
ProductList	getProductList(ProductList productList)	Retrieves information for a list of products from the database.
Collection	loadActiveProductNamesCodesIDs()
Collection	loadAllProductNamesCodesIDs()
Collection	loadAllProducts()
Collection	loadAllProductsSortedByCode()
Collection	loadAllProductsSortedByName()
Collection	loadAttributeSKUCollection()	Retrieves all SKUs associated with attributes but not products, as a Collection of SKUs.
Map	loadAttributeSKUs()	Retrieves all SKUs associated with attributes but not products.
Collection	loadBuiltInCategories()	Retrieves a Collection containing built-in categories for the store.
Collection	loadCategories(String categoryList)	Retrieves a Collection containing categories corresponding to the codes of the argument.
Collection	loadCategoryTree()	Retrieves a Collection representing the store's category tree.
int	loadMaxProductID()
Product	loadProductFromCode(Product product)
Product	loadProductFromCode(String code)
Product	loadProductFromCode(Map parameters)
Product	loadProductFromID(int productID)
Product	loadProductFromID(Map parameters)
Map	loadProductsAndCount(Map parameters)
Collection	loadProductsForIndexing(int firstProductID, int lastProductID)
Collection	loadSettings(Map parameters)
Map	postChangingProductEvent(Product product, Map parameters)
Collection	processSettings(Map parameters)
Map	sortProductsByCode(Map parameters)
Map	sortProductsByName(Map parameters)
Map	validateProduct(Product product)

Methods inherited from class com.softslate.commerce.businessobjects.core.BaseBusinessProcessor

formatDateTime, formatPrice, getAppComponents, getAppSettings, getAttributeIDs, getBusinessObjectFactory, getDaoFactory, getEventBus, getInjector, getProductIDs, getSettings, getUser, initialize, isProcessorClassActive, loadMatchingSkus, parseDateTime, parseResponseData, prepareRequestData, sendHTTPGet, sendHTTPPost, sendHTTPPost, setAppComponents, setAppSettings, setBusinessObjectFactory, setDaoFactory, setEventBus, setInjector, setSettings, setUser, updateOrderTotals, updateOrderTotals, updateOrderTotals, utils

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessObject

initialize

Field Details

log

static org.apache.commons.logging.Log log

Constructor Details

BasicProductProcessor

public BasicProductProcessor()

Method Details

loadCategoryTree

public Collection loadCategoryTree()
                            throws Exception

Description copied from interface: ProductProcessor

Retrieves a Collection representing the store's category tree. Each item in the Collection is an instance of Category, which corresponds to each one of the "top level" categories defined in the store (i.e., categories whose parentCategory property is null). To render the tree, iterate through the top level categories and recursively navigate through each of their subcategoryCollections in turn.

The default implementation of this method calls ProductGatewayDAOHibernate.loadCategoryTree(), which uses Hibernate.initialize(java.lang.Object) to pull the entire tree from the database non-lazily.

Specified by:

loadCategoryTree in interface ProductProcessor

Returns:

A Collection representing the store's category tree.

Throws:

Exception

createCategoryMapFromCategoryTree

public Map createCategoryMapFromCategoryTree(Collection categoryTree)

Specified by:

createCategoryMapFromCategoryTree in interface ProductProcessor

appendToCategoryMap

protected void appendToCategoryMap(Map categoryMap,
 Collection categories)

loadBuiltInCategories

public Collection loadBuiltInCategories()
                                 throws Exception

Description copied from interface: ProductProcessor

Retrieves a Collection containing built-in categories for the store. Each item in the Collection is an instance of Category. Built-in categories are typically composed of specials or other featured products that need to displayed on arbitrary pages thoughout the store.

Built-in categories are definined by the "builtInCategories" setting in the sscSetting database table, a comma-separated list of category codes.

Specified by:

loadBuiltInCategories in interface ProductProcessor

Returns:

A Collection of Category objects representing the store's built-in categories.

Throws:

Exception

loadCategories

public Collection loadCategories(String categoryList)
                          throws Exception

Description copied from interface: ProductProcessor

Retrieves a Collection containing categories corresponding to the codes of the argument. Each item in the Collection is an instance of Category. This method is used to populate the 'headerCategoriesAndContentPages' and 'footerCategoriesAndContentPages' - the categories that appear as links in the header and footer of the store.

Specified by:

loadCategories in interface ProductProcessor

Returns:

A Collection of Category objects representing the store's built-in categories.

Throws:

Exception

getProductFromCode

public Product getProductFromCode(Product product)
                           throws Exception

Description copied from interface: ProductProcessor

Retrieves product information from the database. In the default implementation, this method calls ProductDAO.loadProduct() to populate the incoming Product using its code.

Specified by:

getProductFromCode in interface ProductProcessor

Parameters:

product - A Product object whose code property has been populated.

Returns:

A Product object with all its properties populated from the database. If the product does not exist in the database, null.

Throws:

Exception

getProductFromSeoCode

public Product getProductFromSeoCode(Product product)
                              throws Exception

Description copied from interface: ProductProcessor

Retrieves product information from the database. In the default implementation, this method calls ProductDAO.loadProductFromSeoCode() to populate the incoming Product using its seoCode.

Specified by:

getProductFromSeoCode in interface ProductProcessor

Parameters:

product - A Product object whose seoCode property has been populated.

Returns:

A Product object with all its properties populated from the database. If the product does not exist in the database, null.

Throws:

Exception

loadAttributeSKUs

public Map loadAttributeSKUs()
                      throws Exception

Description copied from interface: ProductProcessor

Retrieves all SKUs associated with attributes but not products.

Specified by:

loadAttributeSKUs in interface ProductProcessor

Returns:

A Map of all the SKUs in the system associated with attributes but not products.

Throws:

Exception

loadAttributeSKUCollection

public Collection loadAttributeSKUCollection()
                                      throws Exception

Description copied from interface: ProductProcessor

Retrieves all SKUs associated with attributes but not products, as a Collection of SKUs.

Specified by:

loadAttributeSKUCollection in interface ProductProcessor

Returns:

A Collection of all the SKUs in the system associated with attributes but not products.

Throws:

Exception

getCategoryFromCode

public Category getCategoryFromCode(Category category)
                             throws Exception

Description copied from interface: ProductProcessor

Retrieves category information from the database. In the default implementation, this method calls getCategoryFromCode(Category category, boolean loadProducts) with the loadProducts parameter set to true. category tree.

Specified by:

getCategoryFromCode in interface ProductProcessor

Parameters:

category - A Category object whose code property has been populated.

Returns:

A Category object with all its properties populated from the database. If the category does not exist in the database, null.

Throws:

Exception

getCategoryFromCode

public Category getCategoryFromCode(Category category,
 boolean loadProducts)
                             throws Exception

Description copied from interface: ProductProcessor

Retrieves category information from the database. In the default implementation, this method calls CategoryDAO.loadCategory() to populate the incoming Category using its code.

If the loadProducts parameter is set to true, in addition to all of the category's regular properties, its productListCollection is populated with just those Products falling on the current page being displayed. The paging parameters for the number of items to display and which page to display come from the incoming Category's itemsPerPage and firstRow properties, respectively.

The method ProductGatewayDAO.loadProductList(ProductList) is used to pull in the category's products.

Also in the default implementation, the Category's parentCollection and parentString properties are set by calling CategoryDAO.loadParents(). These properties are used in breadcrumbing and in the display of the category tree.

Specified by:

getCategoryFromCode in interface ProductProcessor

Parameters:

category - A Category object whose code property has been populated.

loadProducts - If set to true, the category's products will be loaded into the category's productListCollection property.

Returns:

A Category object with all its properties populated from the database. If the category does not exist in the database, null.

Throws:

Exception

generateSettingsMap

public HashMap generateSettingsMap(Collection settings)
                            throws Exception

Specified by:

generateSettingsMap in interface ProductProcessor

Throws:

Exception

getAllAttributesAndOptions

public Collection getAllAttributesAndOptions(int productID)
                                      throws Exception

Specified by:

getAllAttributesAndOptions in interface ProductProcessor

Throws:

Exception

getProductList

public ProductList getProductList(ProductList productList)
                           throws Exception

Description copied from interface: ProductProcessor

Retrieves information for a list of products from the database. Depending on the value of the productListType for the ProductList, the products could be the entire list of products in the system, the products under a given category, or the products matching a given search request.

Specified by:

getProductList in interface ProductProcessor

Parameters:

productList - A ProductList object whose itemsPerPage,firstCode, productListType, and optionally categoryID or searchString and stopWords properties have been set.

Returns:

A ProductList object with all its properties populated from the database.

Throws:

Exception

loadAllProducts

public Collection loadAllProducts()
                           throws Exception

Specified by:

loadAllProducts in interface ProductProcessor

Throws:

Exception

loadMaxProductID

public int loadMaxProductID()
                     throws Exception

Specified by:

loadMaxProductID in interface ProductProcessor

Throws:

Exception

loadProductsForIndexing

public Collection loadProductsForIndexing(int firstProductID,
 int lastProductID)
                                   throws Exception

Specified by:

loadProductsForIndexing in interface ProductProcessor

Throws:

Exception

sortProductsByName

public Map sortProductsByName(Map parameters)
                       throws Exception

Specified by:

sortProductsByName in interface ProductProcessor

Throws:

Exception

loadAllProductsSortedByName

public Collection loadAllProductsSortedByName()
                                       throws Exception

Throws:

Exception

sortProductsByCode

public Map sortProductsByCode(Map parameters)
                       throws Exception

Specified by:

sortProductsByCode in interface ProductProcessor

Throws:

Exception

loadAllProductsSortedByCode

public Collection loadAllProductsSortedByCode()
                                       throws Exception

Throws:

Exception

loadAllProductNamesCodesIDs

public Collection loadAllProductNamesCodesIDs()
                                       throws Exception

Specified by:

loadAllProductNamesCodesIDs in interface ProductProcessor

Throws:

Exception

loadActiveProductNamesCodesIDs

public Collection loadActiveProductNamesCodesIDs()
                                          throws Exception

Specified by:

loadActiveProductNamesCodesIDs in interface ProductProcessor

Throws:

Exception

loadProductsAndCount

public Map loadProductsAndCount(Map parameters)
                         throws Exception

Specified by:

loadProductsAndCount in interface ProductProcessor

Throws:

Exception

addProduct

public Map addProduct(Map parameters)
               throws Exception

Specified by:

addProduct in interface ProductProcessor

Throws:

Exception

loadProductFromID

public Product loadProductFromID(Map parameters)
                          throws Exception

Specified by:

loadProductFromID in interface ProductProcessor

Throws:

Exception

loadProductFromID

public Product loadProductFromID(int productID)
                          throws Exception

Throws:

Exception

loadProductFromCode

public Product loadProductFromCode(Map parameters)
                            throws Exception

Specified by:

loadProductFromCode in interface ProductProcessor

Throws:

Exception

loadProductFromCode

public Product loadProductFromCode(String code)
                            throws Exception

Specified by:

loadProductFromCode in interface ProductProcessor

Throws:

Exception

editProduct

public Map editProduct(Map parameters)
                throws Exception

Specified by:

editProduct in interface ProductProcessor

Throws:

Exception

postChangingProductEvent

public Map postChangingProductEvent(Product product,
 Map parameters)
                             throws Exception

Specified by:

postChangingProductEvent in interface ProductProcessor

Throws:

Exception

editDeleteProducts

public Map editDeleteProducts(Map parameters)
                       throws Exception

Specified by:

editDeleteProducts in interface ProductProcessor

Throws:

Exception

deleteProduct

public Map deleteProduct(Map parameters)
                  throws Exception

Specified by:

deleteProduct in interface ProductProcessor

Throws:

Exception

validateProduct

public Map validateProduct(Product product)
                    throws Exception

Throws:

Exception

loadSettings

public Collection loadSettings(Map parameters)
                        throws Exception

Specified by:

loadSettings in interface ProductProcessor

Throws:

Exception

processSettings

public Collection processSettings(Map parameters)
                           throws Exception

Specified by:

processSettings in interface ProductProcessor

Throws:

Exception

buildMatrix

public Collection buildMatrix(Product product)

Specified by:

buildMatrix in interface ProductProcessor

buildMatrix

public Collection buildMatrix(Product product,
 Integer attributeLimit,
 List<Integer> includedAttributeIDs,
 List<Integer> includedOptionIds)

Specified by:

buildMatrix in interface ProductProcessor

buildMatrix

public boolean buildMatrix(Collection matrix,
 Collection options,
 Collection attributes,
 Product product,
 Integer attributeLimit,
 List<Integer> includedAttributeIDs,
 List<Integer> includedOptionIds)

cloneProduct

public Map cloneProduct(Map parameters)
                 throws Exception

Specified by:

cloneProduct in interface ProductProcessor

Throws:

Exception

duplicateProduct

public Product duplicateProduct(Product product,
 Map parameters)
                         throws Exception

Throws:

Exception

duplicateAttribute

public Attribute duplicateAttribute(Attribute attribute,
 Map parameters)
                             throws Exception

Throws:

Exception

loadProductFromCode

public Product loadProductFromCode(Product product)
                            throws Exception

Specified by:

loadProductFromCode in interface ProductProcessor

Throws:

Exception

editProductAssignment

public Map editProductAssignment(Map parameters)
                          throws Exception

Specified by:

editProductAssignment in interface ProductProcessor

Throws:

Exception