javax.datamining.supervised
Interface TestMetricsTask

All Superinterfaces:

MiningObject, Task

All Known Subinterfaces:

ClassificationTestMetricsTask, RegressionTestMetricsTask

public interface TestMetricsTask

extends Task

The interface TestMetricsTask represents a common placeholder for a task that is used to obtain various test metrics given an apply output. Test metrics include confusion matrix, lift, and receiver operating characteristics.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, Task

Method Summary

java.lang.String	getActualTargetAttrName() Returns the attribute name of the actual targets in the apply output data.
java.lang.String	getApplyOutputDataName() Returns the name of the apply output data.
java.lang.String	getPredictedTargetAttrName() Returns the attribute name of the predicted targets in the apply output data.
java.lang.String	getPredictionRankingAttrName() Returns the attribute name of the ranking factors for the predictions in the apply output data.
java.lang.String	getTestMetricsName() Returns the name of the test metrics to be created as the result of test metrics task.
void	setActualTargetAttrName(java.lang.String actualTargetAttrName) Sets the attribute name of the actual targets in the apply output data.
void	setApplyOutputDataName(java.lang.String applyOutputData) Sets the name of the apply output data.
void	setPredictedTargetAttrName(java.lang.String predictedTargetAttrName) Sets the attribute name of the predicted targets in the apply output data.
void	setPredictionRankingAttrName(java.lang.String predictionRankingAttrName) Sets the attribute name of the ranking factors for the predictions in the apply output data.
void	setTestMetricsName(java.lang.String testMetricsName) Sets the name of the test metrics to be created as the result of test metrics task.
VerificationReport	verify() Verifies if the settings are valid.

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

getActualTargetAttrName

public java.lang.String getActualTargetAttrName()

Returns the attribute name of the actual targets in the apply output data.

Returns:

String

getApplyOutputDataName

public java.lang.String getApplyOutputDataName()

Returns the name of the apply output data.

Returns:

String

getPredictedTargetAttrName

public java.lang.String getPredictedTargetAttrName()

Returns the attribute name of the predicted targets in the apply output data.

Returns:

String

getPredictionRankingAttrName

public java.lang.String getPredictionRankingAttrName()

Returns the attribute name of the ranking factors for the predictions in the apply output data.

Returns:

String

getTestMetricsName

public java.lang.String getTestMetricsName()

Returns the name of the test metrics to be created as the result of test metrics task.

Returns:

String

setActualTargetAttrName

public void setActualTargetAttrName(java.lang.String actualTargetAttrName)
                             throws JDMException

Sets the attribute name of the actual targets in the apply output data.

Parameters:

actualTargetAttrName -

Returns:

void

Throws:

JDMException

setApplyOutputDataName

public void setApplyOutputDataName(java.lang.String applyOutputData)
                            throws JDMException

Sets the name of the apply output data.

Parameters:

applyOutputData - The name of the apply output data.

Returns:

void

Throws:

JDMException

setPredictedTargetAttrName

public void setPredictedTargetAttrName(java.lang.String predictedTargetAttrName)
                                throws JDMException

Sets the attribute name of the predicted targets in the apply output data.

Parameters:

predictedTargetAttrName -

Returns:

void

Throws:

JDMException

setPredictionRankingAttrName

public void setPredictionRankingAttrName(java.lang.String predictionRankingAttrName)
                                  throws JDMException

Sets the attribute name of the ranking factors for the predictions in the apply output data.

Parameters:

predictionRankingAttrName -

Returns:

void

Throws:

JDMException

setTestMetricsName

public void setTestMetricsName(java.lang.String testMetricsName)
                        throws JDMException

Sets the name of the test metrics to be created as the result of test metrics task. The name cannot be null.

Parameters:

testMetricsName - The name of the test metrics.

Returns:

void

Throws:

JDMException

verify

public VerificationReport verify()

Verifies if the settings are valid. Returns null if the settings are valid. Returns otherwise an instance of VerificationReport that contains a vendor specific explanation.

Returns:

VerificationReport