oracle.dmt.odm.transformation
Class CategoryGroup

java.lang.Object
  |
  +--oracle.dmt.odm.transformation.CategoryGroup

public class CategoryGroup
extends java.lang.Object

An instance of class CategoryGroup allows grouping of similar categories. A valid category group must have at least one category in it. The group identifier ( bin number) must be > 0. CategoryGroup is used to specify the categorical discretization of a categorical mining attribute to build a mining model.


Constructor Summary
CategoryGroup(int id, java.lang.String displayName)
          Creates a category group with the specified group ID and list of categories.
CategoryGroup(int id, java.lang.String displayName, Category[] categories)
          Creates a category group with the specified group ID and list of categories.
 
Method Summary
TypeMethod
 void addCategory(Category cat)
          Adds a category to this group.
 Category[] getCategories()
          Returns the list (array) of categories belonging to this group.
 java.lang.String getDisplayName()
          Returns the group display name.
 int getGroupID()
          Returns the group identifier.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CategoryGroup

public CategoryGroup(int id,
                     java.lang.String displayName)
              throws InvalidArgumentException
Creates a category group with the specified group ID and list of categories. A valid category group must have at least one category in it.
Parameters:
id - Category group ID
displayName - Category group name (display name)

CategoryGroup

public CategoryGroup(int id,
                     java.lang.String displayName,
                     Category[] categories)
              throws InvalidArgumentException
Creates a category group with the specified group ID and list of categories. A valid category group must have at least one category in it.
Parameters:
id - Category group ID
displayName - Category group (display) name
categories - List array) of categories in the group
Throws:
InvalidArgumentException -  
Method Detail

addCategory

public void addCategory(Category cat)
                 throws InvalidArgumentException
Adds a category to this group.
Parameters:
cat - Category object; it cannot be null.
Returns:
void
Throws:
InvalidArgumentException - Thrown when the category is null

getGroupID

public int getGroupID()
Returns the group identifier.
Returns:
int group ID

getDisplayName

public java.lang.String getDisplayName()
Returns the group display name.
Returns:
String Display name.

getCategories

public Category[] getCategories()
Returns the list (array) of categories belonging to this group.
Returns:
Category[] List of categories.