|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.commerce.search.refinement.admin.RefinementConfigurationCollector atg.commerce.search.refinement.admin.CommerceRefinementConfigurationCollector atg.commerce.search.refinement.admin.CustomRefinementConfigurationCollector
public class CustomRefinementConfigurationCollector
Extension of CommerceRefinementConfigurationCollector that can process custom catalogs.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected RepositoryItem |
mCurrentCatalog
|
protected java.util.Set |
mCurrentCatalogElements
|
Fields inherited from class atg.commerce.search.refinement.admin.CommerceRefinementConfigurationCollector |
---|
REPOSITORY_NOT_MUTABLE_MSG |
Fields inherited from class atg.commerce.search.refinement.admin.RefinementConfigurationCollector |
---|
mConfigurationToElements, mElementSourceMap, mElementsToConfigurations, mExistingNameMap |
Constructor Summary | |
---|---|
CustomRefinementConfigurationCollector()
|
Method Summary | |
---|---|
protected void |
addAdditionalElements(RepositoryItem pRefineConfig,
java.util.Set pElements)
|
protected java.util.Set |
getAllRootCategoriesForCatalog(RepositoryItem pCatalog,
java.util.Set pVisited,
java.util.Set pSeedCategories)
Gets the root categories for the catalog, and all of its subcatalogs. |
java.lang.String |
getCatalogChildCatalogsPropertyName()
Gets the property name of a catalog that designates its child catalogs. |
java.lang.String |
getCatalogRefineConfigPropertyName()
Gets the catalog property name that contains the refinement configuration item. |
Repository |
getCatalogRepository()
Gets the catalog repository. |
java.lang.String |
getCatalogRootCategoriesPropertyName()
Gets the name of the root categories property of the catalog item. |
java.lang.String |
getCategoryChildCatalogsPropertyName()
Gets the property name of a category that designated its child catalogs. |
java.lang.String |
getCategoryInfoCatalogPropertyName()
Gets the name of the category-info catalog property. |
java.lang.String |
getCategoryInfoCategoryItemPropertyName()
Gets the name of the category-info category item property. |
java.lang.String |
getCategoryInfoItemDescriptorName()
Gets the name of the category info item descriptor. |
java.lang.String |
getCategoryInfoRefineConfigPropertyName()
Gets the name of the category-info refine config property. |
RepositoryItem |
getCurrentRootCatalog()
get CurrentRootCatalog |
CustomCatalogTools |
getCustomCatalogTools()
Gets the custom catalog tools component. |
CustomRefinementConfigurationPropertyManager |
getCustomRefinementConfigurationPropertyManager()
|
protected RefinementConfigurationContainer |
getRefineConfigContainerForCategory(RepositoryItem pCategory,
RepositoryItem pParentRefineConfig,
java.util.Set pPath)
Use the "current category" field to look up, via the catalog info items, the proper refinement configuration. |
protected RefinementConfigurationContainer |
getRefineConfigForCatalog(RepositoryItem pCatalog,
RepositoryItem pParentRefineConfig,
java.util.Set pPath)
Gets the refinement configuration container for the give catalog item. |
protected void |
processCatalog(RepositoryItem pCatalog,
java.util.Collection pParentCatalogElementIds,
java.util.Set pPath,
RepositoryItem pParentRefineConfig)
Process a catalog item, recursing into subcatalogs and root categories as necessary. |
protected void |
processCatalog(RepositoryItem pCatalog,
java.util.Collection pParentCatalogElementIds,
java.util.Set pPath,
RepositoryItem pParentRefineConfig,
java.lang.String pPrefix)
Process a catalog item, recursing into subcatalogs and root categories as necessary. |
protected void |
processCategoryChildren(RepositoryItem pCategory,
java.util.Set pParentAndLocalREs,
java.util.Set pPath,
java.lang.String pPrefix)
Process child categories, then child catalogs. |
void |
setCatalogChildCatalogsPropertyName(java.lang.String pCatalogChildCatalogsPropertyName)
Sets the property name of a catalog that designates its child catalogs. |
void |
setCatalogRefineConfigPropertyName(java.lang.String pCatalogRefineConfigPropertyName)
Sets the catalog property name that contains the refinement configuration item. |
void |
setCatalogRootCategoriesPropertyName(java.lang.String pCatalogRootCategoriesPropertyName)
Sets the name of the root categories property of the catalog item. |
void |
setCategoryChildCatalogsPropertyName(java.lang.String pCategoryChildCatalogsPropertyName)
Sets the property name of a category that designated its child catalogs. |
void |
setCategoryInfoCatalogPropertyName(java.lang.String pCategoryInfoCatalogPropertyName)
Sets the name of the category-info catalog property. |
void |
setCategoryInfoCategoryItemPropertyName(java.lang.String pCategoryInfoCategoryItemPropertyName)
Sets the name of the category-info category item property. |
void |
setCategoryInfoItemDescriptorName(java.lang.String pCategoryInfoItemDescriptorName)
Sets the name of the category info item descriptor. |
void |
setCategoryInfoRefineConfigPropertyName(java.lang.String pCategoryInfoRefineConfigPropertyName)
Sets the name of the category-info refine config property. |
void |
setCurrentRootCatalog(RepositoryItem pCurrentRootCatalog)
set CurrentRootCatalog |
void |
setCustomCatalogTools(CustomCatalogTools pCustomCatalogTools)
Sets the custom catalog tools component. |
protected void |
updateInheritFlags(RefinementConfigurationContainer pContainer,
RepositoryItem pRefineConfig,
RepositoryItem pParentRefineConfig)
Handles updates to the inheritance flags. |
Methods inherited from class atg.commerce.search.refinement.admin.CommerceRefinementConfigurationCollector |
---|
canInheritParentFacetInheritanceFlags, createOrUpdateCategoryRefineConfig, hasLocalRefineElements, processCategory, processCategory, resolveInheritValues |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected RepositoryItem mCurrentCatalog
protected java.util.Set mCurrentCatalogElements
Constructor Detail |
---|
public CustomRefinementConfigurationCollector()
Method Detail |
---|
public java.lang.String getCatalogRefineConfigPropertyName()
public void setCatalogRefineConfigPropertyName(java.lang.String pCatalogRefineConfigPropertyName)
public java.lang.String getCatalogChildCatalogsPropertyName()
public void setCatalogChildCatalogsPropertyName(java.lang.String pCatalogChildCatalogsPropertyName)
public java.lang.String getCategoryChildCatalogsPropertyName()
public void setCategoryChildCatalogsPropertyName(java.lang.String pCategoryChildCatalogsPropertyName)
public CustomCatalogTools getCustomCatalogTools()
public void setCustomCatalogTools(CustomCatalogTools pCustomCatalogTools)
public Repository getCatalogRepository()
public java.lang.String getCatalogRootCategoriesPropertyName()
public void setCatalogRootCategoriesPropertyName(java.lang.String pCatalogRootCategoriesPropertyName)
public java.lang.String getCategoryInfoItemDescriptorName()
public void setCategoryInfoItemDescriptorName(java.lang.String pCategoryInfoItemDescriptorName)
public java.lang.String getCategoryInfoCatalogPropertyName()
public void setCategoryInfoCatalogPropertyName(java.lang.String pCategoryInfoCatalogPropertyName)
public java.lang.String getCategoryInfoCategoryItemPropertyName()
public void setCategoryInfoCategoryItemPropertyName(java.lang.String pCategoryInfoCategoryItemPropertyName)
public java.lang.String getCategoryInfoRefineConfigPropertyName()
public void setCategoryInfoRefineConfigPropertyName(java.lang.String pCategoryInfoRefineConfigPropertyName)
public CustomRefinementConfigurationPropertyManager getCustomRefinementConfigurationPropertyManager()
public void setCurrentRootCatalog(RepositoryItem pCurrentRootCatalog)
pCurrentRootCatalog
- the CurrentRootCatalogpublic RepositoryItem getCurrentRootCatalog()
protected RefinementConfigurationContainer getRefineConfigForCatalog(RepositoryItem pCatalog, RepositoryItem pParentRefineConfig, java.util.Set pPath) throws RepositoryException
RepositoryException
protected void processCatalog(RepositoryItem pCatalog, java.util.Collection pParentCatalogElementIds, java.util.Set pPath, RepositoryItem pParentRefineConfig) throws RepositoryException
RepositoryException
protected void processCatalog(RepositoryItem pCatalog, java.util.Collection pParentCatalogElementIds, java.util.Set pPath, RepositoryItem pParentRefineConfig, java.lang.String pPrefix) throws RepositoryException
RepositoryException
protected RefinementConfigurationContainer getRefineConfigContainerForCategory(RepositoryItem pCategory, RepositoryItem pParentRefineConfig, java.util.Set pPath) throws RepositoryException
getRefineConfigContainerForCategory
in class CommerceRefinementConfigurationCollector
RepositoryException
protected java.util.Set getAllRootCategoriesForCatalog(RepositoryItem pCatalog, java.util.Set pVisited, java.util.Set pSeedCategories) throws RepositoryException
RepositoryException
protected void processCategoryChildren(RepositoryItem pCategory, java.util.Set pParentAndLocalREs, java.util.Set pPath, java.lang.String pPrefix) throws RepositoryException
processCategoryChildren
in class CommerceRefinementConfigurationCollector
RepositoryException
protected void addAdditionalElements(RepositoryItem pRefineConfig, java.util.Set pElements)
addAdditionalElements
in class CommerceRefinementConfigurationCollector
protected void updateInheritFlags(RefinementConfigurationContainer pContainer, RepositoryItem pRefineConfig, RepositoryItem pParentRefineConfig) throws RepositoryException
updateInheritFlags
in class CommerceRefinementConfigurationCollector
pContainer
- The refine config container.pRefineConfig
- The refine config to be updatedpParentRefineConfig
- The parent refine config to retrieve inheritance values from.
RepositoryException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |