com.dpslink.flash.db.util

Class UserCatalog

java.lang.Object

com.dpslink.flash.db.util.UserCatalog

All Implemented Interfaces:

java.io.Serializable

public class UserCatalog
extends java.lang.Object
implements java.io.Serializable

A companion class for UserCatalogVerifier. Maintains cached maps of products and the catalog category codes that each product is assigned to.

THIS CLASS SHOULD ONLY BE REFERENCED BY UserCatalogVerifier.

When permit processing is active, a separate instance of this class is created for each site user.

When permit processing is not active, a single instance of this class is created and used for all site users.

The primary map is keyed by product code and unit of measure code. A secondary map of products is also maintained that is keyed by product code only (no unit of measure).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	UserCatalog.MapKey An inner class that defines the key for a catalog mapping.

Field Summary

Fields

Modifier and Type	Field and Description
private static UserCatalog	cvInstance The shared instance of this class.
private static java.util.HashMap<java.lang.String,java.lang.String[]>	cvTopMostCategories A map of arrays of category codes for each category used as a topmost category for a user.
private java.util.HashMap<UserCatalog.MapKey,java.util.ArrayList<java.lang.String>>	ivCatalog1 A map of products and the categories each product is assigned to.
private java.util.HashMap<UserCatalog.MapKey,java.util.ArrayList<java.lang.String>>	ivCatalog2 A map of products and the categories each product is assigned to.
private java.lang.String	ivPermitId The customer id or user id associated with the catalog.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UserCatalog() Creates a new user catalog.
	UserCatalog(java.lang.String permitid) Creates a new user catalog.

Method Summary

Modifier and Type	Method and Description
private java.lang.String[]	buildCategoriesForTopMost(JDBCConnectionInfo cninf, Category topmost) Returns an array of the category codes starting with the given topmost category.
java.util.ArrayList<java.lang.String>	getCategories(JDBCConnectionInfo cninf, java.lang.String prodcode) Returns a product's set of assigned catalog category codes.
java.util.ArrayList<java.lang.String>	getCategories(JDBCConnectionInfo cninf, java.lang.String prodcode, java.lang.String uomcode) Returns a product's set of assigned catalog category codes.
java.lang.String[]	getCategoriesForTopMost(JDBCConnectionInfo cninf, Category topmost) Returns a cached array of the category codes starting with the given topmost category.
java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>	getTopMostByCategoryMap(JDBCConnectionInfo cninf) Create a map of categories and their associated topmost categories by iterating through the topmost category cache and essentially reversing it so we have a map keyed by the child category.
void	init(JDBCConnectionInfo cninf) Initialize the various caches associated with this instance of the object.
static UserCatalog	instance() Returns the shared instance of this class.
private void	loadCatalog1(JDBCConnectionInfo cninf) Loads the primary map of products and their assigned catalog category codes.
private void	loadCatalog2(JDBCConnectionInfo cninf) Loads the secondary map of products and their assigned catalog category codes.

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

cvInstance

private static UserCatalog cvInstance

The shared instance of this class.

cvTopMostCategories

private static java.util.HashMap<java.lang.String,java.lang.String[]> cvTopMostCategories

A map of arrays of category codes for each category used as a topmost category for a user.

ivCatalog1

private java.util.HashMap<UserCatalog.MapKey,java.util.ArrayList<java.lang.String>> ivCatalog1

A map of products and the categories each product is assigned to. Includes unit of measure.

ivCatalog2

private java.util.HashMap<UserCatalog.MapKey,java.util.ArrayList<java.lang.String>> ivCatalog2

A map of products and the categories each product is assigned to. Excludes unit of measure.

ivPermitId

private java.lang.String ivPermitId

The customer id or user id associated with the catalog. Only valid when permit processing is active.

Constructor Detail

UserCatalog

private UserCatalog()

Creates a new user catalog.

UserCatalog

public UserCatalog(java.lang.String permitid)

Creates a new user catalog. This constructor should only be used when permit processing is active.

Parameters:

permitid - (String) The id of the customer or user associated with the catalog.

Method Detail

instance

public static final UserCatalog instance()

Returns the shared instance of this class.

Returns:

UserCatalog - The shared instance of this class.

init

public void init(JDBCConnectionInfo cninf)

Initialize the various caches associated with this instance of the object.

Parameters:

cninf - (JDBCConnectionInfo) A database connection info object.

buildCategoriesForTopMost

private java.lang.String[] buildCategoriesForTopMost(JDBCConnectionInfo cninf,
                                                     Category topmost)

Returns an array of the category codes starting with the given topmost category.

Parameters:

cninf - (JDBCConnectionInfo) A database connection info object.

Returns:

String[] - A list of category codes under (and including) the given topmost category.

getCategoriesForTopMost

public java.lang.String[] getCategoriesForTopMost(JDBCConnectionInfo cninf,
                                                  Category topmost)

Returns a cached array of the category codes starting with the given topmost category. If the category list for this topmost category is not already in the cache, it will be built and added to the cache.

Parameters:

cninf - (JDBCConnectionInfo) A database connection info object.

Returns:

String[] - A list of category codes under (and including) the given topmost category.

getTopMostByCategoryMap

public java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> getTopMostByCategoryMap(JDBCConnectionInfo cninf)

Create a map of categories and their associated topmost categories by iterating through the topmost category cache and essentially reversing it so we have a map keyed by the child category.

Parameters:

cninf - (JDBCConnectionInfo) A database connection info object.

Returns:

HashMap - A map of child categories and their associated topmost category.

getCategories

public java.util.ArrayList<java.lang.String> getCategories(JDBCConnectionInfo cninf,
                                                           java.lang.String prodcode)

Returns a product's set of assigned catalog category codes.

Parameters:

cninf - (JDBCConnectionInfo) A database connection info object.

prodcode - (String) The product code to retrieve.

Returns:

ArrayList - The product's set of assigned category codes, or null if the product is not assigned to any catalog categories.

getCategories

public java.util.ArrayList<java.lang.String> getCategories(JDBCConnectionInfo cninf,
                                                           java.lang.String prodcode,
                                                           java.lang.String uomcode)

Returns a product's set of assigned catalog category codes.

Parameters:

cninf - (JDBCConnectionInfo) A database connection info object.

prodcode - (String) The product code to retrieve.

uomcode - (String) The unit of measure code to retrieve.

Returns:

ArrayList - The product's set of assigned category codes, or null if the product is not assigned to any catalog categories.

loadCatalog1

private void loadCatalog1(JDBCConnectionInfo cninf)

Loads the primary map of products and their assigned catalog category codes. Sets the ivCatalog1 instance variable.

Parameters:

cninf - (JDBCConnectionInfo) A database connection info object.

loadCatalog2

private void loadCatalog2(JDBCConnectionInfo cninf)

Loads the secondary map of products and their assigned catalog category codes. Sets the ivCatalog2 instance variable.

Parameters:

cninf - (JDBCConnectionInfo) A database connection info object.