atg.commerce.search.refinement.admin
Class CustomCollectorFactory

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.commerce.search.refinement.admin.StandardCollectorFactory
              extended by atg.commerce.search.refinement.admin.CustomCollectorFactory
All Implemented Interfaces:
RefinementConfigurationCollectorFactory, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class CustomCollectorFactory
extends StandardCollectorFactory

A refinement configuration collector factory that creates custom refinement configuration collector objects.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Fields inherited from class atg.nucleus.GenericService
SERVICE_INFO_KEY
 
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging
DEFAULT_LOG_TRACE_STATUS
 
Fields inherited from interface atg.nucleus.logging.ApplicationLogging
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
 
Constructor Summary
CustomCollectorFactory()
           
 
Method Summary
 RefinementConfigurationCollector createCollector()
          Create and initialize a custom refinement configuration collector.
 java.lang.String getCatalogChildCatalogsPropertyName()
           
 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 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.
 CustomCatalogTools getCustomCatalogTools()
          Gets the custom catalog tools component.
protected  void initializeCollector(RefinementConfigurationCollector pCollector)
          Set properties in the newly created custom refinement configuration collector.
 void setCatalogChildCatalogsPropertyName(java.lang.String pCatalogChildCatalogsPropertyName)
           
 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 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 setCustomCatalogTools(CustomCatalogTools pCustomCatalogTools)
          Sets the custom catalog tools component.
 
Methods inherited from class atg.commerce.search.refinement.admin.StandardCollectorFactory
getCategoryChildCategoriesPropertyName, getCategoryRefineConfigPropertyName, getCommerceRefinementConfigurationPropertyManager, getPropagateFacetInheritanceFlagsValues, getRefinementElementPropertyManager, setCategoryChildCategoriesPropertyName, setCategoryRefineConfigPropertyName, setCommerceRefinementConfigurationPropertyManager, setPropagateFacetInheritanceFlagsValues, setRefinementElementPropertyManager
 
Methods inherited from class atg.nucleus.GenericService
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
 
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

CustomCollectorFactory

public CustomCollectorFactory()
Method Detail

getCatalogRefineConfigPropertyName

public java.lang.String getCatalogRefineConfigPropertyName()
Gets the catalog property name that contains the refinement configuration item.


setCatalogRefineConfigPropertyName

public void setCatalogRefineConfigPropertyName(java.lang.String pCatalogRefineConfigPropertyName)
Sets the catalog property name that contains the refinement configuration item.


getCatalogChildCatalogsPropertyName

public java.lang.String getCatalogChildCatalogsPropertyName()

setCatalogChildCatalogsPropertyName

public void setCatalogChildCatalogsPropertyName(java.lang.String pCatalogChildCatalogsPropertyName)

getCustomCatalogTools

public CustomCatalogTools getCustomCatalogTools()
Gets the custom catalog tools component.


setCustomCatalogTools

public void setCustomCatalogTools(CustomCatalogTools pCustomCatalogTools)
Sets the custom catalog tools component.


getCatalogRepository

public Repository getCatalogRepository()
Gets the catalog repository.


getCatalogRootCategoriesPropertyName

public java.lang.String getCatalogRootCategoriesPropertyName()
Gets the name of the root categories property of the catalog item.


setCatalogRootCategoriesPropertyName

public void setCatalogRootCategoriesPropertyName(java.lang.String pCatalogRootCategoriesPropertyName)
Sets the name of the root categories property of the catalog item.


getCategoryInfoItemDescriptorName

public java.lang.String getCategoryInfoItemDescriptorName()
Gets the name of the category info item descriptor.


setCategoryInfoItemDescriptorName

public void setCategoryInfoItemDescriptorName(java.lang.String pCategoryInfoItemDescriptorName)
Sets the name of the category info item descriptor.


getCategoryInfoCatalogPropertyName

public java.lang.String getCategoryInfoCatalogPropertyName()
Gets the name of the category-info catalog property.


setCategoryInfoCatalogPropertyName

public void setCategoryInfoCatalogPropertyName(java.lang.String pCategoryInfoCatalogPropertyName)
Sets the name of the category-info catalog property.


getCategoryInfoCategoryItemPropertyName

public java.lang.String getCategoryInfoCategoryItemPropertyName()
Gets the name of the category-info category item property.


setCategoryInfoCategoryItemPropertyName

public void setCategoryInfoCategoryItemPropertyName(java.lang.String pCategoryInfoCategoryItemPropertyName)
Sets the name of the category-info category item property.


getCategoryInfoRefineConfigPropertyName

public java.lang.String getCategoryInfoRefineConfigPropertyName()
Gets the name of the category-info refine config property.


setCategoryInfoRefineConfigPropertyName

public void setCategoryInfoRefineConfigPropertyName(java.lang.String pCategoryInfoRefineConfigPropertyName)
Sets the name of the category-info refine config property.


initializeCollector

protected void initializeCollector(RefinementConfigurationCollector pCollector)
Set properties in the newly created custom refinement configuration collector.

Overrides:
initializeCollector in class StandardCollectorFactory

createCollector

public RefinementConfigurationCollector createCollector()
Create and initialize a custom refinement configuration collector.

Specified by:
createCollector in interface RefinementConfigurationCollectorFactory
Overrides:
createCollector in class StandardCollectorFactory