public interface DecisionListModelInteractor extends ModelInteractor
Modifier and Type | Method and Description |
---|---|
void |
addExecutionFeedbackListener(ExecutionFeedbackListener listener)
Adds the specified execution feedback listener to this session.
|
void |
addExecutionStateListener(ExecutionStateListener listener)
Adds the specified execution state listener to this session.
|
DecisionListModel |
createDecisionListModel(ModelDetail model)
Creates a Decision List model from the specified model detail.
|
DecisionListModel |
createDecisionListModel(java.lang.String pmml)
Creates a Decision List model from the specified PMML.
|
DecisionListModel |
createDefaultModel()
Creates a default model from this session which includes just the remainder rule.
|
ModelDetail |
createModelDetail(DecisionListModel model)
Creates model detail for the specified model.
|
ModelOutput |
createModelOutput(ModelDetail modelDetail)
Creates a
ModelOutput from the specified model detail. |
ModelOutput |
createModelOutput(ModelDetail modelDetail,
java.lang.Object interactiveState)
Creates a
ModelOutput from the specified model detail. |
DataModel |
getDataModel()
Returns a data model which describes the available fields in this modelling session.
|
java.lang.Object |
getMetadata()
Returns the metadata from this interactor which must be preserved in any saved interactive state.
|
java.lang.String |
getPartitionName()
Returns the name of the partition column in the data model, or
null if there
is no partition column. |
DecisionListTaskFactory |
getTaskFactory()
Returns the task factory for this session.
|
void |
interrupt()
Interrupts any synchronous task which is currently executing on this session.
|
boolean |
isBusy()
Returns
true if this session is currently executing a synchronous task
(even if the task is in the process of being interrupted). |
void |
removeExecutionFeedbackListener(ExecutionFeedbackListener listener)
Removes the specified execution feedback listener from this session.
|
void |
removeExecutionStateListener(ExecutionStateListener listener)
Removes the specified execution state listener from this session.
|
ExecutionHandle |
runTask(Task task)
Executes the supplied task synchronously and waits for it to complete.
|
ExecutionHandle |
spawnTask(Task task)
Executes the supplied task asynchronously.
|
getModelInteractorType
getInteractiveOutput
DataModel getDataModel()
java.lang.String getPartitionName()
null
if there
is no partition column. The partition column partitions the data into train and test sets,
and possibly more. Information about the partition column can be obtained from the data model
(see getDataModel()
). The column typically has measure type MeasureType.SET
and
the values of the column, which identify the partitions, can be obtained from
DataModel.getSetValues(String)
. The first two values identify the train and test sets
respectively.java.lang.Object getMetadata()
PropertyFactory.createDecisionListInteractiveState
.ModelOutput createModelOutput(ModelDetail modelDetail) throws ObjectCreationException
ModelOutput
from the specified model detail.
The model detail must describe a Decision List model, as returned by
createModelDetail(DecisionListModel)
, and the output represents
that completed model.modelDetail
- the model detailObjectCreationException
- if the model detail cannot be createdModelOutput createModelOutput(ModelDetail modelDetail, java.lang.Object interactiveState) throws ObjectCreationException
ModelOutput
from the specified model detail.
The model detail must describe a Decision List model, as returned by
createModelDetail(DecisionListModel)
, and the output represents
that completed model.
The specified interactive state, if not null
, must be one returned by
PropertyFactory.createDecisionListInteractiveState
which is preserved in the generated model.modelDetail
- the model detailinteractiveState
- the current interactive state, or null
ObjectCreationException
- if the model detail cannot be createdModelDetail createModelDetail(DecisionListModel model) throws ObjectCreationException
ModelOutput
by calling createModelOutput(ModelDetail)
.model
- the modelModelDetail
for the specified modelObjectCreationException
- if the model detail cannot be createdDecisionListModel createDecisionListModel(ModelDetail model) throws ObjectCreationException
createModelDetail(DecisionListModel)
.model
- the model detailObjectCreationException
- if the model cannot be createdDecisionListModel createDecisionListModel(java.lang.String pmml) throws ObjectCreationException
pmml
- the Decision List PMMLObjectCreationException
- if a model cannot be constructed from the PMMLDecisionListModel createDefaultModel()
DecisionListTaskFactory getTaskFactory()
DecisionListTaskFactory
for this interactorExecutionHandle runTask(Task task) throws OwnerException, ObjectLockedException, SessionException
ExecutionHandle
which can be used to access the exit status and any result from the task.task
- the Task
to be executedOwnerException
- if the task was not created by this interactor's DecisionListTaskFactory
ObjectLockedException
- if the task is already executing or any object referenced by the task is
locked for updatingSessionException
- if the task cannot be executed or if execution completes in a state other than
SUCCESS
ExecutionHandle spawnTask(Task task) throws OwnerException, ObjectLockedException
ExecutionHandle
which can be used to monitor and control the progress of the task.task
- the Task
to be executedOwnerException
- if the task was not created by this interactor's DecisionListTaskFactory
ObjectLockedException
- if the task is already executing or any object referenced by the task is
locked for updatingvoid addExecutionStateListener(ExecutionStateListener listener)
listener
- the listener to be addedvoid removeExecutionStateListener(ExecutionStateListener listener)
listener
- the listener to be removedvoid addExecutionFeedbackListener(ExecutionFeedbackListener listener)
listener
- the listener to be addedvoid removeExecutionFeedbackListener(ExecutionFeedbackListener listener)
listener
- the listener to be removedboolean isBusy()
true
if this session is currently executing a synchronous task
(even if the task is in the process of being interrupted).
This method may be called from any thread.
true
if this session is executing a synchronous taskinterrupt()
void interrupt()
This method may be called from any thread.
isBusy()
(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.