com.dpslink.flash.db

Class Category

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

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

com.dpslink.flash.db.Category

All Implemented Interfaces:

JDBCObjectKey<Category>, java.io.Serializable, java.lang.Comparable<Category>

public class Category
extends JDBCObject<Category>

Defines the fields and methods for category table objects.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IMG_GIF The file extension for a ".gif" type of image file.
static java.lang.String	IMG_JPG The file extension for a ".jpg" type of image file.
static java.lang.String	IMG_PNG The file extension for a ".png" type of image file.
private static long	serialVersionUID The class' serialization version id.

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

LOWVAL_RPG_DATE, LOWVAL_RPG_TIME, STATUS_ACTIVE, STATUS_BLANK, STATUS_CANCELED, STATUS_DELETED, STATUS_INACTIVE, STATUS_PENDING

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

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
Category() Constructs a Category object with all field values set to null.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<Category>	get1stChildren(FlashServletContext ctx) Returns a collection of category objects for the first level children of this category.
java.util.ArrayList<Category>	get1stParents(FlashServletContext ctx) Returns a collection of category objects for the first level parents of this category.
java.util.ArrayList<Category>	getAllChildren(FlashServletContext ctx, boolean unique) Returns a collection of category objects for all levels of children of this category.
java.util.ArrayList<Category>	getAllChildren(JDBCConnectionInfo cninfo, boolean unique) Returns a collection of category objects for all levels of children of this category.
java.lang.String	getClassCode() Returns the default classification code for products in the category.
java.lang.String	getCode() Returns the unique code for the category.
java.io.File	getDescriptionFile() Returns a file object for this category's description file.
static java.io.File	getDescriptionFile(java.lang.String code) Returns a file object for a category's description file.
java.lang.String	getDescriptionFileContent() Returns the file content for this category's description file.
java.lang.String	getDescriptionFileContent(boolean prune) Returns the file content for this category's description file.
static java.lang.String	getDescriptionFileContent(java.lang.String code) Returns the file content for a category's description file.
static java.lang.String	getDescriptionFileContent(java.lang.String code, boolean prune) Returns the file content for a category's description file.
java.lang.String	getDescriptionFileURL() Returns a relative url for this category's description file.
java.lang.String	getDescriptionFileURL(boolean full) Returns the relative or full URL for a category description file.
static java.lang.String	getDescriptionFileURL(java.lang.String code) Returns a relative url for a category's description file.
static java.lang.String	getDescriptionFileURL(java.lang.String code, boolean full) Returns the relative or full URL for a category description file.
java.io.File	getImageFile() Returns a file object for a category image file.
static java.io.File	getImageFile(java.lang.String code) Returns a file object for a category image file.
java.lang.String	getImageURL() Returns the relative URL for a category image file.
java.lang.String	getImageURL(boolean full) Returns the relative or full URL for a category image file.
static java.lang.String	getImageURL(java.lang.String code) Returns the relative URL for a category image file.
static java.lang.String	getImageURL(java.lang.String code, boolean full) Returns the relative or full URL for a category image file.
Leadtime	getLeadtime() Returns the default lead time object for products in the category.
java.lang.String	getLeadtimeCode() Returns the default lead time code for products in the category.
java.lang.String	getName() Returns the description.
java.util.ArrayList<Category>	getPathFromParent(FlashServletContext ctx, Category parent) Returns a collection of category objects for the path to this category, starting with the given parent category.
java.util.ArrayList<Category>	getPathToParent(FlashServletContext ctx, Category parent) Returns a collection of category for the path from this category, ending with the given parent category.
java.lang.Integer	getStockLowQty() Returns the default low stock quantity for products in the category.
java.lang.String	getStockLowQtyStr() Returns the default low stock quantity for products in the category.
java.lang.Integer	getStockOutQty() Returns the default out of stock quantity for products in the category.
java.lang.String	getStockOutQtyStr() Returns the default out of stock quantity for products in the category.
boolean	hasDescriptionFile() Answers if this category has a category description file.
static boolean	hasDescriptionFile(java.lang.String code) Answers if a category has a category description file.
boolean	hasImageFile() Answers if this category has a category-specific image file.
static boolean	hasImageFile(java.lang.String code) Answers if the category has a category-specific image file.
boolean	isDescendant(FlashServletContext ctx, Category parent) Determines if this category is a descendant (child, grandchild, etc.) of the given parent category.
void	setClassCode(java.lang.String value) Sets the default classification code for products in the category.
void	setCode(java.lang.String value) Sets the unique code for the category.
void	setLeadtime(Leadtime value) Sets the default lead time object for products in the category.
private void	setLeadtimeCode(java.lang.String value) Sets the default lead time code for products in the category.
void	setName(java.lang.String value) Sets the description.
void	setStockLowQty(java.lang.Integer value) Sets the default low stock quantity for products in the category.
void	setStockOutQty(java.lang.Integer value) Sets the default out of stock quantity for products in the category.

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

after, before, compareTo, equals, fmtStatus, fmtStatus, getObjectStatus, hashKey, setObjectStatus

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

IMG_GIF

public static final java.lang.String IMG_GIF

The file extension for a ".gif" type of image file.

See Also:

Constant Field Values

IMG_JPG

public static final java.lang.String IMG_JPG

The file extension for a ".jpg" type of image file.

See Also:

Constant Field Values

IMG_PNG

public static final java.lang.String IMG_PNG

The file extension for a ".png" type of image file.

See Also:

Constant Field Values

Constructor Detail

Category

public Category()

Constructs a Category object with all field values set to null.

Method Detail

getCode

public java.lang.String getCode()

Returns the unique code for the category.

Returns:

String - The unique code for the category.

setCode

public void setCode(java.lang.String value)

Sets the unique code for the category.

Parameters:

value - (String) The unique code for the category.

getName

public java.lang.String getName()

Returns the description.

Returns:

String - The description.

setName

public void setName(java.lang.String value)

Sets the description.

Parameters:

value - (String) The description.

getStockLowQty

public java.lang.Integer getStockLowQty()

Returns the default low stock quantity for products in the category.

Returns:

Integer - The default low stock quantity for products in the category or null if a default is not defined.

getStockLowQtyStr

public java.lang.String getStockLowQtyStr()

Returns the default low stock quantity for products in the category.

Returns:

String - The default low stock quantity for products in the category or an empty string if a default is not defined.

setStockLowQty

public void setStockLowQty(java.lang.Integer value)

Sets the default low stock quantity for products in the category.

Parameters:

value - (Integer) The default low stock quantity for products in the category or null if a default is not defined.

getStockOutQty

public java.lang.Integer getStockOutQty()

Returns the default out of stock quantity for products in the category.

Returns:

Integer - The default out of stock quantity for products in the category or null if a default is not defined.

getStockOutQtyStr

public java.lang.String getStockOutQtyStr()

Returns the default out of stock quantity for products in the category.

Returns:

String - The default out of stock quantity for products in the category or an empty string if a default is not defined.

setStockOutQty

public void setStockOutQty(java.lang.Integer value)

Sets the default out of stock quantity for products in the category.

Parameters:

value - (Integer) The default out of stock quantity for products in the category or null if a default is not defined.

getLeadtime

public Leadtime getLeadtime()

Returns the default lead time object for products in the category.

Returns:

Leadtime - The default lead time object for products in the category.

setLeadtime

public void setLeadtime(Leadtime value)

Sets the default lead time object for products in the category.

Parameters:

value - (Leadtime) The default lead time object for products in the category.

getLeadtimeCode

public java.lang.String getLeadtimeCode()

Returns the default lead time code for products in the category.

Returns:

String - The default lead time code for products in the category.

setLeadtimeCode

private void setLeadtimeCode(java.lang.String value)

Sets the default lead time code for products in the category.

Parameters:

value - (String) The default lead time code for products in the category.

getClassCode

public java.lang.String getClassCode()

Returns the default classification code for products in the category.

Returns:

String - The default classification code for products in the category.

setClassCode

public void setClassCode(java.lang.String value)

Sets the default classification code for products in the category.

Parameters:

value - (String) The default classification code for products in the category.

get1stChildren

public java.util.ArrayList<Category> get1stChildren(FlashServletContext ctx)

Returns a collection of category objects for the first level children of this category. This is a convenience shortcut to the method of the same name in CategoryController.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

ArrayList - The category objects for this category's first level children.

getAllChildren

public java.util.ArrayList<Category> getAllChildren(FlashServletContext ctx,
                                                    boolean unique)

Returns a collection of category objects for all levels of children of this category. Objects for all levels of children are returned (children, grandchildren, great-grandchildren, etc.). This is a convenience shortcut to the method of the same name in CategoryController.

Parameters:

ctx - (FlashServletContext) The current servlet context.

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 category objects for this category's entire set of children, grandchildren, great-grandchildren, etc.

getAllChildren

public java.util.ArrayList<Category> getAllChildren(JDBCConnectionInfo cninfo,
                                                    boolean unique)

Returns a collection of category objects for all levels of children of this category. Objects for all levels of children are returned (children, grandchildren, great-grandchildren, etc.). This is a convenience shortcut to the method of the same name in CategoryController.

Parameters:

cninfo - (JDBCConnectionInfo) A database connection info object.

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 category objects for this category's entire set of children, grandchildren, great-grandchildren, etc.

get1stParents

public java.util.ArrayList<Category> get1stParents(FlashServletContext ctx)

Returns a collection of category objects for the first level parents of this category. This is a convenience shortcut to the method of the same name in CategoryController.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

ArrayList - The category objects for this category's first level parents.

getPathFromParent

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

Returns a collection of category objects for the path to this category, starting with the given parent category. If this category is not found in the parent's path, the collection returned will be empty. This method returns a top-to-bottom (parent-to-child) list of categories. This is a convenience shortcut to the method of the same name in CategoryController.

Parameters:

ctx - (FlashServletContext) The current servlet context.

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

Returns:

ArrayList - The category objects for the path from the specified parent to this category.

getPathToParent

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

Returns a collection of category for the path from this category, ending with the given parent category. If this category is not found in the parent's path, the collection returned will be empty. This method returns a bottom-to-top (child-to-parent) list of categories. This is a convenience shortcut to the method of the same name in CategoryController.

Parameters:

ctx - (FlashServletContext) The current servlet context.

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

Returns:

ArrayList - The category objects for the path to the specified parent to this category.

isDescendant

public boolean isDescendant(FlashServletContext ctx,
                            Category parent)

Determines if this category is a descendant (child, grandchild, etc.) of the given parent category. This is a convenience shortcut to the method of the same name in CategoryController.

Parameters:

ctx - (FlashServletContext) The current servlet context.

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

Returns:

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

hasDescriptionFile

public boolean hasDescriptionFile()

Answers if this category has a category description file. A category description file name is a concatenation of the category code and ".html".

Returns:

boolean - true if a category description file is found for this category, otherwise false.

hasDescriptionFile

public static boolean hasDescriptionFile(java.lang.String code)

Answers if a category has a category description file. A category description file name is a concatenation of the category code and ".html".

Parameters:

code - (String) The category code for the desired description file.

Returns:

boolean - true if a category description file is found for the category, otherwise false.

getDescriptionFile

public java.io.File getDescriptionFile()

Returns a file object for this category's description file. A category description file name is a concatenation of the category code and ".html".

Returns:

File - This category's description file object. Note that the returned file might not actually exist in the file system.

getDescriptionFile

public static java.io.File getDescriptionFile(java.lang.String code)

Returns a file object for a category's description file. A category description file name is a concatenation of the category code and ".html".

Parameters:

code - (String) The category code for the desired description file.

Returns:

File - The category's description file object. Note that the returned file might not actually exist in the file system.

getDescriptionFileContent

public java.lang.String getDescriptionFileContent()

Returns the file content for this category's description file. A category description file name is a concatenation of the category code and ".html". Assumes the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Returns:

String - The content for this category's description file.

getDescriptionFileContent

public static java.lang.String getDescriptionFileContent(java.lang.String code)

Returns the file content for a category's description file. A category description file name is a concatenation of the category code and ".html". Assumes the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Parameters:

code - (String) The category code for the desired description file.

Returns:

String - The content for the category's description file.

getDescriptionFileContent

public java.lang.String getDescriptionFileContent(boolean prune)

Returns the file content for this category's description file. A category description file name is a concatenation of the category code and ".html".

Parameters:

prune - (boolean) true if the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Returns:

String - The content for this category's description file.

getDescriptionFileContent

public static java.lang.String getDescriptionFileContent(java.lang.String code,
                                                         boolean prune)

Returns the file content for a category's description file. A category description file name is a concatenation of the category code and ".html".

Parameters:

code - (String) The category code for the desired description file.

prune - (boolean) true if the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Returns:

String - The content for the category's description file.

getDescriptionFileURL

public java.lang.String getDescriptionFileURL()

Returns a relative url for this category's description file. A category description file name is a concatenation of the category code and ".html".

Returns:

String - This category's description file relative url. Note that the returned url might not actually exist in the file system.

getDescriptionFileURL

public static java.lang.String getDescriptionFileURL(java.lang.String code)

Returns a relative url for a category's description file. A category description file name is a concatenation of the category code and ".html".

Parameters:

code - (String) The category code for the desired description file.

Returns:

String - The category's description file relative url. Note that the returned url might not actually exist in the file system.

getDescriptionFileURL

public java.lang.String getDescriptionFileURL(boolean full)

Returns the relative or full URL for a category description file. A category description file name is a concatenation of the category code and ".html".

Parameters:

full - (boolean) true to return the fully qualified URL or false to return the relative URL. The fully qualified URL is per Profile.BASE_URL_NONSECURE.

Returns:

String - This category's description file relative or full url. Note that the returned url might not actually exist in the file system.

getDescriptionFileURL

public static java.lang.String getDescriptionFileURL(java.lang.String code,
                                                     boolean full)

Returns the relative or full URL for a category description file. A category description file name is a concatenation of the category code and ".html".

Parameters:

code - (String) The category code for the desired description file.

full - (boolean) true to return the fully qualified URL or false to return the relative URL. The fully qualified URL is per Profile.BASE_URL_NONSECURE.

Returns:

String - The category's description file relative or full url. Note that the returned url might not actually exist in the file system.

hasImageFile

public boolean hasImageFile()

Answers if this category has a category-specific image file.

Returns:

boolean - true if a category-specific image file exists, otherwise false.

hasImageFile

public static boolean hasImageFile(java.lang.String code)

Answers if the category has a category-specific image file.

Parameters:

code - (String) The category code for the desired image file.

Returns:

boolean - true if a category-specific image file exists, otherwise false.

getImageFile

public java.io.File getImageFile()

Returns a file object for a category image file. If a category-specific file does not exist, the object for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Returns:

File - The object for either a category-specific image file or a default image file.

getImageFile

public static java.io.File getImageFile(java.lang.String code)

Returns a file object for a category image file. If a category-specific file does not exist, the object for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

code - (String) The category code for the desired image file.

Returns:

File - The object for either a category-specific image file or a default image file.

getImageURL

public java.lang.String getImageURL()

Returns the relative URL for a category image file. If a category-specific file does not exist, the URL for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Returns:

String - The relative URL for either a category-specific image file or a default image file.

getImageURL

public static java.lang.String getImageURL(java.lang.String code)

Returns the relative URL for a category image file. If a category-specific file does not exist, the URL for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

code - (String) The category code for the desired image file.

Returns:

String - The relative URL for either a category-specific image file or a default image file.

getImageURL

public java.lang.String getImageURL(boolean full)

Returns the relative or full URL for a category image file. If a category-specific file does not exist, the URL for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

full - (boolean) true to return the fully qualified URL or false to return the relative URL. The fully qualified URL is per Profile.BASE_URL_NONSECURE.

Returns:

String - The relative or full URL for either a category-specific image file or a default image file.

getImageURL

public static java.lang.String getImageURL(java.lang.String code,
                                           boolean full)

Returns the relative or full URL for a category image file. If a category-specific file does not exist, the URL for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

code - (String) The category code for the desired image file.

full - (boolean) true to return the fully qualified URL or false to return the relative URL. The fully qualified URL is per Profile.BASE_URL_NONSECURE.

Returns:

String - The relative or full URL for either a category-specific image file or a default image file.