atg.adc.pipeline
Class ADCPipelineArgs

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap
          atg.adc.pipeline.ADCPipelineArgs

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map

public class ADCPipelineArgs
extends java.util.HashMap

This is the class that is passed as the parameter to all of the ADC pipeline chains. It extends HashMap to enable custom properties to be passed into the chain, but these are not used by default.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ADCPipelineArgs()
Create a new empty ADCPipelineArgs

ADCPipelineArgs(ADCRequestData pRequestData, PipelinedDataReporter pDataReporter)
Create a new ADCPipelineArgs

ADCPipelineArgs(ADCRequestData pRequestData, PipelinedDataReporter pDataReporter, int pInitialCapacity)
Creates a new ADCPipelineArgs with the given HashMap characteristics

ADCPipelineArgs(ADCRequestData pRequestData, PipelinedDataReporter pDataReporter, int pInitialCapacity, float pLoadFactor)
Creates a new ADCPipelineArgs with the given HashMap characteristics

ADCPipelineArgs(ADCRequestData pRequestData, PipelinedDataReporter pDataReporter, java.util.Map pMap)
Create a new ADCPipelineArgs with the given properties

Method Summary

protected ADCData	createNewADCData() This will create a new empty ADCData object
java.lang.String	getADCClientName()
PipelinedDataReporter	getADCDataReporter()
java.lang.String	getADCDataString() This will return all of the created ADCData objects as a concatenated String.
ADCRequestData	getADCRequestData()
ADCSessionData	getADCSessionData()
ADCData	getCurrentADCData() The data created as a result of this request that is added to the user's response
void	setADCClientName(java.lang.String pADCClientName) The name of the ADC client associated with this pipeline chain
void	setADCDataReporter(PipelinedDataReporter pADCDataReporter) The data reported that executed the pipeline
void	setADCRequestData(ADCRequestData pADCRequestData) The request data that should be used during the given pipeline execution
void	setADCSessionData(ADCSessionData pADCSessionData) The ADCSessionData component which contains information about products viewed in the session
ADCData	startNewADCData() This should be called before the beginning of the pipeline, or whenever multiple data objects are needed.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ADCPipelineArgs

public ADCPipelineArgs(ADCRequestData pRequestData,
                       PipelinedDataReporter pDataReporter,
                       int pInitialCapacity,
                       float pLoadFactor)

Creates a new ADCPipelineArgs with the given HashMap characteristics

Parameters:

pRequestData - The request scoped collection of data being processed

pDataReporter - The data reporter that executed the pipeline

pInitialCapacity - The initial capacity

pLoadFactor - The load factor

ADCPipelineArgs

public ADCPipelineArgs(ADCRequestData pRequestData,
                       PipelinedDataReporter pDataReporter,
                       int pInitialCapacity)

Creates a new ADCPipelineArgs with the given HashMap characteristics

Parameters:

pRequestData - The request scoped collection of data being processed

pDataReporter - The data reporter that executed the pipeline

pInitialCapacity - The initial capacity

ADCPipelineArgs

public ADCPipelineArgs(ADCRequestData pRequestData,
                       PipelinedDataReporter pDataReporter)

Create a new ADCPipelineArgs

Parameters:

pRequestData - The request scoped collection of data being processed

pDataReporter - The data reporter that executed the pipeline

ADCPipelineArgs

public ADCPipelineArgs(ADCRequestData pRequestData,
                       PipelinedDataReporter pDataReporter,
                       java.util.Map pMap)

Create a new ADCPipelineArgs with the given properties

Parameters:

pRequestData - The request scoped collection of data being processed

pDataReporter - The data reporter that executed the pipeline

pMap -

ADCPipelineArgs

public ADCPipelineArgs()

Create a new empty ADCPipelineArgs

Method Detail

setADCClientName

public void setADCClientName(java.lang.String pADCClientName)

The name of the ADC client associated with this pipeline chain

Parameters:

pADCClientName - The name of the ADC client

getADCClientName

public java.lang.String getADCClientName()

Returns:

The name of the ADC client associated with this pipeline chain

setADCRequestData

public void setADCRequestData(ADCRequestData pADCRequestData)

The request data that should be used during the given pipeline execution

Parameters:

pADCRequestData - the request data that should be used during the given pipeline execution

getADCRequestData

public ADCRequestData getADCRequestData()

Returns:

The request data that should be used during the given pipeline execution

setADCDataReporter

public void setADCDataReporter(PipelinedDataReporter pADCDataReporter)

The data reported that executed the pipeline

Parameters:

pADCDataReporter - The data reported that executed the pipeline

getADCDataReporter

public PipelinedDataReporter getADCDataReporter()

Returns:

The data reported that executed the pipeline

getCurrentADCData

public ADCData getCurrentADCData()

The data created as a result of this request that is added to the user's response

setADCSessionData

public void setADCSessionData(ADCSessionData pADCSessionData)

The ADCSessionData component which contains information about products viewed in the session

Parameters:

pADCSessionData - the ADCSessionData component which contains \ information about products viewed in the session

getADCSessionData

public ADCSessionData getADCSessionData()

Returns:

the ADCSessionData component which contains information about products viewed in the session

startNewADCData

public ADCData startNewADCData()

This should be called before the beginning of the pipeline, or whenever multiple data objects are needed. It will save the current ADCData object (if it exists) and create a new "current" ADCData object

Returns:

The newly created ADCData

getADCDataString

public java.lang.String getADCDataString()

This will return all of the created ADCData objects as a concatenated String. This is what should be called when the pipelines are finished, to get the result

Returns:

Each ADCData as a string

createNewADCData

protected ADCData createNewADCData()

This will create a new empty ADCData object

Returns:

The newly created ADCData object