javax.datamining.task.apply
Interface RecordApplyTask

All Superinterfaces:
ApplyTask, MiningObject, Task

public interface RecordApplyTask
extends ApplyTask

RecordApplyTask captures the task of applying a mining model to a single record. This task can be executed only synchronously. Refer to Connection.

The input record may be reused by the application to minimize the number of objects created for apply. The input record is not to be modified by the execution of the RecordApplyTask.

The output record is automatically created by the system and reused upon each invocation. It is up to the application to copy the values from the output record as needed.

The output record is not valid with results until the execution completes.

Author:
JSR-73 Java Data Mining Expert Group
See Also:
MiningObject, Task, ApplyTask

Method Summary
 PhysicalDataRecord getInputRecord()
          Returns the input record to be used for apply.
 PhysicalDataRecord getOutputRecord()
          Returns the record that contains both the input and output.
 void setInputRecord(PhysicalDataRecord record)
          Sets the record to be used for apply.
 
Methods inherited from interface javax.datamining.task.apply.ApplyTask
getApplyDataMap, getApplySettingsName, getModelName, setApplyDataMap, setApplySettingsName, setModelName, verify
 
Methods inherited from interface javax.datamining.base.Task
getExecutionHandle
 
Methods inherited from interface javax.datamining.MiningObject
getCreationDate, getCreatorInfo, getDescription, getName, getObjectIdentifier, getObjectType, setDescription
 

Method Detail

getInputRecord

public PhysicalDataRecord getInputRecord()
Returns the input record to be used for apply.

Returns:
PhysicalDataRecord

getOutputRecord

public PhysicalDataRecord getOutputRecord()
Returns the record that contains both the input and output. The input record is used to contain the apply result.

Returns:
PhysicalDataRecord

setInputRecord

public void setInputRecord(PhysicalDataRecord record)
                    throws JDMException
Sets the record to be used for apply.

Parameters:
record - The record to be used for apply.
Returns:
void
Throws:
JDMException