oracle.dmt.odm.task
Class MiningLiftTask

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.task.MiningTask
                    |
                    +--oracle.dmt.odm.task.MiningDataTask
                          |
                          +--oracle.dmt.odm.task.MiningLiftTask

All Implemented Interfaces:

java.io.Serializable

public class MiningLiftTask

extends MiningDataTask

An instance of MiningLiftTask is used to compute the lift based on the specified positive target value and the number of quantiles. It uses the specified supervised mining model and the task input data. Lift task can be performed using any supervised model supported by ODM.

MiningLiftTask's input data must have all the active attributes used to build the associated supervised model. DataUsageSpecifications of the model input data and lift input data must be same. If the task input data is not compatible with the specified input model, the lift task fails with an exception.

After constructing a valid MiningLiftTask instance, it must be persisted in the database using the store(dmsConn, taskName) method before executing. Task name must be unique in the user schema task name space.

After successful completion of the lift task, the user can retrieve the results using MiningLiftResult object. To remove the MiningLiftTask object from the database, call the static method remove(dmsConn, taskName).

Since:

ODM 9.2.0

See Also:

Serialized Form

Constructor Summary

MiningLiftTask(PhysicalDataSpecification taskInputData, int numberOfQuantiles, Category positiveTargetValue, java.lang.String inputModelName, java.lang.String liftResultName)
Creates an instance of the lift task with the specified input data, number of quantiles, positive target value, input model, and the lift result name.

Method Summary

java.lang.String	getLiftResultName() Returns the lift result name.
int	getNumberOfQuantiles() Returns the number of quantiles specified to compute lift.
Category	getPostiveTargetValue() Returns positive target value.
static MiningLiftTask	restore(Connection dmsConn, java.lang.String taskName) Restores the user-specified MiningLiftTask object from the database.

Methods inherited from class oracle.dmt.odm.task.MiningDataTask

getInputModelName, getTaskInputData

Methods inherited from class oracle.dmt.odm.task.MiningTask

execute, getActiveExecutionHandle, getCurrentStatus, getExecutionDuration, getExecutionHandle, getLatestExecutionHandle, getName, getStatusHistory, getTaskType, getType, listTasks, remove, rename, store, terminate, waitForCompletion, waitForCompletion

Methods inherited from class java.lang.Object

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

Constructor Detail

MiningLiftTask

public MiningLiftTask(PhysicalDataSpecification taskInputData,
                      int numberOfQuantiles,
Category positiveTargetValue,
                      java.lang.String inputModelName,
                      java.lang.String liftResultName)
               throws InvalidArgumentException,
ODMException

Creates an instance of the lift task with the specified input data, number of quantiles, positive target value, input model, and the lift result name.

Parameters:

taskInputData - Lift task input data physical specification.

numberOfQuantiles - Number of quantiles to be used in the computation of the lift. It must be greater than 1.

positiveTargetValue - Positive target value of the target attribute.

inputModelName - Name of the input supervised model.

liftResultName - Name of the lift result object.

Throws:

InvalidArgumentException - is thrown
- when the taskInputData/positiveTargetValue/inputModelName/liftResultName are null
- when the numberOfQuantiles is less than 1
- when the inputModelName/liftResultName length >25 bytes
- when the taskInputData does not have LocationAccessData specified

InvalidArgumentException

ODMException

Method Detail

getNumberOfQuantiles

public int getNumberOfQuantiles()

Returns the number of quantiles specified to compute lift.

Returns:

number of quantiles.

getPostiveTargetValue

public Category getPostiveTargetValue()

Returns positive target value.

Returns:

positive target value.

getLiftResultName

public java.lang.String getLiftResultName()

Returns the lift result name.

Returns:

lift result name.

restore

public static MiningLiftTask restore(Connection dmsConn,
                                     java.lang.String taskName)
                                                  throws InvalidArgumentException,
MiningTaskException,
                                                         java.sql.SQLException,
ODMException

Restores the user-specified MiningLiftTask object from the database.

Parameters:

dmsConn - Data mining server connection.

taskName - Name of the test task.

Returns:

restored mining lift task.

Throws:

InvalidArgumentException - is thrown
- when the dmsConn/taskName are null
- when the taskName length >25 bytes

MiningTaskException - is thrown
- when the restore fails

SQLException - is thrown
- when there is a failure in JDBC calls

InvalidArgumentException

MiningTaskException

java.sql.SQLException

ODMException