javax.datamining.task
Interface BuildTask

All Superinterfaces:

MiningObject, Task

public interface BuildTask

extends Task

BuildTask provides an abstraction of the metadata needed to build a mining model. Like all tasks, execution is done via Connection, which returns the execution handle.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, Task

Method Summary

java.lang.String	getApplicationName() Returns the name of the application that uses this task to build a model.
java.util.Map	getBuildDataMap() Returns the attribute map for build input data.
java.lang.String	getBuildDataName() Returns the name of the physical data used as input by the build task.
java.lang.String	getBuildSettingsName() Returns the name of the build settings used as a specification for building a model.
java.lang.String	getInputModelName() Returns the name of the model (if any) that will be used as a seed for incremental model building.
java.lang.String	getModelDescription() Returns the description of the model.
java.lang.String	getModelName() Returns the name of the model to be built by this task.
java.util.Map	getValidationDataMap() Returns the attribute map for validation input data.
java.lang.String	getValidationDataName() Returns the name of the data to be used for validation while building the model.
void	setApplicationName(java.lang.String name) Sets the name of the application that uses this task to build a model.
void	setBuildDataMap(java.util.Map buildDataMap) Specifies a mapping between physical attribute names and logical attribute names for input build data.
void	setBuildDataName(java.lang.String name) Sets the name of the physical data to be used as input by the build task.
void	setBuildSettingsName(java.lang.String name) Sets the name of the build settings to be used as a specification for building a model.
void	setInputModelName(java.lang.String modelName) Specifies the name of a model that may be used as a seed for incremental model building.
void	setModelDescription(java.lang.String description) Sets the description of the model.
void	setModelName(java.lang.String name) Sets the name of the model to be built by the task.
void	setValidationDataMap(java.util.Map validationDataMap) Specifies a mapping between physical attribute names and logical attribute names for input validation data.
void	setValidationDataName(java.lang.String validationDataName) Specifies the name of the data to be used for validation while building the model.
VerificationReport	verify() Determines whether the specification of the build 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

getApplicationName

public java.lang.String getApplicationName()

Returns the name of the application that uses this task to build a model.

Returns:

String

getBuildDataMap

public java.util.Map getBuildDataMap()

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

Returns:

Map

getBuildDataName

public java.lang.String getBuildDataName()

Returns the name of the physical data used as input by the build task.

Returns:

String

getBuildSettingsName

public java.lang.String getBuildSettingsName()

Returns the name of the build settings used as a specification for building a model.

Returns:

String

getInputModelName

public java.lang.String getInputModelName()

Returns the name of the model (if any) that will be used as a seed for incremental model building. Returns null if not specified.

Returns:

String

getModelDescription

public java.lang.String getModelDescription()

Returns the description of the model.

Returns:

String

getModelName

public java.lang.String getModelName()

Returns the name of the model to be built by this task.

Returns:

String

getValidationDataMap

public java.util.Map getValidationDataMap()

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

Returns:

Map

getValidationDataName

public java.lang.String getValidationDataName()

Returns the name of the data to be used for validation while building the model.

Returns:

String

setApplicationName

public void setApplicationName(java.lang.String name)

Sets the name of the application that uses this task to build a model. The application name can be later retrieved from the model after the model is built. Refer to Model.

Parameters:

name -

Returns:

void

setBuildDataMap

public void setBuildDataMap(java.util.Map buildDataMap)
                     throws JDMException

Specifies a mapping between physical attribute names and logical attribute names for input build data. The key for the mapping is the physical attribute name. The user provides a java.util.Map object that contains mapping of physical attribute name to logical attribute name.

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 PhysicalAttributes with caseId and atttributeName roles. Such data can be used for AssociationRules directly without explicit mapping.

Parameters:

buildDataMap - A map that contains the mapping between physical attribute names and logical attribute names for build data.

Returns:

void

Throws:

JDMException

setBuildDataName

public void setBuildDataName(java.lang.String name)
                      throws JDMException

Sets the name of the physical data to be used as input by the build task.

Parameters:

name - The name of the physical data.

Returns:

void

Throws:

JDMException

setBuildSettingsName

public void setBuildSettingsName(java.lang.String name)
                          throws JDMException

Sets the name of the build settings to be used as a specification for building a model.

Parameters:

name - The name of the function settings.

Returns:

void

Throws:

JDMException

setInputModelName

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

Specifies the name of a model that may be used as a seed for incremental model building. The signature of the model must be compatible with the provided settings for model building.

Parameters:

modelName - A new model name to be used when persisting the resulting model.

Returns:

void

Throws:

JDMException

setModelDescription

public void setModelDescription(java.lang.String description)

Sets the description of the model.

Parameters:

description -

Returns:

void

setModelName

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

Sets the name of the model to be built by the task.

Parameters:

name - The model name to be built.

Returns:

void

Throws:

JDMException

setValidationDataMap

public void setValidationDataMap(java.util.Map validationDataMap)
                          throws JDMException

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

Parameters:

validationDataMap - A map that contains the mapping between physical attribute names and logical attribute names for validation data.

Returns:

void

Throws:

JDMException

setValidationDataName

public void setValidationDataName(java.lang.String validationDataName)
                           throws JDMException

Specifies the name of the data to be used for validation while building the model.

Parameters:

validationDataName - The name of the validation data.

Returns:

void

Throws:

JDMException

verify

public VerificationReport verify()

Determines whether the specification of the build task is correct. If null is returned, the verification is successful. A non-null VerificationReport object returned means that the verification is not successful and the object contains an appropriate explanation. This includes a check if all logical attributes (for settings or input model) have been assigned a physical source. When no mapping has been explicitly specified for a (required) logical attribute, a physical attribute is automatically mapped by name (direct mapping), if possible.

Returns:

VerificationReport