javax.datamining.attributeimportance
Interface AttributeImportanceSettings

All Superinterfaces:

BuildSettings, MiningObject

public interface AttributeImportanceSettings

extends BuildSettings

An AttributeImportanceSettings instance supports build settings specific to the attribute importance mining function.

If supervised, this identifies attributes most useful for building supervised models. If unsupervised, this identifies attributes most useful for building unsupervised models, such as clustering.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, BuildSettings

Method Summary

int	getMaxAttributeCount() Returns the maximum number of attributes to be contained in the resulting model.
java.lang.String	getTargetAttributeName() Returns the name of the target attribute.
boolean	isSupervised() Returns true if a target attribute has been set.
void	setMaxAttributeCount(int maxCount) Sets the maximum number of attributes to be contained in the resulting model.
void	setTargetAttributeName(java.lang.String targetAttrName) Sets the target attribute for supervised attribute importance.

Methods inherited from interface javax.datamining.base.BuildSettings

getAlgorithmSettings, getDesiredExecutionTimeInMinutes, getLogicalAttributes, getLogicalData, getLogicalDataName, getMiningFunction, getOutlierIdentification, getOutlierTreatment, getUsage, getWeight, getWeightAttribute, setAlgorithmSettings, setDesiredExecutionTimeInMinutes, setLogicalDataName, setOutlierIdentification, setOutlierTreatment, setUsage, setWeight, setWeightAttribute, verify

Methods inherited from interface javax.datamining.MiningObject

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

Method Detail

getMaxAttributeCount

public int getMaxAttributeCount()

Returns the maximum number of attributes to be contained in the resulting model.

Returns:

int

getTargetAttributeName

public java.lang.String getTargetAttributeName()

Returns the name of the target attribute.

Returns:

String

isSupervised

public boolean isSupervised()

Returns true if a target attribute has been set. Returns false otherwise.

Returns:

boolean

setMaxAttributeCount

public void setMaxAttributeCount(int maxCount)

Sets the maximum number of attributes to be contained in the resulting model. If attributes have the same importance, they are arbitrarily cut off past the maximum.

The specified count must be a positive integer.

Parameters:

maxCount -

Returns:

void

setTargetAttributeName

public void setTargetAttributeName(java.lang.String targetAttrName)
                            throws JDMException

Sets the target attribute for supervised attribute importance. By setting a non-null attribute name, the attribute importance becomes supervised.

Parameters:

targetAttrName - The name of the target attributes.

Returns:

void

Throws:

JDMException