atg.commerce.search.producer
Class CustomCatalogPropertyAccessor

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.repository.search.indexing.PropertyAccessorImpl
              extended by atg.commerce.search.producer.CustomCatalogPropertyAccessor
All Implemented Interfaces:
IndexConstants, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, atg.repository.search.indexing.PropertyAccessor, atg.repository.search.indexing.SchemedPropertyAccessor, java.util.EventListener

public class CustomCatalogPropertyAccessor
extends atg.repository.search.indexing.PropertyAccessorImpl
implements IndexConstants

A PropertyAccessor that understands how to fetch the catalog specific properties of commerce catalogs that are stored in info objects such as category-info, product-info, and sku-info.

See Also:
atg.repository.search.index.PropertyAccessor

Field Summary
static java.lang.String CLASS_VERSION
           
protected  CatalogProperties mCatalogProperties
           
 
Fields inherited from class atg.nucleus.GenericService
SERVICE_INFO_KEY
 
Fields inherited from interface atg.commerce.search.IndexConstants
CATALOG_ATTR, CATALOGS_ITER_ATTR
 
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
CustomCatalogPropertyAccessor()
           
 
Method Summary
 CatalogProperties getCatalogProperties()
          Gets the CatalogProperties object that holds meta-data about the names of item-descriptors and property-descriptors used in custom catalogs.
 java.lang.Object getSubItemPropertyValue(Context pContext, RepositoryItem pItem, java.lang.String pPropName)
          Return the value for a sub-item.
protected  boolean isInfoProperty(RepositoryItem pItem, java.lang.String pPropName, java.lang.String pBaseItemTypeName, java.lang.String pInfoPropertyName)
          Returns true if the property is an info property of the given item type.
 void setCatalogProperties(CatalogProperties pCatalogProperties)
          Sets the CatalogProperties object that holds meta-data about the names of item-descriptors and property-descriptors used in custom catalogs.
 
Methods inherited from class atg.repository.search.indexing.PropertyAccessorImpl
getMetaPropertyValue, getMetaScheme, getMetaSecurityConstraint, getSiteContextPropertyValue, getTextOrMetaPropertyValue, getTextPropertyValue, getTextSecurityConstraint, onIndexingInitialization, onIndexingTermination, resolveDollarProperty
 
Methods inherited from class atg.nucleus.GenericService
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
 
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
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

mCatalogProperties

protected CatalogProperties mCatalogProperties
Constructor Detail

CustomCatalogPropertyAccessor

public CustomCatalogPropertyAccessor()
Method Detail

getCatalogProperties

public CatalogProperties getCatalogProperties()
Gets the CatalogProperties object that holds meta-data about the names of item-descriptors and property-descriptors used in custom catalogs.


setCatalogProperties

public void setCatalogProperties(CatalogProperties pCatalogProperties)
Sets the CatalogProperties object that holds meta-data about the names of item-descriptors and property-descriptors used in custom catalogs.


getSubItemPropertyValue

public java.lang.Object getSubItemPropertyValue(Context pContext,
                                                RepositoryItem pItem,
                                                java.lang.String pPropName)
Return the value for a sub-item. If the property is an info property that describes catalog specific values, only return the info that is appropriate for the current variant. Examples of info properties are; the categoryInfos property of the category item-descriptor, the productInfos property of the product item-descriptor, the skuInfos property of the sku item-descriptor.

Specified by:
getSubItemPropertyValue in interface atg.repository.search.indexing.PropertyAccessor
Overrides:
getSubItemPropertyValue in class atg.repository.search.indexing.PropertyAccessorImpl

isInfoProperty

protected boolean isInfoProperty(RepositoryItem pItem,
                                 java.lang.String pPropName,
                                 java.lang.String pBaseItemTypeName,
                                 java.lang.String pInfoPropertyName)
Returns true if the property is an info property of the given item type.