com.dpslink.flash.db

Class CategoryController

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

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

com.dpslink.flash.db.CategoryController

All Implemented Interfaces:

java.io.Serializable

public class CategoryController
extends JDBCObjectController<Category>

The controller for the Category class. Provides methods for retrieving and persisting category 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,Category>	cvCache A hash table for caching all categories.
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
CategoryController() The constructor for the controller.

Method Summary

Modifier and Type	Method and Description
int	add(Category obj, boolean logdup) Adds a new record to the table associated with the controller.
boolean	delete(Category obj) Deletes an existing record from the table associated with the controller.
boolean	deleteAll() Deletes all records in the table associated with the controller.
Category	get(java.lang.String code) Returns the category record for the given category code.
java.util.ArrayList<Category>	get1stChildren(java.lang.String code) Returns a collection of category records for the first level children of a given category code.
java.util.ArrayList<Category>	get1stParents(java.lang.String code) Returns a collection of category records for the first level parents of a given category code.
java.util.ArrayList<Category>	getAll() Returns a collection of all records in the table associated with the controller.
java.util.ArrayList<Category>	getAllChildren(java.lang.String code, boolean unique) Returns a collection of category records for all levels of children of a given category code.
private CatalogCategoryController	getCatalogController() Returns a catalog category controller.
java.util.ArrayList<Category>	getPathFromParent(Category parent, Category child) Returns a collection of category records for the path to a child category, starting with the given parent category and ending with the given child category.
java.util.ArrayList<Category>	getPathToParent(Category parent, Category child) Returns a collection of category records for the path from a given child category, ending with the given parent category.
java.util.ArrayList<Category>	getTopMost() Returns a collection of category records that are specified as being the top most category for at least one active user.
Select	getUISelect(java.lang.String code, boolean showcode) Returns an HTML Select object that contains all categories and has the given code as the preselected code in the set of options.
boolean	hasCategory(java.lang.String code) Answers if a given category code exists in the category table.
boolean	hasLeadtime(java.lang.String code) Answers if a given lead time code exists in the category table.
boolean	isDescendant(Category parent, Category checkee) Answers if a category is a descendant (child, grandchild, etc.) of the given parent category.
private void	loadCache() Loads the cache of categories with all categories.
boolean	update(Category obj) Updates an existing record in the table associated with the controller.
Category	valuesToObject(java.util.HashMap<java.lang.String,java.lang.Object> attrs) Returns a database object from the given set of attributes.

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

add, add, arrayToMap, arrayToMap, countAll, delete, dispose, equals, 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

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

cvCache

private static final java.util.Hashtable<java.lang.String,Category> cvCache

A hash table for caching all categories. Each element in the hash table is keyed by category code and has the code's corresponding Category object as its value.

Constructor Detail

CategoryController

public CategoryController()

The constructor for the controller.

Method Detail

add

public int add(Category obj,
               boolean logdup)

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

Overrides:

add in class JDBCObjectController<Category>

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(Category obj)

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

Overrides:

delete in class JDBCObjectController<Category>

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

Returns:

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

getAll

public java.util.ArrayList<Category> getAll()

Returns a collection of all records in the table associated with the controller.

Overrides:

getAll in class JDBCObjectController<Category>

Returns:

ArrayList - A collection of all records.

update

public boolean update(Category obj)

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

Overrides:

update in class JDBCObjectController<Category>

Parameters:

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

Returns:

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

valuesToObject

public Category valuesToObject(java.util.HashMap<java.lang.String,java.lang.Object> attrs)

Returns a database object from the given set of attributes. Overrides valuesToObject in JDBCObjectController.

This method assumes the attributes were obtained from the zcategory database view.

Overrides:

valuesToObject in class JDBCObjectController<Category>

Parameters:

attrs - (HashMap) The attributes to assign to the new object.

Returns:

Category - An object initialized with the specified attributes.

get

public Category get(java.lang.String code)

Returns the category record for the given category code.

Parameters:

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

Returns:

Category - An object initialized with values from the database.

getCatalogController

private CatalogCategoryController getCatalogController()

Returns a catalog category controller. This is a shortcut convenience method for getController(CatalogCategoryController.class).

Returns:

CatalogCategoryController - A catalog category controller.

get1stChildren

public java.util.ArrayList<Category> get1stChildren(java.lang.String code)

Returns a collection of category records for the first level children of a given category code.

Asks the CatalogCategoryController for the category's child catalog entries and converts the entries to Category objects.

Parameters:

code - (String) The category code for the desired children.

Returns:

ArrayList - The categories for the specified code's first level children, in sequence per the CatalogCategoryController sql statement for getChildren().

getAllChildren

public java.util.ArrayList<Category> getAllChildren(java.lang.String code,
                                                    boolean unique)

Returns a collection of category records for all levels of children of a given category code. All levels of children are returned (children, grandchildren, great-grandchildren, etc.).

Asks each level of children to return a collection of its children and accumulates a collection of all children from all levels.

Parameters:

code - (String) The category code for the desired children.

unique - (boolean) true if the returned collection should not contain any duplicate category objects. false if the returned collection should contain all child category objects found, even if a child category occurs more than once in this category's tree.

Returns:

ArrayList - The categories for the specified code's entire set of children, grandchildren, great-grandchildren, etc. The sequence of the collection is according to the order in which the children are found while transversing the category's tree.

get1stParents

public java.util.ArrayList<Category> get1stParents(java.lang.String code)

Returns a collection of category records for the first level parents of a given category code.

Asks the CatalogCategoryController for the category's parent catalog entries and converts the entries to Category objects.

Parameters:

code - (String) The category code for the desired parents.

Returns:

ArrayList - The categories for the specified code's first level parents, in sequence per the CatalogCategoryController sql statement for getParents().

getPathFromParent

public java.util.ArrayList<Category> getPathFromParent(Category parent,
                                                       Category child)

Returns a collection of category records for the path to a child category, starting with the given parent category and ending with the given child category. If the child category is not found in the parent's path, the collection returned will be empty.

Asks the CatalogCategoryController for the parent catalog entries that lead to this category and then converts the entries to Category objects.

Returns a top-to-bottom (parent-to-child) list of categories. The results of this method are the same as getPathToParent() except the order of the categories in the returned collection are reversed.

Parameters:

parent - (Category) The parent category from which the path is to be built.

child - (Category) The child category to which the path is to be built.

Returns:

ArrayList - The categories for the path from the specified parent category 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 parent's path.

getPathToParent

public java.util.ArrayList<Category> getPathToParent(Category parent,
                                                     Category child)

Returns a collection of category records for the path from a given child category, ending with the given parent category. If the child category is not found in the parent's path, the collection returned will be empty.

Asks the CatalogCategoryController for the parent catalog entries that lead to the child category and then converts the entries to Category objects.

Returns a bottom-to-top (child-to-parent) list of categories. The results of this method are the same as getPathFromParent() except the order of the categories in the returned collection are reversed.

Parameters:

parent - (Category) The parent category to which the path is to be built.

child - (Category) The child category from which the path is to be built.

Returns:

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

getTopMost

public java.util.ArrayList<Category> getTopMost()

Returns a collection of category records that are specified as being the top most category for at least one active user.

Returns:

ArrayList - The Category objects which are defined as a topmost category for one or more active users.

getUISelect

public Select getUISelect(java.lang.String code,
                          boolean showcode)

Returns an HTML Select object that contains all categories and has the given code as the preselected code in the set of options. Invokers must assign a form field name to the returned object via the setName method before adding the object to the velocity template data.

Parameters:

code - (String) The category code to preselect in the select's set of options. Pass an empty string for this parameter if a blank option is to be created as the first option and then preselected. Pass a null for this parameter if no blank option and no preselecting is desired.

showcode - (boolean) true to show each category code as part of the description, otherwise false. If code is to be shown, the Select should be displayed with a fixed-width font so the codes and descriptions are aligned and easier to read.

Returns:

Select - An HTML Select object.

hasCategory

public boolean hasCategory(java.lang.String code)

Answers if a given category code exists in the category table.

Parameters:

code - (String) The category code to check.

Returns:

boolean - true if the category code exists, otherwise false.

hasLeadtime

public boolean hasLeadtime(java.lang.String code)

Answers if a given lead time code exists in the category table.

Parameters:

code - (String) The lead time code to check.

Returns:

boolean - true if the lead time code exists, otherwise false.

isDescendant

public boolean isDescendant(Category parent,
                            Category checkee)

Answers if a category is a descendant (child, grandchild, etc.) of the given parent category.

Asks the CatalogCategoryController for the parent catalog entries that lead to the category. If any entries are returned then the category is deemed to be a descendant of the given parent.

Parameters:

parent - (Category) The parent category to which ancestory is to be determined.

checkee - (Category) The category to check.

Returns:

boolean - true if the category to check is a child, grandchild, great-grandchild, etc. of the specified parent, otherwise false.

loadCache

private void loadCache()

Loads the cache of categories with all categories.