oracle.dmt.odm.result
Class MiningLiftResult

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.result.MiningResult
                    |
                    +--oracle.dmt.odm.result.MiningLiftResult
All Implemented Interfaces:
java.io.Serializable

public class MiningLiftResult
extends MiningResult

An instance of MiningLiftResult contains the result of a lift computation for a classification model. It contains lift elements, each of which represents the lift result for specific quantile of data.

Since:
ODM 9.0.1
See Also:
Serialized Form

Method Summary
TypeMethod
 LiftResultElement[] getLiftResultElements()
          Returns an array of lift result elements of mining lift result.
 java.lang.String getTableName()
          Returns the name of the lift table.
static java.lang.String[] listContents(Connection dmsConn)
          Lists the names of the MiningLiftResult objects stored in the DMS.
static java.lang.String[] listContents(Connection dmsConn, java.util.Date startTime, java.util.Date endTime)
          Lists the names of the MiningLiftResult objects stored in the DMS created between the specified start and end times.
static java.lang.String[] listContents(Connection dmsConn, java.util.Date startTime, java.util.Date endTime, java.lang.String modelName)
          Lists the names of the MiningLiftResult objects stored in the DMS derived from the speicfied model, and created between the specified start and end times.
static void remove(Connection dmsConn, java.lang.String resultName)
          Removes the lift result object with the specified resultName from the DMS.
static MiningLiftResult restore(Connection dmsConn, java.lang.String resultName)
          Restores the MiningLiftResult object with the specified resultName from the DMS.
 java.lang.String toString()
          Returns a formatted string representation of the lift result.
 
Methods inherited from class oracle.dmt.odm.result.MiningResult
getCompletionTimestamp, getDurationTime, getExecutionDuration, getInputMiningData, getMiningModel, getName, getStartingTimestamp
 
Methods inherited from class oracle.dmt.odm.LocatableObject
deserialize, serialize
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getLiftResultElements

public LiftResultElement[] getLiftResultElements()
Returns an array of lift result elements of mining lift result.
Returns:
LiftResultElement[] - An array of lift result elements

getTableName

public java.lang.String getTableName()
Returns the name of the lift table.

remove

public static void remove(Connection dmsConn,
                          java.lang.String resultName)
                   throws InvalidArgumentException,
                          MiningObjectException,
                          java.sql.SQLException,
                          ODMException
Removes the lift result object with the specified resultName from the DMS.
Throws:
InvalidArgumentException - when dmsConn or resultName is null.
ODMException - when resultname is empty or exceeds 64 characters in length.
MiningObjectException - when there is no lift result object with the specified name in the DMS.
java.sql.SQLException - when there is a failure in JDBC calls.

restore

public static MiningLiftResult restore(Connection dmsConn,
                                       java.lang.String resultName)
                                throws InvalidArgumentException,
                                       java.sql.SQLException,
                                       ODMException
Restores the MiningLiftResult object with the specified resultName from the DMS.
Throws:
InvalidArgumentException - when dmsConn or resultName is null.
ODMException - when resultName is empty or exceeds 64 characters in length.
java.sql.SQLException - when there is a failure in JDBC calls.

listContents

public static java.lang.String[] listContents(Connection dmsConn)
Lists the names of the MiningLiftResult objects stored in the DMS.
Parameters:
dmsConn - A connection to the DMS
Returns:
String[] - An array of lift result names

listContents

public static java.lang.String[] listContents(Connection dmsConn,
                                              java.util.Date startTime,
                                              java.util.Date endTime)
Lists the names of the MiningLiftResult objects stored in the DMS created between the specified start and end times.
Parameters:
dmsConn - A connection to the DMS
startTime - The starting time of the lift computation in the DMS
endTime - The ending time of the lift computation in the DMS
Returns:
String[] - An array of lift result names

listContents

public static java.lang.String[] listContents(Connection dmsConn,
                                              java.util.Date startTime,
                                              java.util.Date endTime,
                                              java.lang.String modelName)
Lists the names of the MiningLiftResult objects stored in the DMS derived from the speicfied model, and created between the specified start and end times.
Parameters:
dmsConn - A connection to the DMS
startTime - The starting time of the lift computation in the DMS
endTime - The ending time of the lift computation in the DMS
modelName - The name of the model used to derive the lift results
Returns:
String[] - An array of lift result names

toString

public java.lang.String toString()
Returns a formatted string representation of the lift result.
Overrides:
toString in class java.lang.Object
Returns:
String - A string representation of the lift result