atg.repository.search.indexing.config

Class SearchUpdateAdapter

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.search.adapter.customization.CustomizationDataAdapterImpl

atg.repository.search.indexing.config.SearchUpdateAdapter

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, atg.search.adapter.customization.CustomizationDataAdapter, java.util.EventListener

public class SearchUpdateAdapter
extends atg.search.adapter.customization.CustomizationDataAdapterImpl

This class is a search adapter to collect dynamically changing data for a specific type of item.
The adapter will be registered with search administration and should be kicked off regularly.
It contains a list of collector classes which carry out the specific data collection and an xml generator.
The xml generator creates the xml required by the search engine from an array of SearchUpdateOutputProperty objects.
Typically this adapter is configured to collect data for all sku or products in the product catalog.
It will iterate through the items and call the collectors to process them.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

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

Constructors

Constructor and Description
SearchUpdateAdapter() Constructs an instanceof RefineConfigAdapter

Method Summary

Modifier and Type	Method and Description
protected RepositoryIterator	createRepositoryIterator(boolean pAutoFetchNextBatch, int pStartIndex, boolean pPreloadBatch, ContextFilteringRules pRules) Utility method to create a RepositoryIterator
java.util.List	enumerateAutoApplyCustomizationItemsByTypeAndProject(atg.search.adapter.customization.CustomizationType pCustomizationType, java.lang.String pProjectId) Returns the ids for the customization items defined by this adapter.
java.util.List	enumerateCustomizationItems() Returns the ids for the customization items defined by this adapter.
java.util.List	enumerateCustomizationItemsByType(atg.search.adapter.customization.CustomizationType pCustomizationType) Returns the ids for the customization items defined by this adapter.
protected java.util.List<java.lang.String>	enumerateItems(RepositoryIterator pRepositoryIterator)
protected void	generateXMLForProperties(java.lang.String pId, java.util.List pOutputProperties, java.io.OutputStream pOut)
RepositoryItemDescriptor	getBatchItemDescriptor()
java.lang.String	getBatchItemDescriptorName()
int	getBatchSize()
java.lang.String	getBatchXMLAsString(RepositoryIterator pRepositoryIterator) Method to enumerate through the items and create the XML as a single string.
java.lang.String	getBatchXMLAsString(java.lang.String pId) Method to enumerate through the items and create the XML as a single string.
SearchUpdateCollector[]	getCollectors()
protected ContextFilteringRules	getContextFilteringRules(atg.search.index.IndexInfo pIndexInfo) Retrieve siteIds from pIndexInfo.siteIndexInfo and use same to create ContextFilteringRules
protected ContextFilteringRules	getContextFilteringRulesForSites(java.util.Collection<java.lang.String> pSites) Creates a ContextFilteringRules from an array of site ids.
atg.search.adapter.customization.CustomizationItem	getCustomizationItem(atg.search.adapter.customization.CustomizationType pCustomizationType, java.lang.String pCustomizationItemId) Returns a customization item for the requested id
java.lang.String	getDisplayName() Returns the display name for this customization adapter.
java.lang.String	getIndexedIdPropertyName()
RepositoryItemDescriptor	getIndexedItemDescriptor()
java.lang.String	getIndexedItemDescriptorName()
RepositoryItemGroup	getIndexedItemsGroup()
Repository	getIndexedRepository()
atg.repository.search.indexing.config.SearchUpdateHelper	getSearchUpdateHelper()
java.util.Collection	getSupportedCustomizationTypes() Returns a collection of the customization types supported by this adapter.
javax.transaction.TransactionManager	getTransactionManager()
SearchUpdateXMLGenerator	getXMLGenerator()
protected boolean	isAdapterFullyConfigured() Checks that necessary properties and components required for the adapter to operate are all properly configured.
boolean	isAutoApplyAll() Whether to auto-apply all customization items.
protected void	populateListForItem(java.lang.String pId, java.util.List pOutputProperties)
void	processBatches(atg.repository.search.indexing.config.SearchUpdateXMLHandler pSearchUpdateXMLHandler, atg.search.index.IndexInfo pIndexInfo) Main "driver" method that uses a RepositoryIterator to identify then iterate over batches of items.
void	setBatchItemDescriptorName(java.lang.String pBatchItemDescriptorName)
void	setBatchSize(int pBatchSize)
void	setCollectors(SearchUpdateCollector[] pCollectors)
void	setDisplayName(java.lang.String pDisplayName)
void	setIndexedIdPropertyName(java.lang.String pIndexedIdPropertyName)
void	setIndexedItemDescriptorName(java.lang.String pIndexedItemDescriptorName)
void	setIndexedItemsGroup(RepositoryItemGroup pIndexedItemsGroup)
void	setIndexedRepository(Repository pIndexedRepository)
void	setSearchUpdateHelper(atg.repository.search.indexing.config.SearchUpdateHelper pSearchUpdateHelper)
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
void	setXMLGenerator(SearchUpdateXMLGenerator pXMLGenerator)

Methods inherited from class atg.search.adapter.customization.CustomizationDataAdapterImpl

getDisplayNameResource, getLocalizedDisplayName, getResourceBundleName, setDisplayNameResource, setResourceBundleName

Methods inherited from class atg.nucleus.GenericService

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, toString

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, wait, wait, wait

Methods inherited from interface atg.naming.NameContextElement

getName, getNameContext

Methods inherited from interface atg.naming.NameContextBindingListener

nameContextElementBound, nameContextElementUnbound

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

SearchUpdateAdapter

public SearchUpdateAdapter()

Constructs an instanceof RefineConfigAdapter

Method Detail

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

getIndexedRepository

public Repository getIndexedRepository()

setIndexedRepository

public void setIndexedRepository(Repository pIndexedRepository)

getXMLGenerator

public SearchUpdateXMLGenerator getXMLGenerator()

setXMLGenerator

public void setXMLGenerator(SearchUpdateXMLGenerator pXMLGenerator)

setBatchSize

public void setBatchSize(int pBatchSize)

getBatchSize

public int getBatchSize()

setIndexedItemDescriptorName

public void setIndexedItemDescriptorName(java.lang.String pIndexedItemDescriptorName)

getIndexedItemDescriptorName

public java.lang.String getIndexedItemDescriptorName()

getIndexedItemDescriptor

public RepositoryItemDescriptor getIndexedItemDescriptor()

setBatchItemDescriptorName

public void setBatchItemDescriptorName(java.lang.String pBatchItemDescriptorName)

getBatchItemDescriptorName

public java.lang.String getBatchItemDescriptorName()

getBatchItemDescriptor

public RepositoryItemDescriptor getBatchItemDescriptor()

setIndexedIdPropertyName

public void setIndexedIdPropertyName(java.lang.String pIndexedIdPropertyName)

getIndexedIdPropertyName

public java.lang.String getIndexedIdPropertyName()

setCollectors

public void setCollectors(SearchUpdateCollector[] pCollectors)

getCollectors

public SearchUpdateCollector[] getCollectors()

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

setIndexedItemsGroup

public void setIndexedItemsGroup(RepositoryItemGroup pIndexedItemsGroup)

getIndexedItemsGroup

public RepositoryItemGroup getIndexedItemsGroup()

setSearchUpdateHelper

public void setSearchUpdateHelper(atg.repository.search.indexing.config.SearchUpdateHelper pSearchUpdateHelper)

getSearchUpdateHelper

public atg.repository.search.indexing.config.SearchUpdateHelper getSearchUpdateHelper()

isAutoApplyAll

public boolean isAutoApplyAll()

Whether to auto-apply all customization items. This also hides the customization items from enumerateCustomizationItemsByType, and enumerateCustomizationItems methods from the CustomizationDataAdapter interface.

Specified by:

isAutoApplyAll in interface atg.search.adapter.customization.CustomizationDataAdapter

Overrides:

isAutoApplyAll in class atg.search.adapter.customization.CustomizationDataAdapterImpl

enumerateCustomizationItemsByType

public java.util.List enumerateCustomizationItemsByType(atg.search.adapter.customization.CustomizationType pCustomizationType)

Returns the ids for the customization items defined by this adapter. The ids will be passed into #getCustomizationItem() to retrieve the actual customization item.

Specified by:

enumerateCustomizationItemsByType in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

enumerateCustomizationItemsByType in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Returns:

List of String representing the customization items defined by this adapter.

enumerateCustomizationItems

public java.util.List enumerateCustomizationItems()

Returns the ids for the customization items defined by this adapter. The ids will be passed into #getCustomizationItem() to retrieve the actual customization item. For search updates we will deploy all commands as one single item, so only 1 id will be returned.

Specified by:

enumerateCustomizationItems in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

enumerateCustomizationItems in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Returns:

List of String representing the customization items defined by this adapter.

enumerateAutoApplyCustomizationItemsByTypeAndProject

public java.util.List enumerateAutoApplyCustomizationItemsByTypeAndProject(atg.search.adapter.customization.CustomizationType pCustomizationType,
                                                                           java.lang.String pProjectId)
                                                                    throws atg.search.adapter.exception.CustomizationItemNotFoundException

Returns the ids for the customization items defined by this adapter. The ids will be passed into #getCustomizationItem() to retrieve the actual customization item.

Specified by:

enumerateAutoApplyCustomizationItemsByTypeAndProject in interface atg.search.adapter.customization.CustomizationDataAdapter

Overrides:

enumerateAutoApplyCustomizationItemsByTypeAndProject in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Returns:

List of String representing the customization items defined by this adapter.

Throws:

atg.search.adapter.exception.CustomizationItemNotFoundException

getCustomizationItem

public atg.search.adapter.customization.CustomizationItem getCustomizationItem(atg.search.adapter.customization.CustomizationType pCustomizationType,
                                                                               java.lang.String pCustomizationItemId)
                                                                        throws atg.search.adapter.exception.CustomizationItemNotFoundException

Returns a customization item for the requested id

Specified by:

getCustomizationItem in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

getCustomizationItem in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Parameters:

pCustomizationItemId - The unique identifier for a CustomizationItem

Returns:

atg.commerce.search.config.SearchUpdateCustomizationItem

Throws:

atg.search.adapter.exception.CustomizationItemNotFoundException

getSupportedCustomizationTypes

public java.util.Collection getSupportedCustomizationTypes()

Returns a collection of the customization types supported by this adapter.

Specified by:

getSupportedCustomizationTypes in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

getSupportedCustomizationTypes in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Returns:

List of atg.searchadmin.adapter.customization.CustomizationType

getDisplayName

public java.lang.String getDisplayName()

Returns the display name for this customization adapter.

Specified by:

getDisplayName in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

getDisplayName in class atg.search.adapter.customization.CustomizationDataAdapterImpl

getBatchXMLAsString

public java.lang.String getBatchXMLAsString(java.lang.String pId)
                                     throws SearchUpdateException

Method to enumerate through the items and create the XML as a single string.

Parameters:

pId - String int start index of the batch of indexed items to process

Returns:

String XML for all items.

Throws:

SearchUpdateException

getBatchXMLAsString

public java.lang.String getBatchXMLAsString(RepositoryIterator pRepositoryIterator)
                                     throws SearchUpdateException

Method to enumerate through the items and create the XML as a single string.

Parameters:

pRepositoryIterator - RepositoryIterator which will iterate over pre-configured batch

Returns:

String XML for items in batch.

Throws:

SearchUpdateException

enumerateItems

protected java.util.List<java.lang.String> enumerateItems(RepositoryIterator pRepositoryIterator)
                                                   throws SearchUpdateException

Throws:

SearchUpdateException

populateListForItem

protected void populateListForItem(java.lang.String pId,
                                   java.util.List pOutputProperties)

generateXMLForProperties

protected void generateXMLForProperties(java.lang.String pId,
                                        java.util.List pOutputProperties,
                                        java.io.OutputStream pOut)
                                 throws SearchUpdateException

Throws:

SearchUpdateException

getContextFilteringRules

protected ContextFilteringRules getContextFilteringRules(atg.search.index.IndexInfo pIndexInfo)

Retrieve siteIds from pIndexInfo.siteIndexInfo and use same to create ContextFilteringRules

Parameters:

pIndexInfo - IndexInfo which may carry siteIds in its siteIndexInfo

Returns:

ContextFilteringRules used to constrain repository query

getContextFilteringRulesForSites

protected ContextFilteringRules getContextFilteringRulesForSites(java.util.Collection<java.lang.String> pSites)

Creates a ContextFilteringRules from an array of site ids.

Parameters:

pSites - The array of site ids

Returns:

The ContextFilteringRules for the given site ids.

processBatches

public void processBatches(atg.repository.search.indexing.config.SearchUpdateXMLHandler pSearchUpdateXMLHandler,
                           atg.search.index.IndexInfo pIndexInfo)
                    throws java.lang.Exception

Main "driver" method that uses a RepositoryIterator to identify then iterate over batches of items. The set of items to process may be constrained by any siteIds in the pIndexInfo param. Each batch is transformed into XML which is then submitted to the search engine by the pSearchUpdateXMLHandler.

Parameters:

pSearchUpdateXMLHandler - SearchUpdateXMLHandler which handles the submission of XML to the Search Engine

pIndexInfo - IndexInfo objects which may contain siteIds

Throws:

java.lang.Exception

isAdapterFullyConfigured

protected boolean isAdapterFullyConfigured()

Checks that necessary properties and components required for the adapter to operate are all properly configured.

Returns:

createRepositoryIterator

protected RepositoryIterator createRepositoryIterator(boolean pAutoFetchNextBatch,
                                                      int pStartIndex,
                                                      boolean pPreloadBatch,
                                                      ContextFilteringRules pRules)
                                               throws atg.search.adapter.exception.CustomizationItemNotFoundException

Utility method to create a RepositoryIterator

Parameters:

pAutoFetchNextBatch -

pRules -

pPreloadBatch -

Returns:

Throws:

atg.search.adapter.exception.CustomizationItemNotFoundException