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 DMS 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
TypeMethod
 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 DMS 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 void remove(Connection dmsConn, java.lang.String resultName)
          Removes the named apply result from the DMS.
static void 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)
          Retrieves the named apply result from the DMS.
 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, 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

restore

public static MiningApplyResult restore(Connection dmsConn,
                                        java.lang.String resultName)
                                 throws java.sql.SQLException,
                                        InvalidArgumentException,
                                        ODMException
Retrieves the named apply result from the DMS.
Parameters:
dmsConn - A connection to the DMS
resultName - The name of the apply result to be retrieved
Returns:
MiningApplyResult - The retrieved apply output object
Throws:
InvalidArgumentException - when either dmsConn or resultName is null.
ODMException - when resultName is empty or exceeds 64 characters in length.
java.sql.SQLException - An error occurs during retrieval of the apply result.

remove

public static void remove(Connection dmsConn,
                          java.lang.String resultName)
                   throws java.sql.SQLException,
                          InvalidArgumentException,
                          MiningObjectException,
                          ODMException
Removes the named apply result from the DMS. This operation does not drop the apply output table associated with the apply result being removed.
Parameters:
dmsConn - A connection to the DMS
resultName - The name of the apply result to be removed
Returns:
void
Throws:
InvalidArgumentException - when either dmsConn or resultName is null.
ODMException - when resultName is empty or exceeds 64 characters in length.
MiningObjectException - The named apply result does not exist in the DMS.

remove

public static void 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:
void
Throws:
InvalidArgumentException - when either dmsConn or resultName is null.
ODMException - when resultName is empty or exceeds 64 characters in length.
MiningObjectException - The named apply result does not exist in the DMS.
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:
String[] - 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:
String[] - 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:
String[] - 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 exceeds 64 characters in length.
java.sql.SQLException - An error occurs during retrieval of the names

getSchemaName

public java.lang.String getSchemaName()
Returns the schema name of the DMS where this apply result is persisted.
Returns:
String - The schema name of the DMS

getApplyOutputTableName

public java.lang.String getApplyOutputTableName()
Returns the apply output table name represented by this apply result.
Returns:
String - 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