|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.commerce.search.refinement.admin.RefinementConfigurationGenerator
public abstract class RefinementConfigurationGenerator
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
|
protected Repository |
mRefinementRepository
Gets the refinement repository from the property manager. |
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. |
protected RefinementConfigurationCollector |
createCollector(RefinementConfigurationCollectorFactory pFactory)
Create an instance of RefinementConfigurationCollector using the supplied RefinementConfigurationCollectorFactory. |
protected RefinementConfigurationCollector |
createCollector(RefinementConfigurationCollectorFactory pFactory,
MutableRepository pRefinementRepository)
Create an instance of RefinementConfigurationCollector using the supplied RefinementConfigurationCollectorFactory and Refinement repository. |
abstract void |
generate(RefinementConfigurationCollector pCollector,
RefinementConfigurationXMLHandler pHandler)
Generate the refinement configurations. |
protected void |
generateXMLsAndSubmitToEngine(RefinementConfigurationCollector pCollector,
RefinementConfigurationXMLHandler pHandler)
Iterates through the "elementsToConfigurations" map property of pCollector method parameter and for each entry generates a refine-config xml document and submits this to the search engine via the pHandler. |
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()
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getRepositoryItemPropertyValueVariations(MutableRepository pRepository,
RepositoryItem pItem,
java.util.Map<java.lang.String,java.lang.Object> pExpectedValuesMap)
Checks whether specified property values of a RepositoryItem match passed in values. |
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. |
void |
updateCollectedRefineConfigs(RefinementConfigurationCollector pCollector)
Iterates through the "elementsToConfigurations" map property of pCollector method parameter. |
protected void |
updateRepositoryItem(MutableRepository pRepository,
RepositoryItem pItem,
java.lang.String pItemDescriptorName,
java.util.Map<java.lang.String,java.lang.Object> pValues)
Updates a RepositoryItem using a map of property name -> property values. |
protected boolean |
valueMatchesItemPropertyValue(RepositoryItem pItem,
java.lang.String pPropertyName,
java.lang.Object pValue)
Tests whether a given value matches the specified property value of a RepositoryItem and returns the result of the comparison. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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 |
---|
public static java.lang.String CLASS_VERSION
protected IdGenerator mIdGenerator
protected java.lang.String mIdSpace
public CommerceRefinementConfigurationPropertyManager mCommerceRefinementConfigurationPropertyManager
protected Repository mRefinementRepository
public javax.transaction.TransactionManager mTransactionManager
public RefinementElementPropertyManager mRefinementElementPropertyManager
protected atg.commerce.search.refinement.CommerceFacetSourceGenerator mFacetSourceGenerator
Constructor Detail |
---|
public RefinementConfigurationGenerator()
Method Detail |
---|
public void setIdGenerator(IdGenerator pIdGenerator)
public IdGenerator getIdGenerator()
public void setIdSpace(java.lang.String pIdSpace)
public java.lang.String getIdSpace()
public void setRefineConfigXMLGenerator(RefineConfigXMLGenerator pRefineConfigXMLGenerator)
public RefineConfigXMLGenerator getRefineConfigXMLGenerator()
public void setCommerceRefinementConfigurationPropertyManager(CommerceRefinementConfigurationPropertyManager pCommerceRefinementConfigurationPropertyManager)
public CommerceRefinementConfigurationPropertyManager getCommerceRefinementConfigurationPropertyManager()
public MutableRepository getRefinementRepository()
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
public javax.transaction.TransactionManager getTransactionManager()
public void setRefinementElementPropertyManager(RefinementElementPropertyManager pRefinementElementPropertyManager)
public RefinementElementPropertyManager getRefinementElementPropertyManager()
public java.lang.String getRefinementElementItemDescriptorName()
public RefinementConfigurationCollectorFactory getCollectorFactory()
public void setCollectorFactory(RefinementConfigurationCollectorFactory pCollectorFactory)
public void setFacetSourceGenerator(atg.commerce.search.refinement.CommerceFacetSourceGenerator pFacetSourceGenerator)
public atg.commerce.search.refinement.CommerceFacetSourceGenerator getFacetSourceGenerator()
public abstract void generate(RefinementConfigurationCollector pCollector, RefinementConfigurationXMLHandler pHandler)
public abstract RefinementConfigurationCollector collect()
public abstract RefinementConfigurationCollector collect(atg.search.index.IndexInfo pIndexInfo)
protected void generateXMLsAndSubmitToEngine(RefinementConfigurationCollector pCollector, RefinementConfigurationXMLHandler pHandler) throws IdGeneratorException, atg.repository.search.indexing.IndexingException, RepositoryException
pCollector
- pHandler
-
IdGeneratorException
atg.repository.search.indexing.IndexingException
RepositoryException
public void updateCollectedRefineConfigs(RefinementConfigurationCollector pCollector) throws atg.repository.search.indexing.IndexingException
pCollector
-
atg.repository.search.indexing.IndexingException
protected java.util.Map<java.lang.String,java.lang.Object> getRepositoryItemPropertyValueVariations(MutableRepository pRepository, RepositoryItem pItem, java.util.Map<java.lang.String,java.lang.Object> pExpectedValuesMap) throws RepositoryException
pRepository
- pItem
- pExpectedValuesMap
-
RepositoryException
protected boolean valueMatchesItemPropertyValue(RepositoryItem pItem, java.lang.String pPropertyName, java.lang.Object pValue) throws RepositoryException
pItem
- pPropertyName
- pValue
-
RepositoryException
protected void updateRepositoryItem(MutableRepository pRepository, RepositoryItem pItem, java.lang.String pItemDescriptorName, java.util.Map<java.lang.String,java.lang.Object> pValues) throws RepositoryException
pRepository
- pItem
- pValues
-
RepositoryException
protected RefinementConfigurationCollector createCollector(RefinementConfigurationCollectorFactory pFactory)
pFactory
-
protected RefinementConfigurationCollector createCollector(RefinementConfigurationCollectorFactory pFactory, MutableRepository pRefinementRepository)
pFactory
- pRefinementRepository
- idGenerator
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |