IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.sdk.common.infomining
Class DKIKFTaxonomy

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.infomining.DKIKFTaxonomy
All Implemented Interfaces:
java.io.Serializable

public abstract class DKIKFTaxonomy
extends java.lang.Object
implements java.io.Serializable

A taxonomy is a tree where every node is a category object.

See Also:
Serialized Form

Constructor Summary
protected DKIKFTaxonomy()
          objects can be obtained from DKIKFCatalog
 
Method Summary
abstract  boolean categoryExists(DKIKFCategory category)
          Checks if there is a category that represents the same category as the specified category.
abstract  boolean categoryExists(java.lang.String path)
          Checks if there is a category with the specified path.
abstract  boolean categoryExists(java.lang.String[] path)
          Checks if there is a category with the specified path, assuming the array starts with the name of the root category.
abstract  DKIKFCategory[] getCategories()
          Returns a list of all categories of the tree.
abstract  DKIKFCategory getCategory(DKIKFCategory category)
          Returns the category of this taxonomy that is equal to the category represented by the specified category.
abstract  DKIKFCategory getCategory(java.lang.String path)
          Returns the category with the specified path.
abstract  DKIKFCategory getCategory(java.lang.String[] path)
          Returns the category with the specified path.
abstract  DKIKFCategory getRootCategory()
          Returns the root of the tree.
abstract  char getSeparator()
          Returns the current separator string.
abstract  java.sql.Timestamp getTimestamp()
          Returns the timestamp of this taxonomy.
abstract  void setSeparator(char separator)
          Sets the character to be used to separate category names in path strings.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIKFTaxonomy

protected DKIKFTaxonomy()
objects can be obtained from DKIKFCatalog
Method Detail

getRootCategory

public abstract DKIKFCategory getRootCategory()
Returns the root of the tree.

getCategories

public abstract DKIKFCategory[] getCategories()
Returns a list of all categories of the tree.

getCategory

public abstract DKIKFCategory getCategory(java.lang.String path)
                                   throws DKIKFNoSuchCategoryException
Returns the category with the specified path. The current separator character is used to determine the category names.

getCategory

public abstract DKIKFCategory getCategory(java.lang.String[] path)
                                   throws DKIKFNoSuchCategoryException
Returns the category with the specified path.

getCategory

public abstract DKIKFCategory getCategory(DKIKFCategory category)
                                   throws DKIKFNoSuchCategoryException
Returns the category of this taxonomy that is equal to the category represented by the specified category.

categoryExists

public abstract boolean categoryExists(DKIKFCategory category)
Checks if there is a category that represents the same category as the specified category.

categoryExists

public abstract boolean categoryExists(java.lang.String path)
Checks if there is a category with the specified path. The current separator character is used to determine the category names.

categoryExists

public abstract boolean categoryExists(java.lang.String[] path)
Checks if there is a category with the specified path, assuming the array starts with the name of the root category.

setSeparator

public abstract void setSeparator(char separator)
Sets the character to be used to separate category names in path strings.

getSeparator

public abstract char getSeparator()
Returns the current separator string.

getTimestamp

public abstract java.sql.Timestamp getTimestamp()
Returns the timestamp of this taxonomy. You can check this timestamp against the catalog to make sure you still have to most recent version of the taxonomy.

IBM Information Integrator for Content V8.2 APIs

© Copyright International Business Machines Corporation 1996, 2003 IBM Corp. All rights reserved.