javax.datamining.attributeimportance
Interface AttributeImportanceModel

All Superinterfaces:

MiningObject, Model

public interface AttributeImportanceModel

extends Model

AttributeImportanceModel contains the metadata resulting from a model build using AttributeImportanceSettings. Attributes are assigned a rank, with rank 1 being the most important. Attributes also have an importance value which can be used as the wieght of the attribute for model building. Attribute importance value can be found in the model signature.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, Model

Method Summary

int	getAttributeCount() Returns the number of attributes ranked in the model.
java.util.Collection	getAttributesByPercentage(double percent, SortOrder ordering) Returns a collection of attributes whose rank is within the specified percentage of the entire attributes.
java.util.Collection	getAttributesByRank(int lowerRank, int upperRank) Returns a collection of attributes whose rank is within the specified range.
java.util.Collection	getAttributesByRank(SortOrder ordering) Returns a collection of all attributes in the specified order.
int	getMaxRank() Returns the rank number of the least important attribute.

Methods inherited from interface javax.datamining.base.Model

getApplicationName, getAttributeStatistics, getBuildDuration, getBuildSettings, getEffectiveBuildSettings, getMajorVersion, getMiningAlgorithm, getMiningFunction, getMinorVersion, getModelDetail, getProviderName, getProviderVersion, getSignature, getTaskIdentifier, getUniqueIdentifier, getVersion

Methods inherited from interface javax.datamining.MiningObject

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

Method Detail

getAttributeCount

public int getAttributeCount()

Returns the number of attributes ranked in the model. The returned value must be non-negative.

Returns:

int

getAttributesByPercentage

public java.util.Collection getAttributesByPercentage(double percent,
                                                      SortOrder ordering)
                                               throws JDMException

Returns a collection of attributes whose rank is within the specified percentage of the entire attributes. If ordering is descending, the most important attributes are returned. If ascending, the least important attributes are returned.

Percent is a number between 0 and 100. Ordering cannot be null.

If no attributes are returned, the Collection is empty (not null).

Parameters:

percent - The percentage of the attributes contained in the model to be returned.

ordering - The ordering that specifies where the retrieval starts. If ascending, the n most important attributes (ranks 1 to n) are returned where n is the number of attributes computed by percent. If descending, the n least important attributes among the attributes contained in the model are returned.

Returns:

Collection

Throws:

JDMException

getAttributesByRank

public java.util.Collection getAttributesByRank(int lowerRank,
                                                int upperRank)
                                         throws JDMException

Returns a collection of attributes whose rank is within the specified range. The size of the returned set may be greater than (upperRank-lowerRank+1) if there are several attributes with the same importance value.

Attributes are ranked from 1 (most important) to N (least important).

lowerRank and upperRank must be positive and lowerRank must be less than upperRank.

If no attributes are returned, the returned Collection is empty (but not null).

Parameters:

lowerRank - The left margin of the range that specifies the highest rank of the range.

upperRank - The right margin of the range that specifies the lowest rank of the range. This value must be greater than lowerRank.

Returns:

Collection

Throws:

JDMException

getAttributesByRank

public java.util.Collection getAttributesByRank(SortOrder ordering)
                                         throws JDMException

Returns a collection of all attributes in the specified order. If ordering is descending, the most important attributes are returned first. If ascending, the least important attributes are returned first.

If no attributes are returned, the Collection is empty (not null).

Parameters:

ordering - The ordering that specifies where the retrieval starts. If ascending, the n most important attributes (ranks 1 to n) are returned where n is numberOfAttributes. If descending, the n least important attributes among the attributes contained in the model are returned.

Returns:

Collection

Throws:

JDMException

getMaxRank

public int getMaxRank()

Returns the rank number of the least important attribute. This number may be less than the attribute count if multiple attributes were assigned the same rank.

Returns:

int