Skip navigation links

com.sigmadynamics.sdo.support
Class SDChoiceEventModel

java.lang.Object
com.sigmadynamics.sdo.support.SDOBase
com.sigmadynamics.sdo.base.SDO
com.sigmadynamics.sdo.support.SDModel
com.sigmadynamics.sdo.base.Model
com.sigmadynamics.sdo.support.SDChoiceEventModel

All Implemented Interfaces:

ChoiceEventModelInterface, SDOInterface, ModelInterface, InputProvider

Direct Known Subclasses:

ChoiceEventModel

public abstract class SDChoiceEventModel

extends Model

implements ChoiceEventModelInterface

Field Summary

Fields inherited from class com.sigmadynamics.sdo.support.SDOBase

description, internalName, sdExternalName

Constructor Summary

SDChoiceEventModel()

Method Summary

abstract double	getChoiceEventLikelihood(java.lang.String choiceId, java.lang.String eventName)
abstract int	getChoiceEventModelCount(ModelCount modelCount, java.lang.String choiceId, java.lang.String eventName)
abstract float	getChoiceEventModelError(ModelError modelError, java.lang.String choiceId, java.lang.String eventName)
abstract float	getChoiceEventModelLift(ModelLift modelLift, java.lang.String choiceId, java.lang.String eventName)
abstract float	getChoiceEventModelQuality(java.lang.String choiceId, java.lang.String eventName)
abstract void	recordEvent(SDChoice choice, java.lang.String eventName) Deprecated.
abstract void	recordEvent(java.lang.String choiceId, java.lang.String eventName)

Methods inherited from class com.sigmadynamics.sdo.support.SDModel

getAllAnalysisAttributeIds, getDataStorageDaysToKeep, getDataStorageKeyIds, getDataStoragePartitioningKeyIds, getTargetAttributeId

Methods inherited from class com.sigmadynamics.sdo.support.SDOBase

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId, setDescription, setSDOId, setSDOLabel

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sigmadynamics.sdo.interfaces.ModelInterface

resetModelData, shouldRandomizePredictions

Methods inherited from interface com.sigmadynamics.server.rtis.PredictionEngine.InputProvider

provideInput

Methods inherited from interface com.sigmadynamics.sdo.interfaces.client.SDOInterface

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId

Constructor Detail

SDChoiceEventModel

public SDChoiceEventModel()

Method Detail

recordEvent

@Deprecated
public abstract void recordEvent(SDChoice choice,
                                            java.lang.String eventName)

Deprecated.

recordEvent

public abstract void recordEvent(java.lang.String choiceId,
                                 java.lang.String eventName)

Specified by:

recordEvent in interface ChoiceEventModelInterface

Parameters:

choiceId - sdo id of choice

eventName - event name

getChoiceEventLikelihood

public abstract double getChoiceEventLikelihood(java.lang.String choiceId,
                                                java.lang.String eventName)

Specified by:

getChoiceEventLikelihood in interface ChoiceEventModelInterface

Parameters:

choiceId - sdo id of choice

eventName - event name

Returns:

likelihood of a choice event, a real number between 0 and 1 inclusive

getChoiceEventModelQuality

public abstract float getChoiceEventModelQuality(java.lang.String choiceId,
                                                 java.lang.String eventName)

Specified by:

getChoiceEventModelQuality in interface ChoiceEventModelInterface

Parameters:

choiceId - sdo id of choice

eventName - event name

Returns:

quality of a choice event model, a real number between 0 and 1 inclusive

getChoiceEventModelCount

public abstract int getChoiceEventModelCount(ModelCount modelCount,
                                             java.lang.String choiceId,
                                             java.lang.String eventName)

Specified by:

getChoiceEventModelCount in interface ChoiceEventModelInterface

Parameters:

modelCount - a value of enum type ModelCount, specifying the count type

choiceId - sdo id of choice

eventName - event name

Returns:

counts in a choice event model, a non-negative integer

See Also:

ModelCount

getChoiceEventModelLift

public abstract float getChoiceEventModelLift(ModelLift modelLift,
                                              java.lang.String choiceId,
                                              java.lang.String eventName)

Specified by:

getChoiceEventModelLift in interface ChoiceEventModelInterface

Parameters:

modelLift - a value of enum type ModelLift, specifying the lift type

choiceId - sdo id of choice

eventName - event name

Returns:

lift of a choice event model, a real number of type float

See Also:

ModelLift

getChoiceEventModelError

public abstract float getChoiceEventModelError(ModelError modelError,
                                               java.lang.String choiceId,
                                               java.lang.String eventName)

Specified by:

getChoiceEventModelError in interface ChoiceEventModelInterface

Parameters:

modelError - a value of enum type ModelError, specifying the error type

choiceId - sdo id of choice

eventName - event name

Returns:

error of a choice event model, a real number of type float

See Also:

ModelError

Skip navigation links