javax.datamining.task.apply
Interface ApplyTask

All Superinterfaces:

MiningObject, Task

All Known Subinterfaces:

DataSetApplyTask, RecordApplyTask

public interface ApplyTask

extends Task

ApplyTask captures the task of applying a mining model to data that matches the model signature.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, Task

Method Summary

java.util.Map	getApplyDataMap() Returns the attribute map for apply input data.
java.lang.String	getApplySettingsName() Returns the name of the apply settings specification to be used.
java.lang.String	getModelName() Returns the name of the model to apply.
void	setApplyDataMap(java.util.Map applyDataMap) Specifies a mapping between physical attribute names and signature attribute names for input apply data.
void	setApplySettingsName(java.lang.String applySettingsName) Sets the name of the apply settings specification to be used.
void	setModelName(java.lang.String modelName) Sets the name of the model to apply.
VerificationReport	verify() Determines whether the specification of the apply task is correct.

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

getApplyDataMap

public java.util.Map getApplyDataMap()

Returns the attribute map for apply input data. Returns null if no map has been provided.

Returns:

Map

getApplySettingsName

public java.lang.String getApplySettingsName()

Returns the name of the apply settings specification to be used.

Returns:

String

getModelName

public java.lang.String getModelName()

Returns the name of the model to apply.

Returns:

String

setApplyDataMap

public void setApplyDataMap(java.util.Map applyDataMap)
                     throws JDMException

Specifies a mapping between physical attribute names and signature attribute names for input apply data. The key for the mapping is the physical attribute name.

In case of explicit mapping, the user would need to provide a java.util.Map object that contains mapping of physical attribute name to logical attribute name.

Throws an exception if applyDataMap is null.

If the physical data is transactional and no mapping is provided, the data is still mapped as transactional as long as the data contains at least two PhysicalAttribute with caseId and atttributeName roles. Such data can be used for AssociationRules directly without explicit mapping.

Parameters:

applyDataMap - A map that contains the mapping between physical attribute names and signature attribute names for apply data.

Returns:

void

Throws:

JDMException

setApplySettingsName

public void setApplySettingsName(java.lang.String applySettingsName)
                          throws JDMException

Sets the name of the apply settings specification to be used. Any previously set apply settings is replaced.

Parameters:

applySettingsName -

Returns:

void

Throws:

JDMException

setModelName

public void setModelName(java.lang.String modelName)
                  throws JDMException

Sets the name of the model to apply.

Parameters:

modelName - A new model name to be used for apply.

Returns:

void

Throws:

JDMException

verify

public VerificationReport verify()

Determines whether the specification of the apply task is correct. This includes a check if all signature attributes have been assigned a physical source. When no mapping has been explicitly specified for a (required) signature attribute, a physical attribute is automatically mapped by name (direct mapping), if possible. If null is returned, the verification is successfully done. If a non-null VerificationReport object is returned, the mapping is not correctly done.

On execute, if a signature attribute does not have a mapped input, an exception is raised if synchronous, or a error status if asynchronous.

Returns:

VerificationReport