oracle.dmt.odm.result
Class MiningBuildResult

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.result.MiningResult
                    |
                    +--oracle.dmt.odm.result.MiningBuildResult
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ModelSeekerResult

public class MiningBuildResult
extends MiningResult

An instance of MiningBuildResult represents the result of the build mining operation. Note that the result name and the model name are same.

See Also:
Serialized Form

Method Summary
TypeMethod
 java.lang.String getAlgorithmName()
          Returns name of the algorithm used to build this model.
 java.lang.String getFunctionName()
          Returns name of the function used to build this model.
static java.lang.String[] listContents(Connection dmsConn)
          Returns names of all build results present in the data mining server.
static java.lang.String[] listContents(Connection dmsConn, java.util.Date start, java.util.Date end)
          Returns names of build results created within the specified time interval in the data mining server.
static void remove(Connection dmsConn, java.lang.String modelName)
          Removes the MiningBuildResult object.
static MiningBuildResult restore(Connection dmsConn, java.lang.String modelName)
          Restores the specified object in the ODM schema into the client space.
 
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, toString, wait, wait, wait
 

Method Detail

restore

public static MiningBuildResult restore(Connection dmsConn,
                                        java.lang.String modelName)
                                 throws InvalidArgumentException,
                                        ODMException,
                                        java.sql.SQLException
Restores the specified object in the ODM schema into the client space.
Parameters:
dmsConn - connection to the data mining server
modelName - name of the model to restore associated build results
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.

remove

public static void remove(Connection dmsConn,
                          java.lang.String modelName)
                   throws java.sql.SQLException,
                          InvalidArgumentException,
                          MiningObjectException
Removes the MiningBuildResult object. This operation removes the associated model from the DMS.
Parameters:
dmsConn - - connection object
modelName - - name of the model
Returns:
void
Throws:
InvalidArgumentException -
  • when either dmsConn or modelName is null.
  • when modelName is empty or exceeds 64 characters in length.
MiningObjectException - when the named model does not exist in the data mining server.
java.sql.SQLException - when there is a failure in the JDBC operations to remove the build results with the model.

listContents

public static java.lang.String[] listContents(Connection dmsConn)
                                       throws java.sql.SQLException,
                                              InvalidArgumentException
Returns names of all build results present in the data mining server.
Parameters:
dmsConn - A connection to the data mining server
Returns:
String[] - An array of build 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 build results created within the specified time interval in the data mining server.
Parameters:
dmsConn - A connection to the data mining server
start - The starting time of the interval
end - The ending time of the interval
Returns:
String[] - An array of build 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

getFunctionName

public java.lang.String getFunctionName()
Returns name of the function used to build this model.

getAlgorithmName

public java.lang.String getAlgorithmName()
Returns name of the algorithm used to build this model.