com.dpslink.flash.db

Class CatalogCategoryController

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.jdbc.JDBCObjectController<CatalogCategory>

com.dpslink.flash.db.CatalogCategoryController

All Implemented Interfaces:

java.io.Serializable

public class CatalogCategoryController
extends JDBCObjectController<CatalogCategory>

The controller for the CatalogCategory class. Provides methods for retrieving and persisting category relationship table records in the database.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Hashtable<java.lang.String,java.util.ArrayList<CatalogCategory>>	cvChildren A hash table for caching all child catalog entries for each parent.
private static java.util.Hashtable<java.lang.String,java.util.ArrayList<CatalogCategory>>	cvParents A hash table for caching all parent catalog entries for each child.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.jdbc.JDBCObjectController

ivDBObjCls, ivFieldCount, ivFieldKeyAlt, ivFieldKeyPri, ivFieldResPfx, ivSyncLast, ivSyncType, ivTableName

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
CatalogCategoryController() The constructor for the controller.

Method Summary

Modifier and Type	Method and Description
int	add(CatalogCategory obj, boolean logdup) Adds a new record to the table associated with the controller.
boolean	delete(CatalogCategory obj) Deletes an existing record from the table associated with the controller.
boolean	deleteAll() Deletes all records in the table associated with the controller.
boolean	deleteChild(java.lang.String child) Deletes all catalog category records for a given child category code.
boolean	deleteParent(java.lang.String parent) Deletes all catalog category records for a given parent category code.
CatalogCategory	get(java.lang.String parent, java.lang.String child) Returns the catalog category record for the given parent and child category codes.
java.util.ArrayList<CatalogCategory>	getChildren(java.lang.String parent) Returns a collection of child catalog category records for a given parent category code.
private java.util.ArrayList<CatalogCategory>	getChildrenForCache(java.lang.String parent) Returns a collection of child catalog category records for a given parent category code.
java.util.ArrayList<CatalogCategory>	getParents(java.lang.String child) Returns a collection of parent catalog category records for a given child category code.
private java.util.ArrayList<CatalogCategory>	getParentsForCache(java.lang.String child) Returns a collection of parent catalog category records for a given child category code.
java.util.ArrayList<CatalogCategory>	getPathToChild(java.lang.String parent, java.lang.String child) Returns a collection of CatalogCategory objects for the path to the given child category (exclusive), starting with the given parent category.
private boolean	getPathToParent(java.lang.String parent, java.lang.String child, java.lang.String path, java.util.Hashtable<java.lang.String,CatalogCategory> paths) Internal method used for determining the path to a category.
private void	loadCache() Loads the child and parent caches with catalog entries.
boolean	update(CatalogCategory obj) Updates an existing record in the table associated with the controller.

Methods inherited from class com.dpslink.base.jdbc.JDBCObjectController

add, add, arrayToMap, arrayToMap, countAll, delete, dispose, equals, getAll, getConnection, getConnectionInfo, getController, getFieldNames, getFieldNamesForKey, getFieldNamesForUpdate, getFieldNulls, getFieldNullsForKey, getFieldNullsForUpdate, getFieldsForOrderBy, getFieldsForWhere, getFieldSize, getFieldTypes, getFieldTypesForKey, getFieldTypesForUpdate, getStatementForDelete, getStatementForGet, getStatementForGetAll, getStatementForInsert, getStatementForUpdate, getStatementKey, getStatementString, getTableName, hasFieldNamesForKey, hasFieldNamesForUpdate, isDuplicate, resultSetToArray, resultSetToMap, resultSetToMap, resultSetToObject, setConnectionInfo, setPSDeleteValues, setPSExistsValues, setPSInsertValues, setPSUpdateValues, setPSValue, update, valuesToObject

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvChildren

private static final java.util.Hashtable<java.lang.String,java.util.ArrayList<CatalogCategory>> cvChildren

A hash table for caching all child catalog entries for each parent. The hash table is keyed by parent category code. The corresponding value for each key is a collection of the parent's child CatalogCategory objects.

cvParents

private static final java.util.Hashtable<java.lang.String,java.util.ArrayList<CatalogCategory>> cvParents

A hash table for caching all parent catalog entries for each child. The hash table is keyed by child category code. The corresponding value for each key is a collection of the child's parent CatalogCategory objects.

Constructor Detail

CatalogCategoryController

public CatalogCategoryController()

The constructor for the controller.

Method Detail

add

public int add(CatalogCategory obj,
               boolean logdup)

Adds a new record to the table associated with the controller. Overrides add in JDBCObjectController.

Overrides:

add in class JDBCObjectController<CatalogCategory>

Parameters:

obj - (JDBCObject) The object for the record to be added.

logdup - (boolean) true if duplicate errors are to be logged as an exception, otherwise false if not. When duplicates are logged, the return value of 1 is never returned.

Returns:

int - 0 = success, 1 = duplicate, 2 = failure.

delete

public boolean delete(CatalogCategory obj)

Deletes an existing record from the table associated with the controller. Overrides delete in JDBCObjectController.

Overrides:

delete in class JDBCObjectController<CatalogCategory>

Parameters:

obj - (JDBCObject) The object for the record to be deleted.

Returns:

boolean - true if the record deleted successfully, otherwise false.

deleteAll

public boolean deleteAll()

Deletes all records in the table associated with the controller. Overrides deleteAll in JDBCObjectController.

Overrides:

deleteAll in class JDBCObjectController<CatalogCategory>

Returns:

boolean - true if the deletes are successful, otherwise false.

update

public boolean update(CatalogCategory obj)

Updates an existing record in the table associated with the controller. Overrides update in JDBCObjectController.

Overrides:

update in class JDBCObjectController<CatalogCategory>

Parameters:

obj - (JDBCObject) The object for the record to be updated.

Returns:

boolean - true if the record updated successfully, otherwise false.

deleteChild

public boolean deleteChild(java.lang.String child)

Deletes all catalog category records for a given child category code.

Parameters:

child - (String) The child category code to delete.

Returns:

boolean - true if the deletes are successful, otherwise false.

deleteParent

public boolean deleteParent(java.lang.String parent)

Deletes all catalog category records for a given parent category code.

Parameters:

parent - (String) The parent category code to delete.

Returns:

boolean - true if the deletes are successful, otherwise false.

get

public CatalogCategory get(java.lang.String parent,
                           java.lang.String child)

Returns the catalog category record for the given parent and child category codes.

Parameters:

parent - (String) The parent category code for the desired record.

child - (String) The child category code for the desired record.

Returns:

CatalogCategory - An object initialized with values from the database.

getChildren

public java.util.ArrayList<CatalogCategory> getChildren(java.lang.String parent)

Returns a collection of child catalog category records for a given parent category code.

Parameters:

parent - (String) The parent category code for the desired child records.

Returns:

ArrayList - A collection of child catalog categories.

getChildrenForCache

private java.util.ArrayList<CatalogCategory> getChildrenForCache(java.lang.String parent)

Returns a collection of child catalog category records for a given parent category code.

Parameters:

parent - (String) The parent category code for the desired child records.

Returns:

ArrayList - A collection of child catalog categories.

getParents

public java.util.ArrayList<CatalogCategory> getParents(java.lang.String child)

Returns a collection of parent catalog category records for a given child category code.

Parameters:

child - (String) The child category code for the desired parent records.

Returns:

ArrayList - A collection of parent catalog categories.

getParentsForCache

private java.util.ArrayList<CatalogCategory> getParentsForCache(java.lang.String child)

Returns a collection of parent catalog category records for a given child category code.

Parameters:

child - (String) The child category code for the desired parent records.

Returns:

ArrayList - A collection of parent catalog categories.

getPathToChild

public java.util.ArrayList<CatalogCategory> getPathToChild(java.lang.String parent,
                                                           java.lang.String child)

Returns a collection of CatalogCategory objects for the path to the given child category (exclusive), starting with the given parent category. If the child category is not found in the path, the collection returned will be empty. Note that the returned results do NOT include the child.

Parameters:

parent - (String) The code for parent category from which the path is to be built.

child - (String) The code for child category to which the path is to be built.

Returns:

ArrayList - The CatalogCategory objects for the path from the specified parent to the specified child. The collection elements are in order beginning with the parent and ending with the child. An empty collection is returned if the child is not found in the path.

getPathToParent

private boolean getPathToParent(java.lang.String parent,
                                java.lang.String child,
                                java.lang.String path,
                                java.util.Hashtable<java.lang.String,CatalogCategory> paths)

Internal method used for determining the path to a category. The method repeatedly calls itself while making its determinations and builds upon path information it accumulates in a hashtable.

The method actually reads the parent-child relationships in reverse order, in that it begins its search at the child level and works its way up through each successive level of parents.

The method stops searching when it finds the first occurrence of parent or when it has no more parents (and parents of parents, etc.) to investigate.

When the method completes its processing, two values are available to the original caller. First, a boolean is returned to indicate whether the path that was originally requested is valid. Second, the hashtable of paths will contain all the paths accumulated up to the point when the search was terminated.

Parameters:

parent - (String) The code for the parent category to which the path is to be built.

child - (String) The code for the child category from which the path is to be built.

path - (String) A string representation of the path that has been built prior to this invocation. The string contents are in the form of code/code/code/code where (from left to right) the first code is the lowest level of the path (child) and the last code is the highest level of the path (parent).

paths - (Hashtable) An accumulation of path information, added to by each recursive call to this method. The keys for the hashtable are string representations of path information (see path parameter above). The hashtable values are the corresponding CatalogCategory objects for the rightmost category codes in the key.

Returns:

boolean - true if the requested path was found, otherwise false.

loadCache

private void loadCache()

Loads the child and parent caches with catalog entries.