javax.datamining.data
Interface ModelSignature

public interface ModelSignature

ModelSignature consists of a set of signature attributes, each of which captures the name and type of each attribute used to build the corresponding model. The model signature may contain fewer attributes than specified in the logical data used to build the model. For example, a decision tree model may have used only a subset of the logical attributes due to feature selection resulting from model building.

Note that for supervised models, which specify a target attribute, this target is not part of the model signature. The target attribute is obtained from a SupervisedModel.

Author:

JSR-73 Java Data Mining Expert Group

Method Summary

SignatureAttribute	getAttribute(java.lang.String attributeName) Returns the SignatureAttribute instance with the specified name present in the model signature.
java.util.Collection	getAttributes() Returns a collection of SignatureAttribute instances present in the model signature.
java.util.Collection	getAttributesByRank(SortOrder ordering) Returns a collection of all attributes in the specified order.

Method Detail

getAttribute

public SignatureAttribute getAttribute(java.lang.String attributeName)
                                throws JDMException

Returns the SignatureAttribute instance with the specified name present in the model signature.

Parameters:

attributeName - The name of the attribute whose signature is to be returned.

Returns:

SignatureAttribute

Throws:

JDMException

getAttributes

public java.util.Collection getAttributes()
                                   throws JDMException

Returns a collection of SignatureAttribute instances present in the model signature.

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 ranking is available for the attributes, this method returns an empty collection and the values returned for getRank and getImportanceValue in SignatureAttribute are undefined.

Parameters:

ordering -

Returns:

Collection

Throws:

JDMException