oracle.dmt.odm.result
Class MiningApplyResult

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

All Implemented Interfaces:

java.io.Serializable

public class MiningApplyResult

extends MiningResult

An instance of MiningApplyResult represents the result of the apply mining operation.

Note that apply result is a named metadata object stored in the database and represents the result of the apply mining operation including the apply output table, while apply output is a database table that contains the predictions and associated results of the apply operation.

Since:

9.0.1

See Also:

MiningApplyOutput,
MiningApplyTask, Serialized Form

Method Summary

java.lang.String	getApplyOutputTableName() Returns the apply output table name represented by this apply result.
java.lang.String	getSchemaName() Returns the schema name of the database where this apply result is persisted.
static java.lang.String[]	listContents(Connection dmsConn) Returns names of all apply results present in the DMS.
static java.lang.String[]	listContents(Connection dmsConn, java.util.Date start, java.util.Date end) Returns names of apply results created within the specified time interval in the DMS.
static java.lang.String[]	listContents(Connection dmsConn, java.util.Date start, java.util.Date end, java.lang.String modelName) Returns names of apply results created by the specified model within the specified time interval in the DMS.
static boolean	remove(Connection dmsConn, java.lang.String resultName, boolean dropApplyResultTable) Removes the named apply result from the DMS.
static MiningApplyResult	restore(Connection dmsConn, java.lang.String resultName) Restores the specified object from the database.
java.lang.String	toString() Returns a formatted string representation of apply result.

Methods inherited from class oracle.dmt.odm.result.MiningResult

getCompletionTimestamp, getDurationTime, getExecutionDuration, getInputMiningData, getMiningModel, getMiningModelID, getName, getStartingTimestamp, remove, rename

Methods inherited from class java.lang.Object

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

Method Detail

remove

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

Removes the named apply result from the DMS. The apply output table associated with the named apply result is also removed if dropApplyResultTable is true.

Parameters:

dmsConn - A connection to the DMS

resultName - The name of the apply result to be removed

dropApplyResultTable - Indicates to remove the apply result table associated with resultName if true.

Returns:

boolean - A flag indicating whether the specified object has been removed successfully.

Throws:

InvalidArgumentException - when either dmsConn or resultName is null.

ODMException - when resultName is empty or exceeds 30 bytes in length.

MiningObjectException - The named apply result does not exist in the DMS.

java.sql.SQLException

Since:

9.2.0

listContents

public static java.lang.String[] listContents(Connection dmsConn)
                                       throws java.sql.SQLException,
InvalidArgumentException

Returns names of all apply results present in the DMS.

Parameters:

dmsConn - A connection to the DMS

Returns:

An array of apply result names

Throws:

InvalidArgumentException - when dmsConn is null.

java.sql.SQLException - An error occurs during retrieval of the names

listContents

public static java.lang.String[] listContents(Connection dmsConn,
                                              java.util.Date start,
                                              java.util.Date end)
                                       throws java.sql.SQLException,
InvalidArgumentException

Returns names of apply results created within the specified time interval in the DMS.

Parameters:

dmsConn - A connection to the DMS

start - The starting time of the interval

end - The ending time of the interval

Returns:

An array of apply result names

Throws:

InvalidArgumentException -

• when dmsConn, start, or end is null, or
• when end precedes start.

java.sql.SQLException - An error occurs during retrieval of the names

listContents

public static java.lang.String[] listContents(Connection dmsConn,
                                              java.util.Date start,
                                              java.util.Date end,
                                              java.lang.String modelName)
                                       throws java.sql.SQLException,
InvalidArgumentException,
ODMException

Returns names of apply results created by the specified model within the specified time interval in the DMS.

Parameters:

dmsConn - A connection to the DMS

start - The starting time of the interval

end - The ending time of the interval

modelName - The name of the model by which the apply results were generated

Returns:

An array of apply result names

Throws:

InvalidArgumentException -

• when dmsConn, start, end, or modelName is null, or
• when end precedes start.

ODMException - when modelName is empty or length exceeds the limit.

java.sql.SQLException - An error occurs during retrieval of the names

getSchemaName

public java.lang.String getSchemaName()

Returns the schema name of the database where this apply result is persisted.

Returns:

The schema name of the DMS

getApplyOutputTableName

public java.lang.String getApplyOutputTableName()

Returns the apply output table name represented by this apply result.

Returns:

The name of the apply output table

toString

public java.lang.String toString()

Returns a formatted string representation of apply result.

Overrides:

toString in class java.lang.Object

Returns:

String

restore

public static MiningApplyResult restore(Connection dmsConn,
                                        java.lang.String resultName)
                                                       throws java.sql.SQLException,
ODMException

Restores the specified object from the database.

Parameters:

dmsConn - connection to the data mining server

Throws:

InvalidArgumentException -

• when either dmsConn or modelName is null.
• when modelName is empty or exceeds 64 characters in length.

ODMException - when there is a failure in the internal ODM operations

java.sql.SQLException - when there is a failure in JDBC operations to restore the object.