oracle.dmt.odm.task
Class MiningBuildTask

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.task.MiningTask
                    |
                    +--oracle.dmt.odm.task.MiningDataTask
                          |
                          +--oracle.dmt.odm.task.MiningBuildTask
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ModelSeekerTask

public class MiningBuildTask
extends MiningDataTask

An instance of MiningBuildTask is used for building all mining models supported by ODM. The model to be built is based on the user-specified mining function settings (MFS), which must be persisted in the DMS. ODM 9.2.0 supports the building of the following mining models:

After constructing a valid MiningBuildTask instance, it must be persisted in the DMS using store instance method before executing. The task name must be unique in the DMS task name space.

After successful completion of the build task, the user can retrieve the model using the static restore(dmsConn, taskName) utility method in the corresponding model object. A model name must be unique in the DMS mining model name space. Corresponding model object instance methods can be used to retrieve the model-specific attributes. ModelBuildResults object can be used to retrieve the details of the build task. To remove the mining build task object in a DMS, invoke the static method remove(dmsConn, taskName).

Since:
ODM 9.2.0
See Also:
Serialized Form

Constructor Summary
MiningBuildTask(PhysicalDataSpecification taskInputData, java.lang.String funcSettingName, java.lang.String resultModelName)
          Creates an instance of a build task with the specified mining data, mining function settings, and name for the model.
 
Method Summary
TypeMethod
 java.lang.String getResultModelName()
          Returns the name of the model built for this task.
 java.lang.String getSettingsName()
          Returns the name of the mining function settings object used in mining build task.
static MiningBuildTask restore(Connection dmsConn, java.lang.String taskName)
          Restores the user-specified mining build task object from the DMS.
 
Methods inherited from class oracle.dmt.odm.task.MiningDataTask
getInputModelName, getTaskInputData
 
Methods inherited from class oracle.dmt.odm.task.MiningTask
execute, getCurrentStatus, getExecutionDuration, getName, getStatusHistory, listTasks, remove, store, terminate, waitForCompletion, waitForCompletion
 
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
 

Constructor Detail

MiningBuildTask

public MiningBuildTask(PhysicalDataSpecification taskInputData,
                       java.lang.String funcSettingName,
                       java.lang.String resultModelName)
                throws InvalidArgumentException,
                       ODMException
Creates an instance of a build task with the specified mining data, mining function settings, and name for the model.
Parameters:
taskInputData - Physical data specification of the input data
funcSettingName - Name of the mining function settings to be used for building the mining model
resultModelName - Name of the resulting model and the model build result name. Model and the associated build results uses the same name
Throws:
InvalidArgumentException - -- is thrown
- when the taskInputData/funcSettingName/resultModelName are null
- when the taskInputData does not have LocationAccessData specified
- when the funcSettingName/resultModelName length >64 characters
Method Detail

getSettingsName

public java.lang.String getSettingsName()
Returns the name of the mining function settings object used in mining build task.
Returns:
String - mining function settings name.

getResultModelName

public java.lang.String getResultModelName()
Returns the name of the model built for this task.
Returns:
String - output model name.

restore

public static MiningBuildTask restore(Connection dmsConn,
                                      java.lang.String taskName)
                               throws InvalidArgumentException,
                                      MiningTaskException,
                                      java.sql.SQLException,
                                      ODMException
Restores the user-specified mining build task object from the DMS.
Parameters:
dmsConn - Data mining server connection
taskName - Name of the build task
Returns:
MiningBuildTask - restored mining build task
Throws:
InvalidArgumentException - is thrown
- when the dmsConn or taskName is null
- when the taskName length >64 characters
MiningTaskException - is thrown
- when the restore fails
SQLException - is thrown
- when there is a failure in JDBC calls