com.dpslink.flash.db.util

Class RelatedProductsHandler

java.lang.Object

com.dpslink.flash.db.util.DBUHandler

com.dpslink.flash.db.util.RelatedProductsHandler

All Implemented Interfaces:

DBUInterface, java.io.Serializable

public class RelatedProductsHandler
extends DBUHandler

Handles retrieving of products related to a product.

BOBW 02/25/2021 - A new sort code field has been added to the product group x-ref database table and to the delimited import file. In order to accommodate sites that have not had this new field added to the table, the code has been written to allow for the field to be missing.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RelatedProductsHandler.Relationship Inner class that defines a related product relationship.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	cvPgxNumFlds The number of fields in the product group x-ref database table.
private Product	ivProduct The current product being processed.
protected static boolean	RELATED_ICON A flag indicating whether to show the related items icon on the catalog grid and list pages as well as the review cart and favorite items pages, as defined by "Product.Catalog.Show.RelatedItemsIcon".
protected static java.lang.String[]	RELATED_TYPE An array of relationship type codes to include when determining if the related items icon should be displayed, as defined in properties by "Product.Catalog.Show.RelatedItemsType".
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.flash.db.util.DBUHandler

ivContext

Constructor Summary

Constructors

Constructor and Description
RelatedProductsHandler() Constructs a new instance of the related products handler with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	columnToString(java.sql.ResultSet rs, java.lang.String colname) Returns a String object from the given result set of database records for the specified column index.
java.util.ArrayList<RelatedProductsHandler.Relationship>	getRelatedProducts(Product product) Retrieves and returns a product's related products.
java.util.ArrayList<RelatedProductsHandler.Relationship>	getRelatedProductsForIcon(Product product) Retrieves and returns a product's related products for the purpose of displaying the related items icon on the catalog grid and list pages as well as the review cart and favorite items pages.
private java.util.ArrayList<RelatedProductsHandler.Relationship>	getRelationships(java.lang.String grpcode) Retrieves the relationships for a group and/or product/uom.
void	omitNoStockProducts(java.util.ArrayList<RelatedProductsHandler.Relationship> related) Removes products with no stock from .
private java.util.ArrayList<RelatedProductsHandler.Relationship>	processResultSet(java.sql.ResultSet rs) Processes the result set from the query of "getRelationships".
void	setRealtimeInfo(java.util.ArrayList<RelatedProductsHandler.Relationship> related) Sets the realtime information (current price, availability, etc.) for a set of related product relationships.

Methods inherited from class com.dpslink.flash.db.util.DBUHandler

getContext, setContext

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

RELATED_ICON

protected static final boolean RELATED_ICON

A flag indicating whether to show the related items icon on the catalog grid and list pages as well as the review cart and favorite items pages, as defined by "Product.Catalog.Show.RelatedItemsIcon".

RELATED_TYPE

protected static final java.lang.String[] RELATED_TYPE

An array of relationship type codes to include when determining if the related items icon should be displayed, as defined in properties by "Product.Catalog.Show.RelatedItemsType".

cvPgxNumFlds

private static int cvPgxNumFlds

The number of fields in the product group x-ref database table.

ivProduct

private Product ivProduct

The current product being processed.

Constructor Detail

RelatedProductsHandler

public RelatedProductsHandler()

Constructs a new instance of the related products handler with a null servlet or thread context.

A CONTEXT MUST BE SET BEFORE INVOKING ANY OTHER METHODS.

.

Method Detail

getRelatedProducts

public java.util.ArrayList<RelatedProductsHandler.Relationship> getRelatedProducts(Product product)

Retrieves and returns a product's related products.

Parameters:

product - (Product) The product for the desired related products.

Returns:

ArrayList - A collection of related product relationships. The collection is also stored in the given product object.

getRelatedProductsForIcon

public java.util.ArrayList<RelatedProductsHandler.Relationship> getRelatedProductsForIcon(Product product)

Retrieves and returns a product's related products for the purpose of displaying the related items icon on the catalog grid and list pages as well as the review cart and favorite items pages.

Parameters:

product - (Product) The product for the desired related products.

Returns:

ArrayList - A collection of related product relationships. The collection is also stored in the given product object.

omitNoStockProducts

public void omitNoStockProducts(java.util.ArrayList<RelatedProductsHandler.Relationship> related)

Removes products with no stock from . If all products for a relationship are removed then the relationship is also removed.

Parameters:

related - (ArrayList) The related product relationships to process.

setRealtimeInfo

public void setRealtimeInfo(java.util.ArrayList<RelatedProductsHandler.Relationship> related)

Sets the realtime information (current price, availability, etc.) for a set of related product relationships.

Parameters:

related - (ArrayList) The related product relationships to process.

getRelationships

private java.util.ArrayList<RelatedProductsHandler.Relationship> getRelationships(java.lang.String grpcode)

Retrieves the relationships for a group and/or product/uom.

Parameters:

grpcode - (String) The product group code for the desired relationships.

Returns:

ArrayList - A collection of related product relationships.

processResultSet

private java.util.ArrayList<RelatedProductsHandler.Relationship> processResultSet(java.sql.ResultSet rs)
                                                                           throws java.lang.Exception

Processes the result set from the query of "getRelationships".

Parameters:

rs - (ResultSet) The result of the query.

Returns:

ArrayList - A collection of related product relationships.

Throws:

java.lang.Exception - - if an error occurs while accessing the result set.

columnToString

private java.lang.String columnToString(java.sql.ResultSet rs,
                                        java.lang.String colname)
                                 throws java.sql.SQLException

Returns a String object from the given result set of database records for the specified column index.

Parameters:

rs - (ResultSet) The result set containing the database record from which a column's string value is to be retrieved.

colname - (String) The name of the column from which a string is to be retrieved and returned.

Returns:

String - The specified column's value as a String. A null column value is returned as an empty string.

Throws:

java.sql.SQLException - if an error occurs while processing the result set.