com.ibm.commerce.context.experimentimpl

Class ExperimentContextImpl

java.lang.Object

com.ibm.commerce.context.baseimpl.AbstractContextImpl

com.ibm.commerce.context.experimentimpl.ExperimentContextImpl

All Implemented Interfaces:

Context, ContextSPI, ExperimentContext, java.io.Serializable

public class ExperimentContextImpl
extends AbstractContextImpl
implements ExperimentContext

This class implements the ExperimentContext interface to provide the implementation details of the context object that is used in Experimentation. This context contains user and store dependent experiment result information, which is a randomly generated number used to determine the experimental element that will be converted to the control activity.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT_NAME This is the name of the context.
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from class com.ibm.commerce.context.baseimpl.AbstractContextImpl

SER_VALUE_SEP

Constructor Summary

Constructors

Constructor and Description
ExperimentContextImpl() The default constructor for this class, a new java.util.HashMap object is created to store user-specific experiment results.

Method Summary

Modifier and Type	Method and Description
void	clearContext() This method clears the experiment context, it is called when the ContextSPI object is returned to their respective object pool.
void	copyContext(Context ctx) This method copies the content of the specified context to this context.
java.lang.Object[]	getContextAttributes() This method returns an array of context attributes to be serialized and persisted.
java.lang.String	getContextName() This method returns the name of this context.
java.lang.Short	getExperimentResult(java.lang.Integer experimentId) This method returns the result of the given experiment for the user who owns this context.
java.lang.String	getSessionId() This method returns the current session ID for the user who is accessing this context.
void	initializeContext(com.ibm.commerce.component.contextservice.ActivityData initData) This initializes the context when the session is created.
void	preInvokeContext(com.ibm.commerce.component.contextservice.ActivityData sessionData) Any pre-processing that is done before the request processed.
void	setContextAttributes(java.lang.String[] ctxAttrs) This method initializes the context from the specified list of attributes.
void	setExperimentResult(java.lang.Integer experimentId, java.lang.Short newExperimentResult) This method sets the result of the given experiment for the user who owns this context.
void	setSessionId(java.lang.String newSessionId) This method sets the current session ID for the user who is accessing this context.
java.lang.String	toString() This method returns the string representation of the object.
boolean	validate() This method returns whether the context is valid.

Methods inherited from class com.ibm.commerce.context.baseimpl.AbstractContextImpl

clear, getActivityToken, getContextSerializedString, initialize, initialize, initializeContext, isDirty, postInvoke, postInvokeContext, preInvoke, recalibrate, recalibrateContext, reset, resetContext, setContextSerializedString, setDirty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.commerce.context.base.Context

getActivityToken

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

CONTEXT_NAME

public static final java.lang.String CONTEXT_NAME

This is the name of the context.

See Also:

Constant Field Values

Constructor Detail

ExperimentContextImpl

public ExperimentContextImpl()

The default constructor for this class, a new java.util.HashMap object is created to store user-specific experiment results.

Method Detail

clearContext

public void clearContext()

This method clears the experiment context, it is called when the ContextSPI object is returned to their respective object pool. The purpose of this object is to reset the instance variables to its uninitialized values.

Specified by:

clearContext in class AbstractContextImpl

See Also:

AbstractContextImpl.clear()

copyContext

public void copyContext(Context ctx)

This method copies the content of the specified context to this context.

Specified by:

copyContext in interface Context

Parameters:

ctx - The context to be copied from.

getContextAttributes

public java.lang.Object[] getContextAttributes()
                                        throws BusinessContextException

This method returns an array of context attributes to be serialized and persisted.

Specified by:

getContextAttributes in class AbstractContextImpl

Returns:

Returns an array of context attributes to be serialized.

Throws:

BusinessContextException

See Also:

AbstractContextImpl.getContextSerializedString()

getContextName

public java.lang.String getContextName()

This method returns the name of this context.

Specified by:

getContextName in interface Context

Returns:

The name of this context.

getExperimentResult

public java.lang.Short getExperimentResult(java.lang.Integer experimentId)

This method returns the result of the given experiment for the user who owns this context. Experiment result is a randomly generated number used to determine the experimental element that will be converted to the control activity.

Specified by:

getExperimentResult in interface ExperimentContext

Parameters:

experimentId - The ID of the experiment.

Returns:

The result of the given experiment.

getSessionId

public java.lang.String getSessionId()

This method returns the current session ID for the user who is accessing this context.

Specified by:

getSessionId in interface ExperimentContext

Returns:

The current session ID used specifically in marketing experimentation.

initializeContext

public void initializeContext(com.ibm.commerce.component.contextservice.ActivityData initData)
                       throws BusinessContextException

This initializes the context when the session is created.

Overrides:

initializeContext in class AbstractContextImpl

Parameters:

initData - The initialization data.

Throws:

BusinessContextException

See Also:

com.ibm.commerce.context.baseimpl.AbstractContextImpl#initialize(com.ibm.commerce.component.contextservice.ActivityData)

preInvokeContext

public void preInvokeContext(com.ibm.commerce.component.contextservice.ActivityData sessionData)
                      throws BusinessContextException

Any pre-processing that is done before the request processed. The pre-processing stores the information of the session data.

Specified by:

preInvokeContext in class AbstractContextImpl

Parameters:

sessionData - The data associated with the request processed.

Throws:

BusinessContextException

See Also:

AbstractContextImpl.preInvoke(com.ibm.commerce.component.contextservice.ActivityData)

setContextAttributes

public void setContextAttributes(java.lang.String[] ctxAttrs)
                          throws BusinessContextException

This method initializes the context from the specified list of attributes.

Specified by:

setContextAttributes in class AbstractContextImpl

Parameters:

ctxAttrs - An array of attributes of the context.

Throws:

BusinessContextException

setExperimentResult

public void setExperimentResult(java.lang.Integer experimentId,
                                java.lang.Short newExperimentResult)

This method sets the result of the given experiment for the user who owns this context. Experiment result is a randomly generated number used to determine the experimental element that will be converted to the control activity.

Specified by:

setExperimentResult in interface ExperimentContext

Parameters:

experimentId - The ID of the experiment.

newExperimentResult - The result of the given experiment.

setSessionId

public void setSessionId(java.lang.String newSessionId)

This method sets the current session ID for the user who is accessing this context.

Specified by:

setSessionId in interface ExperimentContext

Parameters:

newSessionId - The current session ID used specifically in marketing experimentation.

toString

public java.lang.String toString()

This method returns the string representation of the object.

Overrides:

toString in class AbstractContextImpl

Returns:

The string representation of the object.

validate

public boolean validate()
                 throws BusinessContextException

This method returns whether the context is valid.

Specified by:

validate in interface Context

Returns:

Always will return true.

Throws:

BusinessContextException - if any one of the attributes is not valid

See Also:

Context.validate()