|
|||||||||
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.search.adapter.customization.CustomizationDataAdapterImpl atg.repository.search.indexing.config.SearchUpdateAdapter
public class SearchUpdateAdapter
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 | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
SearchUpdateAdapter()
|
Method Summary | |
---|---|
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 |
enumerateItems(java.lang.String pId)
|
protected void |
generateXMLForProperties(java.lang.String pId,
java.util.List pOutputProperties,
java.io.OutputStream pOut)
|
int |
getBatchSize()
|
java.lang.String |
getBatchXMLAsString(java.lang.String pId)
|
SearchUpdateCollector[] |
getCollectors()
|
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()
|
java.util.Collection |
getSupportedCustomizationTypes()
Returns a collection of the customization types supported by this adapter. |
javax.transaction.TransactionManager |
getTransactionManager()
|
SearchUpdateXMLGenerator |
getXMLGenerator()
|
boolean |
isAutoApplyAll()
Whether to auto-apply all customization items. |
protected void |
populateListForItem(java.lang.String pId,
java.util.List pOutputProperties)
|
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 |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
|
void |
setXMLGenerator(SearchUpdateXMLGenerator pXMLGenerator)
|
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 |
Methods inherited from interface atg.naming.NameContextElement |
---|
getName, getNameContext |
Methods inherited from interface atg.naming.NameContextBindingListener |
---|
nameContextElementBound, nameContextElementUnbound |
Field Detail |
---|
public static final java.lang.String CLASS_VERSION
Constructor Detail |
---|
public SearchUpdateAdapter()
Method Detail |
---|
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
public javax.transaction.TransactionManager getTransactionManager()
public Repository getIndexedRepository()
public void setIndexedRepository(Repository pIndexedRepository)
public SearchUpdateXMLGenerator getXMLGenerator()
public void setXMLGenerator(SearchUpdateXMLGenerator pXMLGenerator)
public void setBatchSize(int pBatchSize)
public int getBatchSize()
public void setIndexedItemDescriptorName(java.lang.String pIndexedItemDescriptorName)
public java.lang.String getIndexedItemDescriptorName()
public RepositoryItemDescriptor getIndexedItemDescriptor()
public void setIndexedIdPropertyName(java.lang.String pIndexedIdPropertyName)
public java.lang.String getIndexedIdPropertyName()
public void setCollectors(SearchUpdateCollector[] pCollectors)
public SearchUpdateCollector[] getCollectors()
public void setDisplayName(java.lang.String pDisplayName)
public void setIndexedItemsGroup(RepositoryItemGroup pIndexedItemsGroup)
public RepositoryItemGroup getIndexedItemsGroup()
public boolean isAutoApplyAll()
isAutoApplyAll
in interface atg.search.adapter.customization.CustomizationDataAdapter
isAutoApplyAll
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public java.util.List enumerateCustomizationItemsByType(atg.search.adapter.customization.CustomizationType pCustomizationType)
#getCustomizationItem()
to retrieve the actual customization item.
enumerateCustomizationItemsByType
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateCustomizationItemsByType
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public java.util.List enumerateCustomizationItems()
#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.
enumerateCustomizationItems
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateCustomizationItems
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public java.util.List enumerateAutoApplyCustomizationItemsByTypeAndProject(atg.search.adapter.customization.CustomizationType pCustomizationType, java.lang.String pProjectId) throws atg.search.adapter.exception.CustomizationItemNotFoundException
#getCustomizationItem()
to retrieve the actual customization item.
enumerateAutoApplyCustomizationItemsByTypeAndProject
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateAutoApplyCustomizationItemsByTypeAndProject
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
atg.search.adapter.exception.CustomizationItemNotFoundException
public atg.search.adapter.customization.CustomizationItem getCustomizationItem(atg.search.adapter.customization.CustomizationType pCustomizationType, java.lang.String pCustomizationItemId) throws atg.search.adapter.exception.CustomizationItemNotFoundException
getCustomizationItem
in interface atg.search.adapter.customization.CustomizationDataAdapter
getCustomizationItem
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
pCustomizationItemId
- The unique identifier for a CustomizationItem
atg.commerce.search.config.SearchUpdateCustomizationItem
atg.search.adapter.exception.CustomizationItemNotFoundException
public java.util.Collection getSupportedCustomizationTypes()
getSupportedCustomizationTypes
in interface atg.search.adapter.customization.CustomizationDataAdapter
getSupportedCustomizationTypes
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
atg.searchadmin.adapter.customization.CustomizationType
public java.lang.String getDisplayName()
getDisplayName
in interface atg.search.adapter.customization.CustomizationDataAdapter
getDisplayName
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public java.lang.String getBatchXMLAsString(java.lang.String pId) throws SearchUpdateException
SearchUpdateException
protected java.util.List enumerateItems(java.lang.String pId) throws SearchUpdateException
SearchUpdateException
protected void populateListForItem(java.lang.String pId, java.util.List pOutputProperties) throws SearchUpdateException
SearchUpdateException
protected void generateXMLForProperties(java.lang.String pId, java.util.List pOutputProperties, java.io.OutputStream pOut) throws SearchUpdateException
SearchUpdateException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |