Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.Taxonomy.HierarchyModel Class Reference

Inheritance diagram for kddml.Core.DataMining.Taxonomy.HierarchyModel:

kddml.Core.DataMining.MiningModel kddml.Core.DataMining.Taxonomy.HierarchyModelManager kddml.Core.KDDMLObject kddml.Core.DataMining.MiningModelManager kddml.Core.DataMining.MiningModelManager kddml.Core.HTMLTranslator List of all members.

Public Member Functions

KDDMLObjectType getType ()
boolean isEmpty ()
HierarchyNodeManager getNodeRoot ()
String getTaxonomyName ()
void saveToRepository () throws kddml.Core.KDDMLCoreException
HierarchyModel clone (java.io.File output_path)
String toString ()
void saveHTML () throws KDDMLCoreException
Iterator getLeaves ()
boolean removeNode (String node_name)
int getDimension ()
int getDepth ()
HierarchyNodeManager getNode (String node_name)

Detailed Description

The values of a categorical field can be organized in a hierarchy. The representation of hierarchies in PMML is based on parent/child relationships. A tabular format is used to provide the data for these relationships. A taxonomy is constructed from a sequence of one or more parent/child tables. In KDDML, the actual values are stored in the hierarchy object. So, the tabular data can also be part of the PMML document itself. The table would be recursive in the sense that a value in the parent column can also appear in the child column. An hierarchy model consists of two major parts:
  1. the hierarhcy name;
  2. the pointer to the hierarchy root.

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

KDDMLObjectType kddml.Core.DataMining.Taxonomy.HierarchyModel.getType  )  [virtual]
 

It returns the type of the object.

Returns:
KDDMLObjectType

Implements kddml.Core.KDDMLObject.

boolean kddml.Core.DataMining.Taxonomy.HierarchyModel.isEmpty  )  [virtual]
 

Returns true if the hierarhcy do not contain nodes.

Returns:
boolean

Implements kddml.Core.KDDMLObject.

HierarchyNodeManager kddml.Core.DataMining.Taxonomy.HierarchyModel.getNodeRoot  ) 
 

Returns the node root of this hierarchy. Returns null if the hierarchy is empty.

Returns:
HierarchyNodeManager

Implements kddml.Core.DataMining.Taxonomy.HierarchyModelManager.

String kddml.Core.DataMining.Taxonomy.HierarchyModel.getTaxonomyName  ) 
 

Returns the hierarchy name.

Returns:
String

Implements kddml.Core.DataMining.Taxonomy.HierarchyModelManager.

void kddml.Core.DataMining.Taxonomy.HierarchyModel.saveToRepository  )  throws kddml.Core.KDDMLCoreException [virtual]
 

Save the object in the system repository.

Exceptions:
AssociationModelException 
KDDMLCoreException 

Implements kddml.Core.KDDMLObject.

HierarchyModel kddml.Core.DataMining.Taxonomy.HierarchyModel.clone java.io.File  output_path  ) 
 

Clones this model returning a new hierarchy model as output.

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

Implements kddml.Core.DataMining.Taxonomy.HierarchyModelManager.

String kddml.Core.DataMining.Taxonomy.HierarchyModel.toString  ) 
 

Returns a representation of this object as string.

Returns:
String

Reimplemented from kddml.Core.DataMining.MiningModel.

void kddml.Core.DataMining.Taxonomy.HierarchyModel.saveHTML  )  throws KDDMLCoreException [virtual]
 

Save the object in the system repository as HTML document.

Exceptions:
KDDMLCoreException 

Implements kddml.Core.HTMLTranslator.

Iterator kddml.Core.DataMining.Taxonomy.HierarchyModel.getLeaves  ) 
 

Returns the list of leaves as iterator of HierarchyNodeManager.

Returns:
Iterator

Implements kddml.Core.DataMining.Taxonomy.HierarchyModelManager.

boolean kddml.Core.DataMining.Taxonomy.HierarchyModel.removeNode String  node_name  ) 
 

Removes an input node from the hierarchy. Returns false if the node do not exist or cannot be removed.

Parameters:
node_name String
Returns:
boolean

Implements kddml.Core.DataMining.Taxonomy.HierarchyModelManager.

int kddml.Core.DataMining.Taxonomy.HierarchyModel.getDimension  ) 
 

Returns the number of nodes of the hierarchy.

Returns:
int

Implements kddml.Core.DataMining.Taxonomy.HierarchyModelManager.

int kddml.Core.DataMining.Taxonomy.HierarchyModel.getDepth  ) 
 

Returns the number of level of the hierarchy.

Returns:
int

Implements kddml.Core.DataMining.Taxonomy.HierarchyModelManager.

HierarchyNodeManager kddml.Core.DataMining.Taxonomy.HierarchyModel.getNode String  node_name  ) 
 

Returns the hierarchy node given the node name. Returns null if the node do not exist.

Parameters:
node_name String
Returns:
HierarchyNodeManager

Implements kddml.Core.DataMining.Taxonomy.HierarchyModelManager.


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