public class CustomRefinementConfigurationGenerator extends RefinementConfigurationGenerator
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected CustomCatalogTools |
mCustomCatalogTools |
mCommerceRefinementConfigurationPropertyManager, mFacetSourceGenerator, mIdGenerator, mIdSpace, mRefinementElementPropertyManager, mRefinementRepository, mTransactionManager
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
CustomRefinementConfigurationGenerator() |
Modifier and Type | Method and Description |
---|---|
RefinementConfigurationCollector |
collect()
Run the custom catalog refinement configuration collector, and generate the
refinement configuration XML files necessary to support each category and
catalog.
|
RefinementConfigurationCollector |
collect(boolean pUpdateRepositories,
Repository pProductCatalogRepository,
Repository pRefinementRepository,
atg.commerce.search.refinement.admin.RefinementGenerationDeploymentHelper pRefinementGenerationDeploymentHelper)
Run the custom catalog refinement configuration collector, and generate the
refinement configuration XML files necessary to support each category and
catalog.
|
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 boolean |
doCollect(CustomRefinementConfigurationCollector pCollector,
atg.search.index.IndexInfo pIndexInfo)
Does the actual business of refinement collection.
|
void |
generate(RefinementConfigurationCollector pCollector,
RefinementConfigurationXMLHandler pHandler)
Generate the refinement configurations.
|
Repository |
getCatalogRepository()
Gets the catalog repository
|
RepositoryItem[] |
getCatalogs()
Get the catalogs that will be used to generate refinement configurations.
|
protected RepositoryItem[] |
getCatalogs(atg.search.index.IndexInfo pIndexInfo)
Get the catalogs that will be used to generate refinement configurations.
|
RepositoryItem[] |
getCatalogs(Repository pProductCatalogRepository) |
protected RepositoryItem[] |
getCatalogs(Repository pProductCatalogRepository,
atg.search.index.IndexInfo pIndexInfo) |
protected ContextFilteringRule[] |
getContextFilteringRulesForSites(java.util.Collection<java.lang.String> pSites)
Gets a array of ContextFilteringRules for an array of site ids.
|
CustomCatalogTools |
getCustomCatalogTools()
Gets the custom catalog tools component.
|
void |
setCustomCatalogTools(CustomCatalogTools pCustomCatalogTools)
Sets the custom catalog tools component.
|
createCollector, createCollector, generateXMLsAndSubmitToEngine, getCollectorFactory, getCommerceRefinementConfigurationPropertyManager, getFacetSourceGenerator, getIdGenerator, getIdSpace, getRefineConfigXMLGenerator, getRefinementElementItemDescriptorName, getRefinementElementPropertyManager, getRefinementRepository, getRepositoryItemPropertyValueVariations, getTransactionManager, setCollectorFactory, setCommerceRefinementConfigurationPropertyManager, setFacetSourceGenerator, setIdGenerator, setIdSpace, setRefineConfigXMLGenerator, setRefinementElementPropertyManager, setTransactionManager, updateCollectedRefineConfigs, updateRepositoryItem, valueMatchesItemPropertyValue
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, 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, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
protected CustomCatalogTools mCustomCatalogTools
public CustomRefinementConfigurationGenerator()
public void setCustomCatalogTools(CustomCatalogTools pCustomCatalogTools)
public CustomCatalogTools getCustomCatalogTools()
public Repository getCatalogRepository()
public RepositoryItem[] getCatalogs() throws RepositoryException
RepositoryException
public RepositoryItem[] getCatalogs(Repository pProductCatalogRepository) throws RepositoryException
RepositoryException
protected RepositoryItem[] getCatalogs(atg.search.index.IndexInfo pIndexInfo) throws RepositoryException
pIndexInfo
- RepositoryException
protected RepositoryItem[] getCatalogs(Repository pProductCatalogRepository, atg.search.index.IndexInfo pIndexInfo) throws RepositoryException
RepositoryException
protected ContextFilteringRule[] getContextFilteringRulesForSites(java.util.Collection<java.lang.String> pSites)
pSites
- The array of site idspublic RefinementConfigurationCollector collect()
collect
in class RefinementConfigurationGenerator
public RefinementConfigurationCollector collect(atg.search.index.IndexInfo pIndexInfo)
RefinementConfigurationGenerator
collect
in class RefinementConfigurationGenerator
public RefinementConfigurationCollector collect(boolean pUpdateRepositories, Repository pProductCatalogRepository, Repository pRefinementRepository, atg.commerce.search.refinement.admin.RefinementGenerationDeploymentHelper pRefinementGenerationDeploymentHelper)
pShadowRepositoryHelper
- protected boolean doCollect(CustomRefinementConfigurationCollector pCollector, atg.search.index.IndexInfo pIndexInfo)
pCollector
- - fully initialized CustomRefinementConfigurationCollectorpIndexInfo
- - IndexInfo encapsulating the sites relevant to this
indexing operationtrue
if refinement collection completes successfully;
otherwise false
public void generate(RefinementConfigurationCollector pCollector, RefinementConfigurationXMLHandler pHandler)
RefinementConfigurationGenerator
generate
in class RefinementConfigurationGenerator