com.spss.psapi.interaction

Interface DecisionListModelInteractor

    • Method Detail

      • getDataModel

        DataModel getDataModel()
        Returns a data model which describes the available fields in this modelling session. These are the fields which are stored in the data cache and are available to the modelling algorithm.
        Returns:
        the data model of the cached data
      • getPartitionName

        java.lang.String getPartitionName()
        Returns the name of the partition column in the data model, or 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.
        Returns:
        the name of the partition column in the data model
      • getMetadata

        java.lang.Object getMetadata()
        Returns the metadata from this interactor which must be preserved in any saved interactive state. See PropertyFactory.createDecisionListInteractiveState.
        Returns:
        the metadata from this interactor
      • createModelOutput

        ModelOutput createModelOutput(ModelDetail modelDetail)
                                      throws ObjectCreationException
        Creates a 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.
        Parameters:
        modelDetail - the model detail
        Returns:
        a Decision List model output created from the detail
        Throws:
        ObjectCreationException - if the model detail cannot be created
      • createModelOutput

        ModelOutput createModelOutput(ModelDetail modelDetail,
                                    java.lang.Object interactiveState)
                                      throws ObjectCreationException
        Creates a 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.
        Parameters:
        modelDetail - the model detail
        interactiveState - the current interactive state, or null
        Returns:
        a Decision List model output created from the detail
        Throws:
        ObjectCreationException - if the model detail cannot be created
      • createModelDetail

        ModelDetail createModelDetail(DecisionListModel model)
                                      throws ObjectCreationException
        Creates model detail for the specified model. The result can be used to generate a finished ModelOutput by calling createModelOutput(ModelDetail).
        Parameters:
        model - the model
        Returns:
        ModelDetail for the specified model
        Throws:
        ObjectCreationException - if the model detail cannot be created
      • createDecisionListModel

        DecisionListModel createDecisionListModel(ModelDetail model)
                                                  throws ObjectCreationException
        Creates a Decision List model from the specified model detail. The model detail must describe a Decision List model, as returned by createModelDetail(DecisionListModel).
        Parameters:
        model - the model detail
        Returns:
        a Decision List model created from the detail
        Throws:
        ObjectCreationException - if the model cannot be created
      • createDecisionListModel

        DecisionListModel createDecisionListModel(java.lang.String pmml)
                                                  throws ObjectCreationException
        Creates a Decision List model from the specified PMML.
        Parameters:
        pmml - the Decision List PMML
        Returns:
        a Decision List model constructed from the PMML
        Throws:
        ObjectCreationException - if a model cannot be constructed from the PMML
      • createDefaultModel

        DecisionListModel createDefaultModel()
        Creates a default model from this session which includes just the remainder rule.
        Returns:
        a default Decision List model
      • getTaskFactory

        DecisionListTaskFactory getTaskFactory()
        Returns the task factory for this session. The task factory creates interactive tasks which can be executed by this session.
        Returns:
        the DecisionListTaskFactory for this interactor
      • runTask

        ExecutionHandle runTask(Task task)
                                throws OwnerException,
                                       ObjectLockedException,
                                       SessionException
        Executes the supplied task synchronously and waits for it to complete. Returns an ExecutionHandle which can be used to access the exit status and any result from the task.
        Parameters:
        task - the Task to be executed
        Returns:
        a handle on the execution task
        Throws:
        OwnerException - 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 updating
        SessionException - if the task cannot be executed or if execution completes in a state other than SUCCESS
      • spawnTask

        ExecutionHandle spawnTask(Task task)
                                  throws OwnerException,
                                         ObjectLockedException
        Executes the supplied task asynchronously. Returns an ExecutionHandle which can be used to monitor and control the progress of the task.
        Parameters:
        task - the Task to be executed
        Returns:
        a handle on the execution task
        Throws:
        OwnerException - 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 updating
      • addExecutionStateListener

        void addExecutionStateListener(ExecutionStateListener listener)
        Adds the specified execution state listener to this session.
        Parameters:
        listener - the listener to be added
      • removeExecutionStateListener

        void removeExecutionStateListener(ExecutionStateListener listener)
        Removes the specified execution state listener from this session.
        Parameters:
        listener - the listener to be removed
      • addExecutionFeedbackListener

        void addExecutionFeedbackListener(ExecutionFeedbackListener listener)
        Adds the specified execution feedback listener to this session.
        Parameters:
        listener - the listener to be added
      • removeExecutionFeedbackListener

        void removeExecutionFeedbackListener(ExecutionFeedbackListener listener)
        Removes the specified execution feedback listener from this session.
        Parameters:
        listener - the listener to be removed
      • isBusy

        boolean isBusy()
        Returns 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.

        Returns:
        true if this session is executing a synchronous task
        See Also:
        interrupt()
      • interrupt

        void interrupt()
        Interrupts any synchronous task which is currently executing on this session. The call returns immediately while the task is interrupted. It has no effect if the session is not busy.

        This method may be called from any thread.

        See Also:
        isBusy()

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.