atg.projects.store.recommendations.processor
Class SearchResultsProcessor

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.adc.pipeline.ADCPipelineProcessor
              atg.adc.pipeline.ADCEventPipelineProcessor
                  atg.projects.store.recommendations.processor.TrackingCodeProcessor
                      atg.projects.store.recommendations.processor.SearchResultsProcessor

All Implemented Interfaces:

atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, atg.service.pipeline.PipelineProcessor, java.util.EventListener

public class SearchResultsProcessor
extends TrackingCodeProcessor

This processor is responsible for generating clickstream tracking code markup for search results pages. It extends TrackingCodeProcessor and overrides its buildTrackingCodeViewContent() method in order to add 'searchText' entry to the 'view' configuration parameter. The search keyword associated with the current request should be stored into ADCRequestData object in ADC pipeline arguments by preceding SetSearchTermProcessor.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/Recommendations/src/atg/projects/store/recommendations/processor/SearchResultsProcessor.java#2 $Change: 630322 $

Author:

Yekaterina Kostenevich

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	SEARCH_TEXT_ENTRY Entries format constants

Fields inherited from class atg.projects.store.recommendations.processor.TrackingCodeProcessor

CART_ENTRY, CUSTOMER_ID_ENTRY, DEFAULT_TIMEOUT, DISABLED_FAILOVER, EXCLUDE_DEFAULT_STORE_ENTRY, FAILOVER_CONTENT, FAILOVER_ENTRY, FAILOVER_SKIP_RECOMMENDATIONS, FAILOVER_TIMEOUT_ENTRY, INCLUDE_PRICE_ENTRY, LOCALE_ENTRY, PERFORM_MONITOR_NAME, PERFORM_OPERATION_NAME, PRODUCT_ENTRY, RETAILER_ID_ENTRY, STORE_ID_ENTRY, TRACKING_DIV, VIEW_ENTRY

Fields inherited from class atg.adc.pipeline.ADCEventPipelineProcessor

sResourceBundle

Fields inherited from class atg.adc.pipeline.ADCPipelineProcessor

MADE_CHANGE, NO_CHANGE

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

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

SearchResultsProcessor()

Method Summary

protected java.lang.String	buildSearchTextEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds 'searchText' entry for the recommendations clickstream tracking code.
protected java.lang.String	buildTrackingCodeViewContent(atg.adc.pipeline.ADCPipelineArgs pArgs) Overrides base TrackingCodeProcessor's method in order to append 'searchText' entry to the 'view' configuration parameter content.
protected boolean	validateRequiredData(atg.adc.pipeline.ADCPipelineArgs pArgs) Overrides base TrackingCodeProcessor's method in order to check whether search keyword is specified in ADCRequestData object stored in the ADC pipeline arguments.

Methods inherited from class atg.projects.store.recommendations.processor.TrackingCodeProcessor

appendEntry, buildCartEntry, buildCustomerIdEntry, buildExcludeDefaultStoreEntry, buildFailoverEntry, buildIncludePriceEntry, buildLocaleEntry, buildRetailerIdEntry, buildStoreIdEntry, buildTrackingCode, buildTrackingCodeContent, buildTrackingCodeViewEntry, getCurrentOrder, getFailoverTimeout, getPriceListManager, getRetailerId, getShoppingCartPath, isEnableFailover, isExcludeDefaultStore, isIncludeCartContent, isIncludeLocale, isIncludePrice, isSkipRecommendations, isUseContentFailover, processADCData, processEvent, setEnableFailover, setExcludeDefaultStore, setFailoverTimeout, setIncludeLocale, setIncludePrice, setPriceListManager, setRetailerId, setShoppingCartPath, setSkipRecommendations, setUseContentFailover, updateADCData

Methods inherited from class atg.adc.pipeline.ADCEventPipelineProcessor

getJMSTypes, getObjectFromMessage, processEvents, setJMSTypes

Methods inherited from class atg.adc.pipeline.ADCPipelineProcessor

getRetCodes, isEnabled, runProcess, setEnabled

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

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

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

SEARCH_TEXT_ENTRY

public static final java.lang.String SEARCH_TEXT_ENTRY

Entries format constants

See Also:

Constant Field Values

Constructor Detail

SearchResultsProcessor

public SearchResultsProcessor()

Method Detail

validateRequiredData

protected boolean validateRequiredData(atg.adc.pipeline.ADCPipelineArgs pArgs)

Overrides base TrackingCodeProcessor's method in order to check whether search keyword is specified in ADCRequestData object stored in the ADC pipeline arguments. If not the further processing will be stopped.

Overrides:

validateRequiredData in class TrackingCodeProcessor

Parameters:

pArgs - The pipeline arguments

Returns:

true - if category repository item is specified in ADCRequestData object stored in the ADC pipeline arguments. Otherwise false.

buildTrackingCodeViewContent

protected java.lang.String buildTrackingCodeViewContent(atg.adc.pipeline.ADCPipelineArgs pArgs)

Overrides base TrackingCodeProcessor's method in order to append 'searchText' entry to the 'view' configuration parameter content.

Overrides:

buildTrackingCodeViewContent in class TrackingCodeProcessor

Parameters:

pArgs - ADC pipeline arguments

Returns:

'view' entry content for the recommendations clickstream tracking code

buildSearchTextEntry

protected java.lang.String buildSearchTextEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds 'searchText' entry for the recommendations clickstream tracking code. The search keyword is taken from the corresponding parameter stored in the ADCRequestData by the preceding SetProductProcessor pipeline processor.

Parameters:

pArgs - ADC pipeline arguments

Returns:

searchText entry