IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.sdk.common.infomining.analysis
Class DKIKFCategorizer

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

public class DKIKFCategorizer
extends java.lang.Object

A categorizer determines categories for documents.


Constructor Summary
DKIKFCategorizer(DKIKFCatalog catalog)
          Creates a new categorizer object that works on the specified catalog.
 
Method Summary
 DKIKFCategorizationResult[] analyze(DKIKFTextDocument doc)
          categorizes doc.
 DKIKFCatalog getCatalog()
          Returns the current catalog.
 int getMaxResults()
          Returns the maximum number of results.
 float getMinConfidence()
          Returns the minimum confidence.
 void setMaxResults(int maxResults)
          Set the maximum number of results to be returned.
 void setMinConfidence(float minConfidence)
          Sets the minimum confidence.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIKFCategorizer

public DKIKFCategorizer(DKIKFCatalog catalog)
Creates a new categorizer object that works on the specified catalog.
Method Detail

getCatalog

public DKIKFCatalog getCatalog()
Returns the current catalog.

setMaxResults

public void setMaxResults(int maxResults)
Set the maximum number of results to be returned.

getMaxResults

public int getMaxResults()
Returns the maximum number of results.

setMinConfidence

public void setMinConfidence(float minConfidence)
Sets the minimum confidence.

getMinConfidence

public float getMinConfidence()
Returns the minimum confidence.

analyze

public DKIKFCategorizationResult[] analyze(DKIKFTextDocument doc)
                                    throws DKIKFNoSuchCatalogException,
                                           DKIKFCatalogNotTrainedException,
                                           DKIKFUnsupportedLanguageException,
                                           DKIKFDocumentProcessingException
categorizes doc. The result list is sorted starting with the best matching category.
Throws:
DKIKFNoSuchCatalogException - if the catalog doesn't exist in the library
DKIKFDocumentLanguageNotSetException - if the sepecified document has no language
DKIKFCatalogNotTrainedException - if the has not been trained
DKIKFUnsupportedLanguageException - if the document language is not supported
DKIKFDocumentProcessingException - if an error occours durin processing
DKIKFAuthorizationException - if the user or group does not have the privileges IKFRetrieveCatalog and IKFRunAnalysisFunc

IBM Information Integrator for Content V8.2 APIs

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