javax.datamining.association
Interface AssociationModel

All Superinterfaces:

MiningObject, Model

public interface AssociationModel

extends Model

An AssociationModel object contains the metadata, such as itemsets, rules, resulting from a model built using AssociationSettings.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, Model

Method Summary

java.lang.Double	getAverageTransactionSize() Returns the average number of items in the transactions in the build data used when building the model.
java.util.Collection	getItems() Returns a collection of all items used to build the model that can be used to sequentially fetch items that occur in at least one rule in the model.
java.util.Collection	getItemsets() Returns a collection of all itemsets found that can be used to sequentially fetch the itemsets that occur in at least one rule in the model.
java.util.Collection	getItemsets(int itemsetSize) Constructs and returns a collection of the itemsets of the specified size that allows sequential inspection of the generated itemsets of the given size.
int	getMaxAbsoluteSupport() Returns the maximum support value of the rules contained in the model.
java.lang.Double	getMaxConfidence() Returns the maximum confidence value of the rules contained in the model.
int	getMaxRuleLength() Returns the largest rule length in terms of the number of items.
int	getMaxTransactionSize() Returns the number of items in the largest transaction in the build data used when building the model.
int	getMinAbsoluteSupport() Returns the minimum support value of the rules contained in the model.
java.lang.Double	getMinConfidence() Returns the minimum confidence value of the rules contained in the model.
int	getNumberOfItems() Returns the number of distinct items in the build data used when building the model.
int	getNumberOfItemsets() Returns the number of itemsets whose support values are equal to or exceed the support threshold specified in the AssociationRulesSettings used when building the model.
long	getNumberOfTransactions() Returns the number of transactions used to build the model.
java.util.Collection	getRules() Constructs and returns a collection of all rules in the model that allows sequential inspection of the generated rules.
java.util.Collection	getRules(RulesFilter filter) Constructs and returns a collection of the rules in the model that are filtered by the specified filter.

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

getAverageTransactionSize

public java.lang.Double getAverageTransactionSize()

Returns the average number of items in the transactions in the build data used when building the model. The returned number must be a positive number and less than the number returned from getMaxTransactionSize.

Returns:

Double

getItems

public java.util.Collection getItems()
                              throws JDMException

Returns a collection of all items used to build the model that can be used to sequentially fetch items that occur in at least one rule in the model.

Returns:

Collection

Throws:

JDMException

getItemsets

public java.util.Collection getItemsets()
                                 throws JDMException

Returns a collection of all itemsets found that can be used to sequentially fetch the itemsets that occur in at least one rule in the model. The support values of the itemsets equal or exceed the support threshold specified in the AssociationRulesSettings used when building the model.

Returns:

Collection

Throws:

JDMException

getItemsets

public java.util.Collection getItemsets(int itemsetSize)
                                 throws JDMException

Constructs and returns a collection of the itemsets of the specified size that allows sequential inspection of the generated itemsets of the given size. Size is the number of items in the itemsets.

Parameters:

itemsetSize - The size of the itemsets to be retrieved.

Returns:

Collection

Throws:

JDMException

getMaxAbsoluteSupport

public int getMaxAbsoluteSupport()

Returns the maximum support value of the rules contained in the model. The returned number must be a positive number, but less than the number returned from getNumberOfTransactions and greater or equal to the number returned from getMinAbsoluteSupport.

Returns:

int

getMaxConfidence

public java.lang.Double getMaxConfidence()

Returns the maximum confidence value of the rules contained in the model. The returned number must be a positive number, but greater than or equal to the minimum confidence specified via setMinimumConfidence method in AssociationSettings and less than or equal to 1.

Returns:

Double

getMaxRuleLength

public int getMaxRuleLength()

Returns the largest rule length in terms of the number of items. The returned number must be greater than 1.

Returns:

int

getMaxTransactionSize

public int getMaxTransactionSize()

Returns the number of items in the largest transaction in the build data used when building the model. The returned number must be a positive integer.

Returns:

int

getMinAbsoluteSupport

public int getMinAbsoluteSupport()

Returns the minimum support value of the rules contained in the model. The returned number must be a positive number, but less than the number returned from getNumberOfTransactions.

Returns:

int

getMinConfidence

public java.lang.Double getMinConfidence()

Returns the minimum confidence value of the rules contained in the model. The returned number must be a positive number, but greater than or equal to the minimum confidence specified via setMinimumConfidence method in AssociationSettings and less than or equal to 1.

Returns:

Double

getNumberOfItems

public int getNumberOfItems()

Returns the number of distinct items in the build data used when building the model. The returned number must be a positive integer.

Returns:

int

getNumberOfItemsets

public int getNumberOfItemsets()

Returns the number of itemsets whose support values are equal to or exceed the support threshold specified in the AssociationRulesSettings used when building the model. The returned number must be a non-negative integer.

Returns:

int

getNumberOfTransactions

public long getNumberOfTransactions()

Returns the number of transactions used to build the model. The returned number must be a positive integer.

Returns:

long

getRules

public java.util.Collection getRules()
                              throws JDMException

Constructs and returns a collection of all rules in the model that allows sequential inspection of the generated rules. The rules are not necessarily sorted in any order.

Returns:

Collection

Throws:

JDMException

getRules

public java.util.Collection getRules(RulesFilter filter)
                              throws JDMException

Constructs and returns a collection of the rules in the model that are filtered by the specified filter. The rules are sorted according to the ordering specification given in the filter, if any.

Parameters:

filter - A specification for filtering rules.

Returns:

Collection

Throws:

JDMException