IBM Information Integrator for Content V8.2 APIs

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

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.infomining.DKIKFCategory

public abstract class DKIKFCategory
extends java.lang.Object

A category represents a node in a taxonomy. A taxonomy is a tree of categories. The taxonomy of a catalog can be retrieved using its getTaxonomy() method. Only the category objects of such a taxonomy object provide the methods

Other category objects, e.g. categories retrieved using DKIKFCatalog.getCategoriesForRecord(String) or DKIKFCategorizationResult.getCategory(), also represent the categories of a catalog, but do not belong to a taxonomy object and thus do not provide the methods listed above. To get the appropriate category objects of a taxonomy object use DKIKFTaxonomy.getCategory(DKIKFCategory).


Constructor Summary
protected DKIKFCategory()
          Objects can be obtained from DKIKFTaxonomy and other objects.
 
Method Summary
abstract  DKIKFCategory[] getChildren()
          Returns all direct child categories if this category belongs to a taxonomy object.
abstract  java.lang.String getName()
          Returns the name of the category.
abstract  DKIKFCategory getParent()
          Returns the parent category if this category object belongs to a taxonomy object.
abstract  java.lang.String[] getPathAsArray()
          Returns the category path as an array of names if this category belongs to a taxonomy object.
abstract  java.lang.String getPathAsString()
          Returns the category path as a string of separated category names if this category belongs to a taxonomy object.
abstract  DKIKFTaxonomy getTaxonomy()
          Returns the taxonomy object this category belongs to or null if this object does not belong to a taxonomy object.
abstract  java.lang.String toString()
          Returns the String representation of this category.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DKIKFCategory

protected DKIKFCategory()
Objects can be obtained from DKIKFTaxonomy and other objects.
See Also:
DKIKFCatalog, DKIKFCategorizationResult
Method Detail

getName

public abstract java.lang.String getName()
Returns the name of the category.
Returns:
the category name

getParent

public abstract DKIKFCategory getParent()
Returns the parent category if this category object belongs to a taxonomy object.
Returns:
the parent category
Throws:
UnsupportedOperationException - if the category does not belong to a taxonomy object.
See Also:
getTaxonomy()

getChildren

public abstract DKIKFCategory[] getChildren()
Returns all direct child categories if this category belongs to a taxonomy object.
Returns:
the child cateogries
Throws:
UnsupportedOperationException - if the category does not belong to a taxonomy object.
See Also:
getTaxonomy()

getPathAsArray

public abstract java.lang.String[] getPathAsArray()
Returns the category path as an array of names if this category belongs to a taxonomy object. The array starts with the root category name.
Returns:
the category path array
Throws:
UnsupportedOperationException - if the category does not belong to a taxonomy object.
See Also:
getTaxonomy()

getPathAsString

public abstract java.lang.String getPathAsString()
Returns the category path as a string of separated category names if this category belongs to a taxonomy object. The separator set in the taxonomy is used.
Returns:
the category path string
Throws:
UnsupportedOperationException - if the category does not belong to a taxonomy object.
See Also:
getTaxonomy()

getTaxonomy

public abstract DKIKFTaxonomy getTaxonomy()
Returns the taxonomy object this category belongs to or null if this object does not belong to a taxonomy object.
Returns:
the taxonomy object or null if the category does not belong to a taxonomy object.
See Also:
DKIKFTaxonomy.getCategory(DKIKFCategory)

toString

public abstract java.lang.String toString()
Returns the String representation of this category.
Overrides:
toString in class java.lang.Object
Returns:
the separated path string or the category name if the category does not belong to a taxonomy object.
See Also:
getTaxonomy()

IBM Information Integrator for Content V8.2 APIs

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