com.ibm.commerce.experimentation.commands

Class ExperimentBaseEvaluateCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.experimentation.commands.ExperimentBaseEvaluateCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, ExperimentBaseEvaluateCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class ExperimentBaseEvaluateCmdImpl
extends TaskCommandImpl
implements ExperimentBaseEvaluateCmd

This class implements the ExperimentBaseEvaluateCmd interface to provide the task command that contains common methods used in evaluation of experiments. This command is extended by a custom implementation for each type of store element, which is the object used to display content in the store front. An e-Marketing Spot is an example of a store element in which marketing content is delivered to customers.

Functionalities provided by common methods implemented in this command include database operations on the EXPRESULT table, and result generation for experiments given their business rule definitions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static int	DEFAULT_FREQUENCY_SIZE Default size of display frequency in an experiment.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.experimentation.commands.ExperimentBaseEvaluateCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ExperimentBaseEvaluateCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Short	generateExperimentResult(ExperimentRuleDefinition ruleDefinition) This method returns the ID of a control or test element in the given rule definition object based on the comparison result between the element's display frequency and the randomly generated number.
java.lang.Short	getExperimentResultFromDB(java.lang.Integer experimentId, java.lang.Long userId, java.lang.String sessionId, boolean isUserFallBack) This method returns the ID of the control or test element to be returned as the result of the experiment evaluation from the database, based on the given experiment, and user or session, depending on the fallback flag.
java.lang.Short	getExperimentResultFromDB(java.lang.Integer experimentId, java.lang.String sessionId) This method returns the ID of the control or test element to be returned as the result of the experiment evaluation from the database, based on the given experiment and session ID.
void	insertExperimentResultToDB(java.lang.Integer experimentId, java.lang.Long userId, java.lang.String sessionId, java.lang.Short resultNumber) This method inserts a new record to the EXPRESULT table in the database which holds the experiment result uniquely identified by the experiment, session and user.
void	performExecute() This method evaluates all of the currently active experiments that are scheduled to the given store element during the given time, and gathers all of the experiment results which can be accessed through parameters, by invoking the getPostInvokeParameters method in this command.

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

DEFAULT_FREQUENCY_SIZE

public static final int DEFAULT_FREQUENCY_SIZE

Default size of display frequency in an experiment.

See Also:

Constant Field Values

Constructor Detail

ExperimentBaseEvaluateCmdImpl

public ExperimentBaseEvaluateCmdImpl()

Method Detail

generateExperimentResult

public java.lang.Short generateExperimentResult(ExperimentRuleDefinition ruleDefinition)

This method returns the ID of a control or test element in the given rule definition object based on the comparison result between the element's display frequency and the randomly generated number.

Specified by:

generateExperimentResult in interface ExperimentBaseEvaluateCmd

Parameters:

ruleDefinition - An instance of com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition object which contains the definition of experiment rule.

Returns:

The ID of the selected control or test element.

getExperimentResultFromDB

public java.lang.Short getExperimentResultFromDB(java.lang.Integer experimentId,
                                                 java.lang.String sessionId)

This method returns the ID of the control or test element to be returned as the result of the experiment evaluation from the database, based on the given experiment and session ID.

Specified by:

getExperimentResultFromDB in interface ExperimentBaseEvaluateCmd

Parameters:

experimentId - The ID of the experiment.

sessionId - The ID of the current session.

Returns:

The ID of the control or test element to be returned as the result of the experiment evaluation.

getExperimentResultFromDB

public java.lang.Short getExperimentResultFromDB(java.lang.Integer experimentId,
                                                 java.lang.Long userId,
                                                 java.lang.String sessionId,
                                                 boolean isUserFallBack)

This method returns the ID of the control or test element to be returned as the result of the experiment evaluation from the database, based on the given experiment, and user or session, depending on the fallback flag.

Specified by:

getExperimentResultFromDB in interface ExperimentBaseEvaluateCmd

Parameters:

experimentId - The ID of the experiment.

userId - The ID of the user.

sessionId - The ID of the current session.

isUserFallBack - True if the result will be found based on the session and use the user as fallback; false otherwise.

Returns:

The ID of the control or test element to be returned as the result of the experiment evaluation.

insertExperimentResultToDB

public void insertExperimentResultToDB(java.lang.Integer experimentId,
                                       java.lang.Long userId,
                                       java.lang.String sessionId,
                                       java.lang.Short resultNumber)

This method inserts a new record to the EXPRESULT table in the database which holds the experiment result uniquely identified by the experiment, session and user.

Specified by:

insertExperimentResultToDB in interface ExperimentBaseEvaluateCmd

Parameters:

experimentId - The ID of the experiment.

userId - The ID of the user.

sessionId - The ID of the current session.

resultNumber - The ID of the selected control or test element.

performExecute

public void performExecute()
                    throws ECException

This method evaluates all of the currently active experiments that are scheduled to the given store element during the given time, and gathers all of the experiment results which can be accessed through parameters, by invoking the getPostInvokeParameters method in this command. By default, this method does not contain any logic, and command implementations for custom store element types should override this method to implement the logic accordingly.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - Thrown whenever an exception occurs while parsing and evaluating the experiment rules.