org.broadleafcommerce.core.catalog.domain
Class CategoryImpl

java.lang.Object
  org.broadleafcommerce.core.catalog.domain.CategoryImpl

All Implemented Interfaces:

Serializable, Status, Category

@Entity
public class CategoryImpl
extends Object
implements Category, Status

Author:

bTaylor, Jeff Fischer

See Also:

Serialized Form

Field Summary

protected Date	activeEndDate
protected Date	activeStartDate
protected List<Category>	allChildCategories
protected List<Category>	allParentCategories
protected List<Product>	allProducts
protected ArchiveStatus	archiveStatus
protected List<CategoryAttribute>	categoryAttributes
protected Map<String,String>	categoryImages Deprecated.
protected Map<String,Media>	categoryMedia
protected List<Category>	childCategories
protected Map<String,List<Long>>	childCategoryURLMap
protected List<RelatedProduct>	crossSaleProducts
protected Category	defaultParentCategory
protected String	description
protected String	displayTemplate
protected List<SearchFacet>	excludedSearchFacets
protected static Comparator<CategorySearchFacet>	facetPositionComparator
protected List<FeaturedProduct>	featuredProducts
protected List<RelatedProduct>	filteredCrossSales
protected List<FeaturedProduct>	filteredFeaturedProducts
protected List<RelatedProduct>	filteredUpSales
protected Long	id
protected String	longDescription
protected String	name
protected List<CategorySearchFacet>	searchFacets
protected List<RelatedProduct>	upSaleProducts
protected String	url
protected String	urlKey

Constructor Summary

CategoryImpl()

Method Summary

List<Category>	buildCategoryHierarchy(List<Category> currentHierarchy) Build category hierarchy by walking the default category tree up to the root category.
List<Category>	buildFullCategoryHierarchy(List<Category> currentHierarchy) Build the full category hierarchy by walking up the default category tree and the all parent category tree.
Map<String,List<Long>>	createChildCategoryURLMap()
boolean	equals(Object obj)
Date	getActiveEndDate() Gets the active end date.
List<Product>	getActiveProducts() Convenience method to retrieve all of this Category's Products filtered by active.
Date	getActiveStartDate() Gets the active start date.
List<Category>	getAllChildCategories() Gets the child categories.
List<Category>	getAllParentCategories() Retrieve all parent categories
List<Product>	getAllProducts() Retrieve all the Product instances associated with this category.
Character	getArchived()
CategoryAttribute	getCategoryAttributeByName(String name) Convenience method to get a CategoryAttribute by name
List<CategoryAttribute>	getCategoryAttributes() Gets the attributes for this Category.
String	getCategoryImage(String imageKey) Deprecated.
Map<String,String>	getCategoryImages() Deprecated.
Map<String,Media>	getCategoryMedia() Gets the category media map.
List<Category>	getChildCategories() Gets the child categories.
Map<String,List<Long>>	getChildCategoryURLMap() Gets the child category url map.
List<RelatedProduct>	getCrossSaleProducts() Returns a list of cross sale products that are related to this category.
List<RelatedProduct>	getCumulativeCrossSaleProducts() Returns a list of the cross sale products in this category as well as all cross sale products in all parent categories of this category.
List<FeaturedProduct>	getCumulativeFeaturedProducts() Returns a list of the featured products in this category as well as all featured products in all parent categories of this category.
List<CategorySearchFacet>	getCumulativeSearchFacets() Returns a list of CategorySearchFacets that takes into consideration the search facets for this Category, the search facets for all parent categories, and the search facets that should be excluded from this Category.
List<RelatedProduct>	getCumulativeUpSaleProducts() Returns a list of the upsale products in this category as well as all upsale products in all parent categories of this category.
Category	getDefaultParentCategory() Gets the default parent category.
String	getDescription() Gets the description.
String	getDisplayTemplate() Gets the display template.
List<SearchFacet>	getExcludedSearchFacets() Gets the excluded SearchFacets
List<FeaturedProduct>	getFeaturedProducts() Gets the featured products.
String	getGeneratedUrl() Creates the SEO url starting from this category and recursing up the hierarchy of default parent categories until the topmost category is reached.
Long	getId() Gets the primary key.
String	getLongDescription() Gets the long description.
Map<String,CategoryAttribute>	getMappedCategoryAttributes() Convenience method to return the CategoryAttributes for the Category in an easily-consumable form
String	getName() Gets the name.
List<CategorySearchFacet>	getSearchFacets() Returns all of the SearchFacets that are directly associated with this Category
List<RelatedProduct>	getUpSaleProducts() Returns a list of cross sale products that are related to this category.
String	getUrl() Gets the url.
String	getUrlKey() Gets the url key.
boolean	hasAllChildCategories() Checks for child categories.
boolean	hasChildCategories() Checks for child categories.
int	hashCode()
boolean	isActive() Checks if is active.
void	setActiveEndDate(Date activeEndDate) Sets the active end date.
void	setActiveStartDate(Date activeStartDate) Sets the active start date.
void	setAllChildCategories(List<Category> childCategories) Sets the list of child categories (active and inactive)
void	setAllParentCategories(List<Category> allParentCategories) Sets the list of parent categories
void	setAllProducts(List<Product> allProducts) Set all the Product instances associated with this category.
void	setArchived(Character archived)
void	setCategoryAttributes(List<CategoryAttribute> categoryAttributes) Sets the attributes for this Category.
void	setCategoryImages(Map<String,String> categoryImages) Deprecated.
void	setCategoryMedia(Map<String,Media> categoryMedia) Sets the category media.
void	setChildCategories(List<Category> childCategories) Sets the all child categories.
void	setChildCategoryURLMap(Map<String,List<Long>> childCategoryURLMap) Included to support the HydratedCacheJPAListener
void	setCrossSaleProducts(List<RelatedProduct> crossSaleProducts) Sets the cross sale products that are related to this category.
void	setDefaultParentCategory(Category defaultParentCategory) Sets the default parent category.
void	setDescription(String description) Sets the description.
void	setDisplayTemplate(String displayTemplate) Sets the display template.
void	setExcludedSearchFacets(List<SearchFacet> excludedSearchFacets) Sets the SearchFacets that should not be rendered by this Category.
void	setFeaturedProducts(List<FeaturedProduct> featuredProducts) Sets the featured products.
void	setId(Long id) Sets the primary key.
void	setLongDescription(String longDescription) Sets the long description.
void	setName(String name) Sets the name.
void	setSearchFacets(List<CategorySearchFacet> searchFacets) Sets the SearchFacets that are directly associated with this Category
void	setUpSaleProducts(List<RelatedProduct> upSaleProducts) Sets the upsale products that are related to this category.
void	setUrl(String url) Sets the url.
void	setUrlKey(String urlKey) Sets the url key.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

name

protected String name

url

protected String url

urlKey

protected String urlKey

description

protected String description

activeStartDate

protected Date activeStartDate

activeEndDate

protected Date activeEndDate

displayTemplate

protected String displayTemplate

longDescription

protected String longDescription

defaultParentCategory

protected Category defaultParentCategory

allChildCategories

protected List<Category> allChildCategories

allParentCategories

protected List<Category> allParentCategories

allProducts

protected List<Product> allProducts

categoryImages

@Deprecated
protected Map<String,String> categoryImages

Deprecated.

categoryMedia

protected Map<String,Media> categoryMedia

featuredProducts

protected List<FeaturedProduct> featuredProducts

crossSaleProducts

protected List<RelatedProduct> crossSaleProducts

upSaleProducts

protected List<RelatedProduct> upSaleProducts

searchFacets

protected List<CategorySearchFacet> searchFacets

excludedSearchFacets

protected List<SearchFacet> excludedSearchFacets

categoryAttributes

protected List<CategoryAttribute> categoryAttributes

archiveStatus

protected ArchiveStatus archiveStatus

childCategoryURLMap

protected Map<String,List<Long>> childCategoryURLMap

childCategories

protected List<Category> childCategories

filteredFeaturedProducts

protected List<FeaturedProduct> filteredFeaturedProducts

filteredCrossSales

protected List<RelatedProduct> filteredCrossSales

filteredUpSales

protected List<RelatedProduct> filteredUpSales

facetPositionComparator

protected static Comparator<CategorySearchFacet> facetPositionComparator

Constructor Detail

CategoryImpl

public CategoryImpl()

Method Detail

getId

public Long getId()

Description copied from interface: Category

Gets the primary key.

Specified by:

getId in interface Category

Returns:

the primary key

setId

public void setId(Long id)

Description copied from interface: Category

Sets the primary key.

Specified by:

setId in interface Category

Parameters:

id - the new primary key

getName

public String getName()

Description copied from interface: Category

Gets the name.

Specified by:

getName in interface Category

Returns:

the name

setName

public void setName(String name)

Description copied from interface: Category

Sets the name.

Specified by:

setName in interface Category

Parameters:

name - the new name

getUrl

public String getUrl()

Description copied from interface: Category

Gets the url. The url represents the presentation layer destination for this category. For example, if using Spring MVC, you could send the user to this destination by returning "redirect:"+currentCategory.getUrl(); from a controller.

Specified by:

getUrl in interface Category

Returns:

the url for the presentation layer component for this category

setUrl

public void setUrl(String url)

Description copied from interface: Category

Sets the url. The url represents the presentation layer destination for this category. For example, if using Spring MVC, you could send the user to this destination by returning "redirect:"+currentCategory.getUrl(); from a controller.

Specified by:

setUrl in interface Category

Parameters:

url - the new url for the presentation layer component for this category

getUrlKey

public String getUrlKey()

Description copied from interface: Category

Gets the url key. The url key is used as part of SEO url generation for this category. Each segment of the url leading to a category is comprised of the url keys of the various associated categories in a hierarchy leading to this one. If the url key is null, the the name for the category formatted with dashes for spaces.

Specified by:

getUrlKey in interface Category

Returns:

the url key for this category to appear in the SEO url

getGeneratedUrl

public String getGeneratedUrl()

Description copied from interface: Category

Creates the SEO url starting from this category and recursing up the hierarchy of default parent categories until the topmost category is reached. The url key for each category is used for each segment of the SEO url.

Specified by:

getGeneratedUrl in interface Category

Returns:

the generated SEO url for this category

setUrlKey

public void setUrlKey(String urlKey)

Description copied from interface: Category

Sets the url key. The url key is used as part of SEO url generation for this category. Each segment of the url leading to a category is comprised of the url keys of the various associated categories in a hierarchy leading to this one.

Specified by:

setUrlKey in interface Category

Parameters:

urlKey - the new url key for this category to appear in the SEO url

getDescription

public String getDescription()

Description copied from interface: Category

Gets the description.

Specified by:

getDescription in interface Category

Returns:

the description

setDescription

public void setDescription(String description)

Description copied from interface: Category

Sets the description.

Specified by:

setDescription in interface Category

Parameters:

description - the new description

getActiveStartDate

public Date getActiveStartDate()

Description copied from interface: Category

Gets the active start date. If the current date is before activeStartDate, then this category will not be visible on the site.

Specified by:

getActiveStartDate in interface Category

Returns:

the active start date

setActiveStartDate

public void setActiveStartDate(Date activeStartDate)

Description copied from interface: Category

Sets the active start date. If the current date is before activeStartDate, then this category will not be visible on the site.

Specified by:

setActiveStartDate in interface Category

Parameters:

activeStartDate - the new active start date

getActiveEndDate

public Date getActiveEndDate()

Description copied from interface: Category

Gets the active end date. If the current date is after activeEndDate, the this category will not be visible on the site.

Specified by:

getActiveEndDate in interface Category

Returns:

the active end date

setActiveEndDate

public void setActiveEndDate(Date activeEndDate)

Description copied from interface: Category

Sets the active end date. If the current date is after activeEndDate, the this category will not be visible on the site.

Specified by:

setActiveEndDate in interface Category

Parameters:

activeEndDate - the new active end date

isActive

public boolean isActive()

Description copied from interface: Category

Checks if is active. Returns true if the startDate is null or if the current date is after the start date, or if the endDate is null or if the current date is before the endDate.

Specified by:

isActive in interface Status

Specified by:

isActive in interface Category

Returns:

true, if is active

getDisplayTemplate

public String getDisplayTemplate()

Description copied from interface: Category

Gets the display template. The display template can be used to help create a unique key that drives the presentation layer destination for this category. For example, if using Spring MVC, you might derive the view destination in this way: view = categoryTemplatePrefix + currentCategory.getDisplayTemplate();

Specified by:

getDisplayTemplate in interface Category

Returns:

the display template

setDisplayTemplate

public void setDisplayTemplate(String displayTemplate)

Description copied from interface: Category

Sets the display template. The display template can be used to help create a unique key that drives the presentation layer destination for this category. For example, if using Spring MVC, you might derive the view destination in this way: view = categoryTemplatePrefix + currentCategory.getDisplayTemplate();

Specified by:

setDisplayTemplate in interface Category

Parameters:

displayTemplate - the new display template

getLongDescription

public String getLongDescription()

Description copied from interface: Category

Gets the long description.

Specified by:

getLongDescription in interface Category

Returns:

the long description

setLongDescription

public void setLongDescription(String longDescription)

Description copied from interface: Category

Sets the long description.

Specified by:

setLongDescription in interface Category

Parameters:

longDescription - the new long description

getDefaultParentCategory

public Category getDefaultParentCategory()

Description copied from interface: Category

Gets the default parent category.

Specified by:

getDefaultParentCategory in interface Category

Returns:

the default parent category

setDefaultParentCategory

public void setDefaultParentCategory(Category defaultParentCategory)

Description copied from interface: Category

Sets the default parent category.

Specified by:

setDefaultParentCategory in interface Category

Parameters:

defaultParentCategory - the new default parent category

getAllChildCategories

public List<Category> getAllChildCategories()

Description copied from interface: Category

Gets the child categories. This list includes all categories, regardless of whether or not they are active.

Specified by:

getAllChildCategories in interface Category

Returns:

the list of active and inactive child categories.

hasAllChildCategories

public boolean hasAllChildCategories()

Description copied from interface: Category

Checks for child categories.

Specified by:

hasAllChildCategories in interface Category

Returns:

true, if this category has any children (active or not)

setAllChildCategories

public void setAllChildCategories(List<Category> childCategories)

Description copied from interface: Category

Sets the list of child categories (active and inactive)

Specified by:

setAllChildCategories in interface Category

Parameters:

childCategories - the list of child categories

getChildCategories

public List<Category> getChildCategories()

Description copied from interface: Category

Gets the child categories. If child categories has not been previously set, then the list of active only categories will be returned.

Specified by:

getChildCategories in interface Category

Returns:

the list of active child categories

hasChildCategories

public boolean hasChildCategories()

Description copied from interface: Category

Checks for child categories.

Specified by:

hasChildCategories in interface Category

Returns:

true, if this category contains any active child categories.

setChildCategories

public void setChildCategories(List<Category> childCategories)

Description copied from interface: Category

Sets the all child categories. This should be a list of active only child categories.

Specified by:

setChildCategories in interface Category

Parameters:

childCategories - the list of active child categories.

getCategoryImages

@Deprecated
public Map<String,String> getCategoryImages()

Deprecated.

Description copied from interface: Category

Gets the category images.

Specified by:

getCategoryImages in interface Category

Returns:

the category images

getCategoryImage

@Deprecated
public String getCategoryImage(String imageKey)

Deprecated.

Description copied from interface: Category

Gets the category image.

Specified by:

getCategoryImage in interface Category

Parameters:

imageKey - the image key

Returns:

the category image

setCategoryImages

@Deprecated
public void setCategoryImages(Map<String,String> categoryImages)

Deprecated.

Description copied from interface: Category

Sets the category images.

Specified by:

setCategoryImages in interface Category

Parameters:

categoryImages - the category images

getChildCategoryURLMap

public Map<String,List<Long>> getChildCategoryURLMap()

Description copied from interface: Category

Gets the child category url map. This map is keyed off of the Category.getGeneratedUrl() values for this category and all of its child categories. By calling get on this map using the generated url for a given category, you will receive the list of immediate child categories. This lifecycle for this map is maintained via the HydratedCacheJPAListener. This listener keeps this map in a separate cache from the normal Hibernate level 2 cache, but will honor cache region settings for this entity, resulting in this map being evicted from its cache when this entity is removed from the Hibernate level 2 cache.

Specified by:

getChildCategoryURLMap in interface Category

Returns:

the child category url map

See Also:

HydratedSetup

createChildCategoryURLMap

public Map<String,List<Long>> createChildCategoryURLMap()

setChildCategoryURLMap

public void setChildCategoryURLMap(Map<String,List<Long>> childCategoryURLMap)

Description copied from interface: Category

Included to support the HydratedCacheJPAListener

Specified by:

setChildCategoryURLMap in interface Category

See Also:

HydratedSetup

buildFullCategoryHierarchy

public List<Category> buildFullCategoryHierarchy(List<Category> currentHierarchy)

Description copied from interface: Category

Build the full category hierarchy by walking up the default category tree and the all parent category tree.

Specified by:

buildFullCategoryHierarchy in interface Category

Returns:

the full hierarchy

buildCategoryHierarchy

public List<Category> buildCategoryHierarchy(List<Category> currentHierarchy)

Description copied from interface: Category

Build category hierarchy by walking the default category tree up to the root category. If the passed in tree is null then create the initial list.

Specified by:

buildCategoryHierarchy in interface Category

Returns:

getAllParentCategories

public List<Category> getAllParentCategories()

Description copied from interface: Category

Retrieve all parent categories

Specified by:

getAllParentCategories in interface Category

Returns:

the list of parent categories

setAllParentCategories

public void setAllParentCategories(List<Category> allParentCategories)

Description copied from interface: Category

Sets the list of parent categories

Specified by:

setAllParentCategories in interface Category

Parameters:

allParentCategories - the list of parent categories

getFeaturedProducts

public List<FeaturedProduct> getFeaturedProducts()

Description copied from interface: Category

Gets the featured products. Featured products are a special list of products you would like to showcase for this category.

Specified by:

getFeaturedProducts in interface Category

Returns:

the featured products

setFeaturedProducts

public void setFeaturedProducts(List<FeaturedProduct> featuredProducts)

Description copied from interface: Category

Sets the featured products. Featured products are a special list of products you would like to showcase for this category.

Specified by:

setFeaturedProducts in interface Category

Parameters:

featuredProducts - the featured products

getCrossSaleProducts

public List<RelatedProduct> getCrossSaleProducts()

Description copied from interface: Category

Returns a list of cross sale products that are related to this category.

Specified by:

getCrossSaleProducts in interface Category

Returns:

a list of cross sale products

setCrossSaleProducts

public void setCrossSaleProducts(List<RelatedProduct> crossSaleProducts)

Description copied from interface: Category

Sets the cross sale products that are related to this category.

Specified by:

setCrossSaleProducts in interface Category

See Also:

Category.getCrossSaleProducts()

getUpSaleProducts

public List<RelatedProduct> getUpSaleProducts()

Description copied from interface: Category

Returns a list of cross sale products that are related to this category.

Specified by:

getUpSaleProducts in interface Category

Returns:

a list of cross sale products

getCumulativeCrossSaleProducts

public List<RelatedProduct> getCumulativeCrossSaleProducts()

Description copied from interface: Category

Returns a list of the cross sale products in this category as well as all cross sale products in all parent categories of this category.

Specified by:

getCumulativeCrossSaleProducts in interface Category

Returns:

the cumulative cross sale products

getCumulativeUpSaleProducts

public List<RelatedProduct> getCumulativeUpSaleProducts()

Description copied from interface: Category

Returns a list of the upsale products in this category as well as all upsale products in all parent categories of this category.

Specified by:

getCumulativeUpSaleProducts in interface Category

Returns:

the cumulative upsale products

getCumulativeFeaturedProducts

public List<FeaturedProduct> getCumulativeFeaturedProducts()

Description copied from interface: Category

Returns a list of the featured products in this category as well as all featured products in all parent categories of this category.

Specified by:

getCumulativeFeaturedProducts in interface Category

Returns:

the cumulative featured products

setUpSaleProducts

public void setUpSaleProducts(List<RelatedProduct> upSaleProducts)

Description copied from interface: Category

Sets the upsale products that are related to this category.

Specified by:

setUpSaleProducts in interface Category

See Also:

Category.getUpSaleProducts()

getActiveProducts

public List<Product> getActiveProducts()

Description copied from interface: Category

Convenience method to retrieve all of this Category's Products filtered by active. If you want all of the Products (whether inactive or not) consider using Category.getAllProducts().

Specified by:

getActiveProducts in interface Category

Returns:

the list of active Products for this Category

See Also:

Product#isActive()}

getAllProducts

public List<Product> getAllProducts()

Description copied from interface: Category

Retrieve all the Product instances associated with this category.
Note: this method does not take into account whether or not the Products are active or not. If you need this functionality, use Category.getActiveProducts()

Specified by:

getAllProducts in interface Category

Returns:

the list of products associated with this category.

setAllProducts

public void setAllProducts(List<Product> allProducts)

Description copied from interface: Category

Set all the Product instances associated with this category.

Specified by:

setAllProducts in interface Category

Parameters:

allProducts - the list of products to associate with this category

getSearchFacets

public List<CategorySearchFacet> getSearchFacets()

Description copied from interface: Category

Returns all of the SearchFacets that are directly associated with this Category

Specified by:

getSearchFacets in interface Category

Returns:

related SearchFacets

setSearchFacets

public void setSearchFacets(List<CategorySearchFacet> searchFacets)

Description copied from interface: Category

Sets the SearchFacets that are directly associated with this Category

Specified by:

setSearchFacets in interface Category

getExcludedSearchFacets

public List<SearchFacet> getExcludedSearchFacets()

Description copied from interface: Category

Gets the excluded SearchFacets

Specified by:

getExcludedSearchFacets in interface Category

Returns:

the excluded SearchFacets

setExcludedSearchFacets

public void setExcludedSearchFacets(List<SearchFacet> excludedSearchFacets)

Description copied from interface: Category

Sets the SearchFacets that should not be rendered by this Category. Typically, this will include facets from parent categories that do not apply to this category.

Specified by:

setExcludedSearchFacets in interface Category

getCumulativeSearchFacets

public List<CategorySearchFacet> getCumulativeSearchFacets()

Description copied from interface: Category

Returns a list of CategorySearchFacets that takes into consideration the search facets for this Category, the search facets for all parent categories, and the search facets that should be excluded from this Category. This method will order the resulting list based on the CategorySearchFacet#getPosition() method for each category level. That is, the facets on this Category will be ordered by their position relative to each other with the ordered parent facets after that, etc.

Specified by:

getCumulativeSearchFacets in interface Category

Returns:

the current active search facets for this category and all parent categories

getCategoryMedia

public Map<String,Media> getCategoryMedia()

Description copied from interface: Category

Gets the category media map. The key is of arbitrary meaning and the Media instance stores information about the media itself (image url, etc...)

Specified by:

getCategoryMedia in interface Category

Returns:

the category Media

setCategoryMedia

public void setCategoryMedia(Map<String,Media> categoryMedia)

Description copied from interface: Category

Sets the category media. The key is of arbitrary meaning and the Media instance stores information about the media itself (image url, etc...)

Specified by:

setCategoryMedia in interface Category

Parameters:

categoryMedia - the category media

getCategoryAttributes

public List<CategoryAttribute> getCategoryAttributes()

Description copied from interface: Category

Gets the attributes for this Category. In smaller sites, using these attributes might be preferred to extending the domain object itself.

Specified by:

getCategoryAttributes in interface Category

Returns:

See Also:

#getMappedCategoryAttributes()}

setCategoryAttributes

public void setCategoryAttributes(List<CategoryAttribute> categoryAttributes)

Description copied from interface: Category

Sets the attributes for this Category. In smaller sites, using these attributes might be preferred to extending the domain object and creating a new table to store custom properties.

Specified by:

setCategoryAttributes in interface Category

getCategoryAttributeByName

public CategoryAttribute getCategoryAttributeByName(String name)

Description copied from interface: Category

Convenience method to get a CategoryAttribute by name

Specified by:

getCategoryAttributeByName in interface Category

Returns:

See Also:

#getCategoryAttributes()}, {@link #getMappedCategoryAttributes()}

getMappedCategoryAttributes

public Map<String,CategoryAttribute> getMappedCategoryAttributes()

Description copied from interface: Category

Convenience method to return the CategoryAttributes for the Category in an easily-consumable form

Specified by:

getMappedCategoryAttributes in interface Category

Returns:

getArchived

public Character getArchived()

Specified by:

getArchived in interface Status

setArchived

public void setArchived(Character archived)

Specified by:

setArchived in interface Status

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object