atg.commerce.search.refinement.admin
Class RefinementConfigurationGenerator

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.commerce.search.refinement.admin.RefinementConfigurationGenerator
All Implemented Interfaces:
NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener
Direct Known Subclasses:
CustomRefinementConfigurationGenerator, StandardRefinementConfigurationGenerator

public abstract class RefinementConfigurationGenerator
extends GenericService

Abstract base class for refinement configuration generators.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 CommerceRefinementConfigurationPropertyManager mCommerceRefinementConfigurationPropertyManager
           
protected  atg.commerce.search.refinement.CommerceFacetSourceGenerator mFacetSourceGenerator
           
protected  IdGenerator mIdGenerator
           
protected  java.lang.String mIdSpace
           
 RefinementElementPropertyManager mRefinementElementPropertyManager
           
 javax.transaction.TransactionManager mTransactionManager
           
 
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
RefinementConfigurationGenerator()
           
 
Method Summary
abstract  RefinementConfigurationCollector collect()
          Convenience method to call generate with a null XML handler, which tells it to update the refinement configuration generated refinement elements, but not create the XML.
abstract  RefinementConfigurationCollector collect(atg.search.index.IndexInfo pIndexInfo)
          Convenience method to call generate with a null XML handler, which tells it to update the refinement configuration generated refinement elements, but not create the XML.
abstract  void generate(RefinementConfigurationCollector pCollector, RefinementConfigurationXMLHandler pHandler)
          Generate the refinement configurations.
 RefinementConfigurationCollectorFactory getCollectorFactory()
          Gets the refinement configuration collector factory.
 CommerceRefinementConfigurationPropertyManager getCommerceRefinementConfigurationPropertyManager()
          Gets the refinement element property manager.
 atg.commerce.search.refinement.CommerceFacetSourceGenerator getFacetSourceGenerator()
           
 IdGenerator getIdGenerator()
           
 java.lang.String getIdSpace()
           
 RefineConfigXMLGenerator getRefineConfigXMLGenerator()
          Gets the refinement configuration XML generator.
 java.lang.String getRefinementElementItemDescriptorName()
          Gets the refinement element item descriptor name from the property manager.
 RefinementElementPropertyManager getRefinementElementPropertyManager()
          Gets the refinement element property manager.
 MutableRepository getRefinementRepository()
          Gets the refinement repository from the property manager.
 javax.transaction.TransactionManager getTransactionManager()
          Gets the transaction manager.
 void setCollectorFactory(RefinementConfigurationCollectorFactory pCollectorFactory)
          Sets the refinement configuration collector.
 void setCommerceRefinementConfigurationPropertyManager(CommerceRefinementConfigurationPropertyManager pCommerceRefinementConfigurationPropertyManager)
          Sets the refinement element property manager.
 void setFacetSourceGenerator(atg.commerce.search.refinement.CommerceFacetSourceGenerator pFacetSourceGenerator)
           
 void setIdGenerator(IdGenerator pIdGenerator)
           
 void setIdSpace(java.lang.String pIdSpace)
           
 void setRefineConfigXMLGenerator(RefineConfigXMLGenerator pRefineConfigXMLGenerator)
          Sets the refinement configuration XML generator.
 void setRefinementElementPropertyManager(RefinementElementPropertyManager pRefinementElementPropertyManager)
          Sets the refinement element property manager.
 void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
          Sets the transaction manager.
protected  void updateAndGenerate(RefinementConfigurationCollector pCollector, RefinementConfigurationXMLHandler pHandler)
          Update the generated refinement elements property of the refinement configurations, and generate the XML for those configurations.
 
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


mIdGenerator

protected IdGenerator mIdGenerator

mIdSpace

protected java.lang.String mIdSpace

mCommerceRefinementConfigurationPropertyManager

public CommerceRefinementConfigurationPropertyManager mCommerceRefinementConfigurationPropertyManager

mTransactionManager

public javax.transaction.TransactionManager mTransactionManager

mRefinementElementPropertyManager

public RefinementElementPropertyManager mRefinementElementPropertyManager

mFacetSourceGenerator

protected atg.commerce.search.refinement.CommerceFacetSourceGenerator mFacetSourceGenerator
Constructor Detail

RefinementConfigurationGenerator

public RefinementConfigurationGenerator()
Method Detail

setIdGenerator

public void setIdGenerator(IdGenerator pIdGenerator)

getIdGenerator

public IdGenerator getIdGenerator()

setIdSpace

public void setIdSpace(java.lang.String pIdSpace)

getIdSpace

public java.lang.String getIdSpace()

setRefineConfigXMLGenerator

public void setRefineConfigXMLGenerator(RefineConfigXMLGenerator pRefineConfigXMLGenerator)
Sets the refinement configuration XML generator.


getRefineConfigXMLGenerator

public RefineConfigXMLGenerator getRefineConfigXMLGenerator()
Gets the refinement configuration XML generator.


setCommerceRefinementConfigurationPropertyManager

public void setCommerceRefinementConfigurationPropertyManager(CommerceRefinementConfigurationPropertyManager pCommerceRefinementConfigurationPropertyManager)
Sets the refinement element property manager.


getCommerceRefinementConfigurationPropertyManager

public CommerceRefinementConfigurationPropertyManager getCommerceRefinementConfigurationPropertyManager()
Gets the refinement element property manager.


getRefinementRepository

public MutableRepository getRefinementRepository()
Gets the refinement repository from the property manager.


setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
Sets the transaction manager.


getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()
Gets the transaction manager.


setRefinementElementPropertyManager

public void setRefinementElementPropertyManager(RefinementElementPropertyManager pRefinementElementPropertyManager)
Sets the refinement element property manager.


getRefinementElementPropertyManager

public RefinementElementPropertyManager getRefinementElementPropertyManager()
Gets the refinement element property manager.


getRefinementElementItemDescriptorName

public java.lang.String getRefinementElementItemDescriptorName()
Gets the refinement element item descriptor name from the property manager.


getCollectorFactory

public RefinementConfigurationCollectorFactory getCollectorFactory()
Gets the refinement configuration collector factory.


setCollectorFactory

public void setCollectorFactory(RefinementConfigurationCollectorFactory pCollectorFactory)
Sets the refinement configuration collector.


setFacetSourceGenerator

public void setFacetSourceGenerator(atg.commerce.search.refinement.CommerceFacetSourceGenerator pFacetSourceGenerator)

getFacetSourceGenerator

public atg.commerce.search.refinement.CommerceFacetSourceGenerator getFacetSourceGenerator()

generate

public abstract void generate(RefinementConfigurationCollector pCollector,
                              RefinementConfigurationXMLHandler pHandler)
Generate the refinement configurations.


collect

public abstract RefinementConfigurationCollector collect()
Convenience method to call generate with a null XML handler, which tells it to update the refinement configuration generated refinement elements, but not create the XML.


collect

public abstract RefinementConfigurationCollector collect(atg.search.index.IndexInfo pIndexInfo)
Convenience method to call generate with a null XML handler, which tells it to update the refinement configuration generated refinement elements, but not create the XML.


updateAndGenerate

protected void updateAndGenerate(RefinementConfigurationCollector pCollector,
                                 RefinementConfigurationXMLHandler pHandler)
                          throws IdGeneratorException,
                                 IndexingException,
                                 RepositoryException
Update the generated refinement elements property of the refinement configurations, and generate the XML for those configurations.

Throws:
IdGeneratorException
IndexingException
RepositoryException