Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.AssociationRules.AssociationModelManager Interface Reference

Inheritance diagram for kddml.Core.DataMining.AssociationRules.AssociationModelManager:

kddml.Core.DataMining.MiningModelManager kddml.Core.DataMining.AssociationRules.AssociationModel List of all members.

Public Member Functions

abstract boolean addRule (AssociationRuleManager rule)
abstract void addRules (AssociationRuleManager[] rules_array)
abstract boolean removeRule (AssociationRuleManager rule, boolean rebuild_itemsets)
abstract void removeRules (AssociationRuleManager[] rules_array, boolean rebuild_itemsets)
abstract boolean removeItemset (ItemsetManager itemset)
abstract void removeItemsets (ItemsetManager[] itemsets_array)
abstract boolean contains (ItemsetManager itemset)
abstract boolean contains (AssociationRuleManager rule)
boolean contains (ItemManager item)
abstract Iterator getItems ()
abstract Iterator getItemsets ()
abstract Iterator getAssociationRules ()
abstract double getMinSupport ()
abstract double getMinConfidence ()
abstract int getNumberOfTransactions ()
abstract int getNumberOfItems ()
abstract int getNumberOfItemsets ()
abstract int getNumberOfRules ()
abstract Double getAverageTransactionSize ()
void setMaxTransactionSize (int max_number_of_items_per_TA)
abstract Integer getMaxTransactionSize ()
void setAvgTransactionSize (double avg_number_of_items_per_TA)
abstract boolean isBoolean ()
abstract Object rdaToInstances () throws AssociationModelException
abstract Object itemsetsToInstances () throws AssociationModelException
AssociationModel clone (java.io.File output_path)

Detailed Description

A manager interface for an association model.

Title: KDDML

Description: Knowledge Discovery in Database Environment

Copyright: Copyright (c) 2003-2005

Company: Universita' di Pisa - Dipartimento di Informatica

Author:
Andrea Romei (romei@di.unipi.it)
Version:
2.0.16


Member Function Documentation

abstract boolean kddml.Core.DataMining.AssociationRules.AssociationModelManager.addRule AssociationRuleManager  rule  )  [pure virtual]
 

Adds a new association rule to this model. Returns true if the rule has been added. Returns false if the model already contains the rule.

Parameters:
rule AssociationRuleManager the association rule to add to the model.
Returns:
boolean true if the rule do not exist in the model, false otherwise.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract void kddml.Core.DataMining.AssociationRules.AssociationModelManager.addRules AssociationRuleManager[]  rules_array  )  [pure virtual]
 

Adds a set of association rules to this model.

Parameters:
rules_array AssociationRuleManager[] a set of association rules to add to the model

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract boolean kddml.Core.DataMining.AssociationRules.AssociationModelManager.removeRule AssociationRuleManager  rule,
boolean  rebuild_itemsets
[pure virtual]
 

Remove a rule from the model. If rebuild_itemsets is true, then the frequent itemsets are computed from the new set of association rules. Otherwise, itemsets will not change. Returns true if and only if the rule has been removed from the model.

Parameters:
rule AssociationRuleManager the association rule to remove from the model.
rebuild_itemsets boolean if true computes the frequent itemsets from association rules.
Returns:
boolean false if the rule is not removed.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract void kddml.Core.DataMining.AssociationRules.AssociationModelManager.removeRules AssociationRuleManager[]  rules_array,
boolean  rebuild_itemsets
[pure virtual]
 

Removes a set of association rules from the list of rules. If rebuild_itemsets is true, then the frequent itemsets are computed from the new set of association rules. Otherwise, itemsets will not change.

Parameters:
rules_array AssociationRuleManager[] a set of association rules to add to the model
rebuild_itemsets boolean

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract boolean kddml.Core.DataMining.AssociationRules.AssociationModelManager.removeItemset ItemsetManager  itemset  )  [pure virtual]
 

Removes a frequent itemset from the model. Also removes from the model the association rules referred by the itemset. Returns true if and only if the itemset has been removed from the model.

Parameters:
itemset ItemsetManager the itemset to be removed.
Returns:
boolean

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract void kddml.Core.DataMining.AssociationRules.AssociationModelManager.removeItemsets ItemsetManager[]  itemsets_array  )  [pure virtual]
 

Removes a set of frequent itemsets from the model. Also removes from the model the association rules referred by the itemsets.

Parameters:
itemsets_array ItemsetManager[] a list of itemsets.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract boolean kddml.Core.DataMining.AssociationRules.AssociationModelManager.contains ItemsetManager  itemset  )  [pure virtual]
 

Tests if the model contains an input itemset.

Parameters:
itemset ItemsetManager
Returns:
boolean true if the model contains the itemset.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract boolean kddml.Core.DataMining.AssociationRules.AssociationModelManager.contains AssociationRuleManager  rule  )  [pure virtual]
 

Tests if the model contains an input association rule.

Parameters:
rule AssociationRuleManager
Returns:
boolean true if the model contains the association rule.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

boolean kddml.Core.DataMining.AssociationRules.AssociationModelManager.contains ItemManager  item  ) 
 

Tests if the model contains an item.

Parameters:
item ItemManager
Returns:
boolean true if the model contains the item.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract Iterator kddml.Core.DataMining.AssociationRules.AssociationModelManager.getItems  )  [pure virtual]
 

Returns the list of items belonging to the model.

Returns:
Iterator the list of items.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract Iterator kddml.Core.DataMining.AssociationRules.AssociationModelManager.getItemsets  )  [pure virtual]
 

Returns the list of itemsets belonging to the model.

Returns:
Iterator the list of itemsets.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract Iterator kddml.Core.DataMining.AssociationRules.AssociationModelManager.getAssociationRules  )  [pure virtual]
 

Returns the list of association rules belonging to the model.

Returns:
Iterator the list of association rules.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract double kddml.Core.DataMining.AssociationRules.AssociationModelManager.getMinSupport  )  [pure virtual]
 

Returns the minimum support of rules.

Returns:
double

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract double kddml.Core.DataMining.AssociationRules.AssociationModelManager.getMinConfidence  )  [pure virtual]
 

Returns the minimum confidence of rules.

Returns:
double

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract int kddml.Core.DataMining.AssociationRules.AssociationModelManager.getNumberOfTransactions  )  [pure virtual]
 

Returns the number of transactions used to build the model.

Returns:
int

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract int kddml.Core.DataMining.AssociationRules.AssociationModelManager.getNumberOfItems  )  [pure virtual]
 

Returns the number of items.

Returns:
int

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract int kddml.Core.DataMining.AssociationRules.AssociationModelManager.getNumberOfItemsets  )  [pure virtual]
 

Returns the number of itemsets.

Returns:
int

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract int kddml.Core.DataMining.AssociationRules.AssociationModelManager.getNumberOfRules  )  [pure virtual]
 

Returns the number of rules.

Returns:
int

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract Double kddml.Core.DataMining.AssociationRules.AssociationModelManager.getAverageTransactionSize  )  [pure virtual]
 

Returns the average number of items in the transactions contained in the input data used to build the model.

Returns:
Double

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

void kddml.Core.DataMining.AssociationRules.AssociationModelManager.setMaxTransactionSize int  max_number_of_items_per_TA  ) 
 

Sets the maximum number of items in the transactions contained in the input data used to build the model.

Parameters:
max_number_of_items_per_TA int

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract Integer kddml.Core.DataMining.AssociationRules.AssociationModelManager.getMaxTransactionSize  )  [pure virtual]
 

Returns the maximum number of items in the transactions contained in the input data used to build the model.

Returns:
Integer

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

void kddml.Core.DataMining.AssociationRules.AssociationModelManager.setAvgTransactionSize double  avg_number_of_items_per_TA  ) 
 

Sets the average number of items in the transactions contained in the input data used to build the model.

Parameters:
avg_number_of_items_per_TA double

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract boolean kddml.Core.DataMining.AssociationRules.AssociationModelManager.isBoolean  )  [pure virtual]
 

Returns true if the model contains boolean association rules. Boolean association rules (or intra-attribute rules) have the form:

spaghetti, tomato --> parmesan.
Returns false if the model contains inter-attribute rules, such as

carType = racing, homeInsurance = false --> married = yes.

Returns:
boolean true if the rules is an intra-attribute rules. False otherwise.

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract Object kddml.Core.DataMining.AssociationRules.AssociationModelManager.rdaToInstances  )  throws AssociationModelException [pure virtual]
 

Returns a representation of the rules contained in the model as set of instances. The number of instances is equal to the number of association rules. The list of attributes is reported below:

  1. the items of the body as string in comma separated format (attribute body);
  2. the items of the head as string in comma separated format (attribute head);
  3. the body cardinality (attribute body_cardinality);
  4. the head cardinality (attribute head_cardinality);
  5. the support of the rule (attribute support);
  6. the confidence of the rule (attribute confidence).

Returns:
Object the set of instances as generic object.
Exceptions:
AssociationModelException 

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

abstract Object kddml.Core.DataMining.AssociationRules.AssociationModelManager.itemsetsToInstances  )  throws AssociationModelException [pure virtual]
 

Returns a representation of the itemsets contained in the model as set of instances. The number of instances is equal to the number of itemsets. The list of attributes is reported below:

  1. the items belonging to the itemset as string in comma separated format (attribute itemset);
  2. the itemset cardinalty (attribute itemset_cardinality);
  3. the itemset support (attribute itemset_support).

Returns:
Object the set of instances as generic object.
Exceptions:
AssociationModelException 

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.

AssociationModel kddml.Core.DataMining.AssociationRules.AssociationModelManager.clone java.io.File  output_path  ) 
 

Clones this model returning a new association model as output.

Parameters:
output_path File the path in the model system repository containing the cloned model
Returns:
AssociationModel

Implemented in kddml.Core.DataMining.AssociationRules.AssociationModel.


Generated on Thu Feb 23 13:04:38 2006 for kddml by  doxygen 1.4.3