oracle.dmt.odm.result
Class MiningResult

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.result.MiningResult

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MiningApplyResult, MiningBuildResult, MiningLiftResult, MiningTestResult, ModelSeekerResultEntry

public abstract class MiningResult

extends oracle.dmt.odm.LocatableObject

A mining result object contains the end products of one of the following mining tasks: build, test, compute lift, or apply. ODM supports the persistence of mining results as independent, named entities in the DMS.

A mining result object contains the operation start time and end time, the name of the model used, input data location, and output data location (if any) for the data mining operation.

A build result contains the model details. It provides the function and algorithm name of the model.

An apply result names the destination table (schema and table name) for the result.

A test result, for classification models, contains the model accuracy and references the confusion matrix.

A lift result of the lift elements is calculated on a per-quantile basis.

Since:

9.0.1

See Also:

Serialized Form

Method Summary

java.sql.Timestamp	getCompletionTimestamp() Returns the completion time of the mining operation that created this mining result.
long	getDurationTime() Deprecated. As of 9.2.0, replaced by getExecutionDuration method.
long	getExecutionDuration() Returns the duration of which the mining operation executed to create this mining result.
oracle.dmt.odm.Location	getInputMiningData() Returns the location of the mining data from which this mining result was generated.
java.lang.String	getMiningModel() Returns the name of the mining model by which this mining result was generated.
int	getMiningModelID() Returns the id of the input mining model by which this mining result was generated.
java.lang.String	getName() Returns the name of the mining result.
java.sql.Timestamp	getStartingTimestamp() Returns the starting time of the mining operation that created this mining result.
static boolean	remove(Connection dmsConn, java.lang.String resultName) Removes the specified mining result from the database.
static boolean	rename(Connection dmsConn, java.lang.String oldObjectName, java.lang.String newObjectName) Renames the specified mining result.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Returns the name of the mining result.

Returns:

The result name

getStartingTimestamp

public java.sql.Timestamp getStartingTimestamp()

Returns the starting time of the mining operation that created this mining result.

Returns:

mining operation start timestamp

getCompletionTimestamp

public java.sql.Timestamp getCompletionTimestamp()

Returns the completion time of the mining operation that created this mining result.

Returns:

mining operation completion timestamp

getDurationTime

public long getDurationTime()
                     throws java.lang.Exception

Deprecated. As of 9.2.0, replaced by getExecutionDuration method.

Returns the duration of which the mining operation executed to create this mining result.

Returns:

The execution duration in milliseconds

java.lang.Exception

getExecutionDuration

public long getExecutionDuration()

Returns the duration of which the mining operation executed to create this mining result.

Returns:

The execution duration in milliseconds

getInputMiningData

public oracle.dmt.odm.Location getInputMiningData()

Returns the location of the mining data from which this mining result was generated.

Returns:

Location the input mining data

getMiningModel

public java.lang.String getMiningModel()

Returns the name of the mining model by which this mining result was generated.

Returns:

input model name

getMiningModelID

public int getMiningModelID()

Returns the id of the input mining model by which this mining result was generated. Returns -1 if there is no input mining model associated with this result

Returns:

The model id

Since:

10.1

remove

public static boolean remove(Connection dmsConn,
                             java.lang.String resultName)
                      throws java.sql.SQLException,
MiningObjectException,
InvalidArgumentException,
ODMException

Removes the specified mining result from the database.

Parameters:

dmsConn - A connection to the data mining server

resultName - The name of the mining result to be removed

Returns:

true if removed successfully, otherwise false

Throws:

InvalidArgumentException - is thrown
- when dmsConn is null, or
- when resultName is null.

ODMException - is thrown
- when resultName is empty or exceeds 64 characters in length.

java.sql.SQLException - when an error occurs during the retrieval

MiningObjectException - when the mining result does not exist in the data mining server

rename

public static boolean rename(Connection dmsConn,
                             java.lang.String oldObjectName,
                             java.lang.String newObjectName)
                      throws java.sql.SQLException,
InvalidArgumentException,
ODMException

Renames the specified mining result.

Parameters:

dmsConn - A connection to the data mining server

oldObjectName - The name of the mining result to be renamed

newObjectName - The new name of the mining result to be assigned

Returns:

boolean - A flag indicating whether the specified object has been renamed successfully. false means that the result object to be renamed was not found.

Throws:

InvalidArgumentException - is thrown
- when dmsConn is null, or
- when oldObjectName is null,
- when newObjectName is null.

ODMException - is thrown
- when oldObjectName is empty or exceeds 64 characters in length.
- when newObjectName is empty or exceeds 25 bytes in length.

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

java.sql.SQLException

Since:

10.1