atg.commerce.search.refinement
Class CategoryFacetValue

java.lang.Object
  atg.repository.search.refinement.FacetValue
      atg.commerce.search.refinement.CategoryFacetValue

All Implemented Interfaces:

java.lang.Cloneable

public class CategoryFacetValue
extends FacetValue

Represents a category-specific refinement element. For example, a Screen Size facet that is assigned to a TV category. Extends the RefinementFacet by providing a lazy lookup method to retrieve the category's repository item. Users of this class should call the setCatalogTools() and setCategoryId() or setCategoryItem() methods.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mCategoryId
protected RepositoryItem	mCategoryItem
protected CommerceFacetManager	mFacetManager

Fields inherited from class atg.repository.search.refinement.FacetValue

DEFAULT_IDVALUE_SEPARATOR, mFacet, mMatchingDocsCount, mRefinementValue, mScore, mSeparator, mValue

Constructor Summary

CategoryFacetValue(atg.repository.search.refinement.Facet pFacet, java.lang.String pValue, java.lang.String pSeparator, CommerceFacetManager pFacetManager)
Constructor method

Method Summary

java.lang.String	getCategoryId()
RepositoryItem	getCategoryItem() Gets the category's repository item, retrieving this from the product catalog if we don't already have this.
CommerceFacetManager	getCommerceFacetManager()
void	setCategoryId(java.lang.String pCategoryId)
void	setCategoryItem(RepositoryItem pCategoryItem)
void	setCommerceFacetManager(CommerceFacetManager pFacetManager)

Methods inherited from class atg.repository.search.refinement.FacetValue

clone, equals, getDebug, getFacet, getMatchingDocsCount, getRefinementValue, getScore, getSeparator, getTrailString, getValue, hashCode, setFacet, setMatchingDocsCount, setRefinementValue, setScore, setSeparator, setValue, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mCategoryItem

protected RepositoryItem mCategoryItem

mCategoryId

protected java.lang.String mCategoryId

mFacetManager

protected CommerceFacetManager mFacetManager

Constructor Detail

CategoryFacetValue

public CategoryFacetValue(atg.repository.search.refinement.Facet pFacet,
                          java.lang.String pValue,
                          java.lang.String pSeparator,
                          CommerceFacetManager pFacetManager)

Constructor method

Parameters:

pFacet - Facet

pValue - String value

pSeparator - String trail separator

Method Detail

getCategoryItem

public RepositoryItem getCategoryItem()
                               throws atg.repository.search.refinement.FacetException

Gets the category's repository item, retrieving this from the product catalog if we don't already have this.

Returns:

RepositoryItem for this category

Throws:

atg.repository.search.refinement.FacetException

setCategoryItem

public void setCategoryItem(RepositoryItem pCategoryItem)

getCategoryId

public java.lang.String getCategoryId()

setCategoryId

public void setCategoryId(java.lang.String pCategoryId)

getCommerceFacetManager

public CommerceFacetManager getCommerceFacetManager()

setCommerceFacetManager

public void setCommerceFacetManager(CommerceFacetManager pFacetManager)