oracle.dmt.odm.result
Class ModelSeekerResult

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

All Implemented Interfaces:

java.io.Serializable

Deprecated.

Model Seeker functionality is deprecated in version 10.1.

public class ModelSeekerResult

extends MiningBuildResult

An instance of ModelSeekerResult contains the results objects created by the execution of a ModelSeekerTask.
This class contains an array of ModelSeekerResultEntry objects, one for each model built by the ModelSeekerTask execution. The ModelSeekerResultEntry corresponding to the best model (as determined by the ModelSeekerTask execution) is identified in the ModelSeekerResult by an index into the ModelSeekerResultEntry array.

This class has no public constructor because instances of this class are created only by the execution of the restore method.

See Also:

Serialized Form

Method Summary

int	getBestModelIndex() Deprecated. Returns the index corresponding to the best model.
ModelSeekerResultEntry[]	getModelSeekerEntryArray() Deprecated. Returns the array of ModelSeekerResultEntry objects.
static boolean	remove(Connection dmsConn, java.lang.String resultName) Deprecated. Removes the ModelSeekerResult object of the given name.
static boolean	rename(Connection dmsConn, java.lang.String resultOldName, java.lang.String resultNewName) Deprecated. Renames the specified model seeker result.
static MiningBuildResult	restore(Connection dmsConn, java.lang.String resultName) Deprecated. Restores ModelSeekerResult object of the given name.
static MiningBuildResult	restoreIncludingInvisibleEntries(Connection dmsConn, java.lang.String resultName) Deprecated. For internal use only.

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

getAlgorithmName, getFunctionName, listContents, listContents, restorePastVersion

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

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

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 resultName)
                                                       throws InvalidArgumentException,
                                                              java.sql.SQLException,
ODMException

Deprecated.

Restores ModelSeekerResult object of the given name. The result object gets created as a ModelSeekerTask is executed and may be restored while the execution is taking place. The name of the result object is supplied as an argument to the ModelSeekerTask object.

It is NECESSARY TO CAST the object returned by this method to be a ModelSeekerResult object in the following manner:

     ModelSeekerResult msResult =
          (ModelSeekerResult)ModelSeekerResult.restore(conn,"name");

Parameters:

dmsConn - connection to the data mining server

resultName - name of the model to restore associated build results

Returns:

The ModelSeekerResult object cast as a MiningBuildResult object.

Throws:

ODMException
- the caller has not previously logged into ODM DMS

SQLException
- failure in a JDBC call to the database made by an internally used method

InvalidArgumentException
- null dmsConn
- null sTaskName
- zero length or too long sTaskName argument
If there is more than one invalid argument, the exception message identifies the first invalid argument found and the reason it is invalid.

InvalidArgumentException -

• when either dmsConn or modelName is null.
• when modelName is empty or length exceeds the limit.

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

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

restoreIncludingInvisibleEntries

public static MiningBuildResult restoreIncludingInvisibleEntries(Connection dmsConn,
                                                                 java.lang.String resultName)
                                                                                throws InvalidArgumentException,
                                                                                       java.sql.SQLException,
ODMException

Deprecated.

For internal use only.

InvalidArgumentException

java.sql.SQLException

ODMException

remove

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

Deprecated.

Removes the ModelSeekerResult object of the given name. The name of the result object is supplied as an argument to the ModelSeekerTask constructor. This remove method cleans up all the named objects associated with the ModelSeekerResult. The method first validates the arguments, and then performs removals. If an error is detected while performing removals, the method continues removing as many items as possible and collects error information about the items that were not removed. This error information is formatted into an ODMException (see below).

The items removed include:
1. All the ModelSeekerResultEntry objects associated with the ModelSeekerResult object
2. All the MiningTestResult objects associated with all the ModelSeekerResultEntry objects
3. All the MiningLiftResult objects associated with all the ModelSeekerResultEntry objects
4. All the MiningFunctionSettings objects associated with all the ModelSeekerResultEntry objects
5. All the MiningModel objects associated with all the ModelSeekerResultEntry objects that were kept when the ModelSeekerTask that created the result was executed.

Parameters:

resultName - This is the name of the result object to be removed.

dmsConn - A connection to the data mining server

Returns:

boolean - A flag indicating whether the specified object has been removed successfully. false indicates that the object was not found.

Throws:

InvalidArgumentException - when


• dmsConn is null, or
• resultName is null, or
• modelName is empty or exceeds 30 bytes in length.

ODMException - when

• StringCheck object is null, or
• failure to retrieve the id for ModelSeekerResult object to be removed, or
• failure to retrieve the set of ids for the constituent ModelSeekerResultEntry objects, or
• failure to retrieve an entry row from the ResultSet returned from the select of the entry collection, or
• failure to retrieve the string for name of a referenced object in a constituent ModelSeekerResultEntry object, or
• failure to retrieve the id for any object referenced by name in a constituent ModelSeekerResultEntry object, or
• failure to remove any object referenced by name in a constituent ModelSeekerResultEntry object due to an exception (if the object is not found, then this is ignored), or
• failure to remove any constituent ModelSeekerResultEntry object, or
• failure to remove the ModelSeekerResult object.

For the first three cases, only a single exception message is included with the exception. For the fourth case, this caught SQL Exception indicates a fatal error has been detected in the runtime environment, and the remove method will immediately raise an exception and processing terminates. For the remaining cases, the caught exception message is remembered, and processing continues. For the fourth through the remaining cases, the final exception message is the concatenation of all of the exception messages for all exceptions caught during the remove processing.

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

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

rename

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

Deprecated.

Renames the specified model seeker result.

Parameters:

dmsConn - A connection to the data mining server

resultOldName - The name of the model seeker result to be renamed

resultNewName - The new name of the model seeker 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 -

• dmsConn is null, or
• resultOldName is null,
• resultNewName is null.

ODMException - when resultOldName or resultNewName is empty or length exceeds the limit.

java.sql.SQLException - when an error occurs during the rename operation

getBestModelIndex

public int getBestModelIndex()

Deprecated.

Returns the index corresponding to the best model.

The following code illustrates how to retrieve the ModelSeekerResultEntry object corresponding to the best model for the ModelSeekerResult:

    ModelSeekerResultEntry[] myEntries = myResult.getModelSeekerEntrysArray();
    int bestModelIndex = myResult.getBestModelIndex();
    ModelSeekerResultEntry bestEntry = myEntries[bestModelIndex];

Returns:

The index, into the ModelSeekerResultEntry array, corresponding to the best model associated with current ModelSeekerResult object.

getModelSeekerEntryArray

public ModelSeekerResultEntry[] getModelSeekerEntryArray()

Deprecated.

Returns the array of ModelSeekerResultEntry objects.

Returns:

The array of the ModelSeekerResultEntry objects associated with current ModelSeekerResult object. Each object in the array corresponds to one model built by the ModelSeekerTask.