|
|||||||||
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 atg.commerce.search.refinement.admin.CustomRefinementConfigurationGenerator
public class CustomRefinementConfigurationGenerator
Refinement configuration generator for custom catalogs.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected CustomCatalogTools |
mCustomCatalogTools
|
Fields inherited from class atg.commerce.search.refinement.admin.RefinementConfigurationGenerator |
---|
mCommerceRefinementConfigurationPropertyManager, mFacetSourceGenerator, mIdGenerator, mIdSpace, mRefinementElementPropertyManager, mRefinementRepository, 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 | |
---|---|
CustomRefinementConfigurationGenerator()
|
Method Summary | |
---|---|
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 atg.repository.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. |
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 CustomCatalogTools mCustomCatalogTools
Constructor Detail |
---|
public CustomRefinementConfigurationGenerator()
Method Detail |
---|
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 atg.repository.ContextFilteringRule[] getContextFilteringRulesForSites(java.util.Collection<java.lang.String> pSites)
pSites
- The array of site ids
public 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 operation
true
if refinement collection completes successfully;
otherwise false
public void generate(RefinementConfigurationCollector pCollector, RefinementConfigurationXMLHandler pHandler)
RefinementConfigurationGenerator
generate
in class RefinementConfigurationGenerator
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |