Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.AssociationRules.Item Class Reference

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

kddml.Core.DataMining.AssociationRules.ItemManager List of all members.

Public Member Functions

 Item (String value)
 Item (String name, String value)
boolean equals (Object item)
String getName ()
String getValue ()
String getMappedValue ()
void setMappedValue (String mapped_value)
String toString ()
boolean isBoolean ()
boolean addFeature (ItemFeatureManager attr)
ItemFeatureManager getFeature (String name)
boolean isMissingFeature (String name)
Iterator getFeatures ()
boolean hasFeatures ()

Detailed Description

A class used to represent a single item in a transactional analysis. An item can be intra-attribute or boolean (with no value related to) or inter-attribute and it consists of three major parts:
  1. the item name;
  2. the item value for inter-attribute items only;
  3. a mapped value to which the original item value is mapped. For instance, this could be a product name if the original value is an EAN code.
Items can have additional features, such as the price or the quantity of a purchased product. Each feature is stored in a distinct Java object.


Constructor & Destructor Documentation

kddml.Core.DataMining.AssociationRules.Item.Item String  value  ) 
 

Constructor used for boolean or multivalue items. Multivalue item is a couple (item name, item value) separated by '=='; e.g. outlook == sunny where outlook is the item name and sunny is the item value.

Parameters:
value String

kddml.Core.DataMining.AssociationRules.Item.Item String  name,
String  value
 

Constructor used for inter-attribute items such as outlook=sunny.

Parameters:
name String
value String


Member Function Documentation

boolean kddml.Core.DataMining.AssociationRules.Item.equals Object  item  ) 
 

Tests if two items are equal. For boolean items, two items are equal if their names coincide. For inter-attributes items, two items are equal if their names and their values coincide.

Parameters:
item Object
Returns:
boolean

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

String kddml.Core.DataMining.AssociationRules.Item.getName  ) 
 

Returns the item name.

Returns:
String

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

String kddml.Core.DataMining.AssociationRules.Item.getValue  ) 
 

Returns the item value. Returns null if the method isBoolean() returns true.

Returns:
String

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

String kddml.Core.DataMining.AssociationRules.Item.getMappedValue  ) 
 

Returns the mapped value of the item. For instance, this could be a product name if the original value is an EAN code. Returns null if the item do not have a mapped value.

Returns:
String

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

void kddml.Core.DataMining.AssociationRules.Item.setMappedValue String  mapped_value  ) 
 

Sets the mapped value to the item.

Parameters:
mapped_value String

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

String kddml.Core.DataMining.AssociationRules.Item.toString  ) 
 

Returns a representation of this object as string.

Returns:
String

boolean kddml.Core.DataMining.AssociationRules.Item.isBoolean  ) 
 

Tests if an item has the field value (e.g. "outlook = sunny"). Returns true if the field value is not null.

Returns:
boolean

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

boolean kddml.Core.DataMining.AssociationRules.Item.addFeature ItemFeatureManager  attr  ) 
 

Adds a new feature to this item. Returns false if the item already contains this feature.

Parameters:
attr ItemFeatureManager
Returns:
boolean

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

ItemFeatureManager kddml.Core.DataMining.AssociationRules.Item.getFeature String  name  ) 
 

Returns the specified feature. Returns null if the feature do not exist.

Parameters:
name String the name of the wished feature (e.g. price, quantity).
Returns:
ItemFeatureManager

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

boolean kddml.Core.DataMining.AssociationRules.Item.isMissingFeature String  name  ) 
 

Returns true if the specified feature do not exist or if his value is missing.

Parameters:
name String
Returns:
boolean

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

Iterator kddml.Core.DataMining.AssociationRules.Item.getFeatures  ) 
 

Returns the list of features of the item.

Returns:
Iterator

Implements kddml.Core.DataMining.AssociationRules.ItemManager.

boolean kddml.Core.DataMining.AssociationRules.Item.hasFeatures  ) 
 

Tests if this item has some features associated.

Returns:
boolean

Implements kddml.Core.DataMining.AssociationRules.ItemManager.


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