javax.datamining.task.apply
Interface ApplySettings

All Superinterfaces:

MiningObject

All Known Subinterfaces:

ClassificationApplySettings, ClusteringApplySettings, RegressionApplySettings

public interface ApplySettings

extends MiningObject

ApplySettings captures a specification that describes the output of an apply task.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject

Method Summary

java.util.Map	getSourceDestinationMap() Returns the attribute map for apply input data.
void	resetMapping() Resets the mapping done by ranks, individual categories, top prediction, or all predictions.
void	setSourceDestinationMap(java.util.Map sourceDestinationMap) Specifies a mapping between input physical attribute names to destination attribute names.
VerificationReport	verify() Verifies if the content of the ApplyOutput is valid.

Methods inherited from interface javax.datamining.MiningObject

getCreationDate, getCreatorInfo, getDescription, getName, getObjectIdentifier, getObjectType, setDescription

Method Detail

getSourceDestinationMap

public java.util.Map getSourceDestinationMap()

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

Returns:

Map

resetMapping

public void resetMapping()

Resets the mapping done by ranks, individual categories, top prediction, or all predictions.

Returns:

void

setSourceDestinationMap

public void setSourceDestinationMap(java.util.Map sourceDestinationMap)
                             throws JDMException

Specifies a mapping between input physical attribute names to destination attribute names. The key for the mapping is the physical attribute name. Values will be copied from the input attributes to the mapped destination attributes.

Parameters:

sourceDestinationMap - A map that contains the mapping between input physical attribute names and destination attribute names to appear in the apply output.

Returns:

void

Throws:

JDMException

verify

public VerificationReport verify()

Verifies if the content of the ApplyOutput is valid. Returns null if the content is valid. The returned VerificationReport object contains vendor-specific explanation as why the content is invalid otherwise.

Returns:

VerificationReport