javax.datamining.association
Interface AssociationSettings

All Superinterfaces:

BuildSettings, MiningObject

public interface AssociationSettings

extends BuildSettings

An AssociationSettings instance supports build settings specific to the association mining function.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, BuildSettings

Method Summary

void	addItem(java.lang.Object item, boolean included) Adds a new item to the list of items to be excluded from (if included is false) or included in (if true) the frequent itemset building.
void	addItems(java.lang.Object[] itemArray, boolean included) Adds an array of items to the list of items to be excluded from (if included is false) or included in (if true) the frequent itemset building.
java.lang.Object[]	getItems(boolean included) Returns the items to be included from the itemset discovery process if true, returns the items to be excluded if false.
int	getMaxNumberOfRules() Returns the maximum number of rules allowed in the model.
int	getMaxRuleComponentLength(boolean isAntecedent) Returns the maximum number of items in a rule component.
int	getMaxRuleLength() Returns the maximum number of items in a rule.
java.lang.Double	getMinConfidence() Returns the minimum confidence threshold of generated association rules.
java.lang.Double	getMinSupport() Returns the minimum support of itemsets.
java.lang.String	getTaxonomyName(java.lang.String attributeName) Returns the name of the Taxonomy object to be used for the specified attribute.
void	removeItem(java.lang.Object item, boolean included) Removes an item from the list of items to be excluded from (if included is false) or included in (if true) the frequent itemset building.
void	removeItems(java.lang.Object[] itemArray, boolean included) Removes an array of items from the list of items to be excluded from (if included is false or included in (if true) the frequent itemset building.
void	setMaxNumberOfRules(int maxRules) Sets the maximum number of rules to be included in the model.
void	setMaxRuleComponentLength(int maxLength, boolean isAntecedent) Sets the maximum number of items in a rule component.
void	setMaxRuleLength(int maxRuleLength) Sets the maximum number of items that can be present in a rule.
void	setMinConfidence(double minConfidence) Sets the minimum confidence allowed for any generated rule.
void	setMinSupport(double minSupport) Sets the minimum support of an itemset.
void	setTaxonomyName(java.lang.String attributeName, java.lang.String taxonomyName) Sets the name of a Taxonomy to be used for the specified attribute.

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

addItem

public void addItem(java.lang.Object item,
                    boolean included)
             throws JDMException

Adds a new item to the list of items to be excluded from (if included is false) or included in (if true) the frequent itemset building. The excluded item will not appear in the itemsets to be found.

If an item is added as both included and excluded, an exception is thrown.

Parameters:

item - An item to be excluded/included from consideration during model building.

included - A flag to indicate that the item is added to the included items (if true) or excluded items (if false).

Returns:

void

Throws:

JDMException

addItems

public void addItems(java.lang.Object[] itemArray,
                     boolean included)
              throws JDMException

Adds an array of items to the list of items to be excluded from (if included is false) or included in (if true) the frequent itemset building. The excluded items will not appear in the itemsets to be found.

If an item is added as both included and excluded, an exception is thrown.

Parameters:

itemArray - An array of items to be excluded from or included in consideration during model building.

included - A flag to indicate that the items are added to the included items (if true) or excluded items (if false).

Returns:

void

Throws:

JDMException

getItems

public java.lang.Object[] getItems(boolean included)

Returns the items to be included from the itemset discovery process if true, returns the items to be excluded if false.

Parameters:

included - A flag to indicate whether items to be included (if true) or excluded (if false) are to be returned.

Returns:

Object[]

getMaxNumberOfRules

public int getMaxNumberOfRules()

Returns the maximum number of rules allowed in the model.

Returns:

int

getMaxRuleComponentLength

public int getMaxRuleComponentLength(boolean isAntecedent)

Returns the maximum number of items in a rule component. Returns the maximum number of items for antecedents if isAntecedent is true. Otherwise, returns the maximum number of items for consequents.

Parameters:

isAntecedent - A flag to indicate whether the antecedent (if true) or consequent (if false) is to be limited.

Returns:

int

getMaxRuleLength

public int getMaxRuleLength()

Returns the maximum number of items in a rule.

Returns:

int

getMinConfidence

public java.lang.Double getMinConfidence()

Returns the minimum confidence threshold of generated association rules. The confidence is the support for the combined itemsets, antecedent plus consequent, divided by the support for the antecedent.

Returns:

Double

getMinSupport

public java.lang.Double getMinSupport()

Returns the minimum support of itemsets. The support is defined as the ratio of the number of transactions that contain the itemset to the all transactions.

Returns:

Double

getTaxonomyName

public java.lang.String getTaxonomyName(java.lang.String attributeName)
                                 throws JDMException

Returns the name of the Taxonomy object to be used for the specified attribute.

Parameters:

attributeName - The name of the attribute.

Returns:

String

Throws:

JDMException

removeItem

public void removeItem(java.lang.Object item,
                       boolean included)

Removes an item from the list of items to be excluded from (if included is false) or included in (if true) the frequent itemset building.

Parameters:

item - An item to be removed from the excluded/included items.

included - A flag to indicate that the item is removed from the included items (if true) or excluded items (if false).

Returns:

void

removeItems

public void removeItems(java.lang.Object[] itemArray,
                        boolean included)

Removes an array of items from the list of items to be excluded from (if included is false or included in (if true) the frequent itemset building.

Parameters:

itemArray - An array of items to be removed from the excluded/included items.

included - A flag to indicate that the items are removed from the included items (if true) or excluded items (if false).

Returns:

void

setMaxNumberOfRules

public void setMaxNumberOfRules(int maxRules)

Sets the maximum number of rules to be included in the model. The number must be a positive integer.

Parameters:

maxRules - The maximum number of rules to be found.

Returns:

void

setMaxRuleComponentLength

public void setMaxRuleComponentLength(int maxLength,
                                      boolean isAntecedent)

Sets the maximum number of items in a rule component. If isAntecedent is true, this method sets the maximum number of items in antecedents. Otherwise, it sets the maximum number of items in consequents. The number must be a positive integer.

Parameters:

maxLength - The maximum number of items for antecedent or consequent in the rules.

isAntecedent - A flag to indicate whether the antecedent (if true) or consequent (if false) is to be limited.

Returns:

void

setMaxRuleLength

public void setMaxRuleLength(int maxRuleLength)

Sets the maximum number of items that can be present in a rule. The number must be greater than or equal to 2.

Parameters:

maxRuleLength - The maximum rule length in terms of the number of items.

Returns:

void

setMinConfidence

public void setMinConfidence(double minConfidence)

Sets the minimum confidence allowed for any generated rule. Confidence must be between 0 and 1, noted as (0,1] where 1 is included.

Parameters:

minConfidence - The minimum confidence of the association rules to be found.

Returns:

void

setMinSupport

public void setMinSupport(double minSupport)

Sets the minimum support of an itemset. Support is the ratio of the number of transactions that contain the itemset to the all transactions. Support must be between 0 and 1, noted as (0,1] where 1 is included.

Parameters:

minSupport - The minimum support of the association rules to be found.

Returns:

void

setTaxonomyName

public void setTaxonomyName(java.lang.String attributeName,
                            java.lang.String taxonomyName)
                     throws JDMException

Sets the name of a Taxonomy to be used for the specified attribute.

Parameters:

attributeName - The name of the attribute for which the taxonomy is to be used.

taxonomyName - The name of the taxonomy.

Returns:

void

Throws:

JDMException