IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.beans.infomining
Class CMBCategorizationService

java.lang.Object
  |
  +--com.ibm.mm.beans.infomining.CMBInfoMiningBean
        |
        +--com.ibm.mm.beans.infomining.CMBConnectedMiningBean
              |
              +--com.ibm.mm.beans.infomining.CMBTextAnalysisBean
                    |
                    +--com.ibm.mm.beans.infomining.CMBCategorizationService
All Implemented Interfaces:
com.ibm.mm.beans.CMBConnectionReplyListener, CMBTextAnalysisRequestListener, java.util.EventListener, java.io.Serializable

public class CMBCategorizationService
extends CMBTextAnalysisBean

The CMBCategorizationService is a non-visual bean that can be used to determine document categories.

The analysis is done using the training results of the specified catalog.

   Properties and Events Overview:

   pre-conditions         open server connection
   properties (default)   catalogName ("")
                          maxResults (1)
                          minConfidence (0.0)
                          categorySeparator ('/')
                          resultListSeparator (',')
                          traceEnabled (false)
   bound properties       none
   constrained properties none
   event target for       CMBTextAnalysisRequestEvent
                          CMBConnectionReplyEvent
   event source for       CMBExceptionEvent
                          CMBTraceEvent
                          CMBTextAnalysisReplyEvent
                          CMBTextAnalysisRequestEvent
                          CMBStoreRecordRequestEvent
 

See Also:
Serialized Form

Constructor Summary
CMBCategorizationService()
          Constructs a new CMBCategorizationService.
 
Method Summary
 java.lang.String getCatalogName()
          Returns the current catalog name.
 char getCategorySeparator()
          Returns the character that is used to separate category names.
 int getMaxResults()
          Returns the current maximum number of categories to be returned during the analysis of an item.
 float getMinConfidence()
          Returns the current minimum confidence.
 char getResultListSeparator()
          Returns the character that is used to separate category paths in the record.
 void setCatalogName(java.lang.String catalogName)
          Sets the name of the catalog to be used.
 void setCategorySeparator(char separator)
          Sets the character to be used to separated category names.
 void setMaxResults(int maxResults)
          Sets the maximum number of categories to be returned during the analysis of an item.
 void setMinConfidence(float minConfidence)
          Sets the minimum confidence.
 void setResultListSeparator(char separator)
          Sets the character to be used to separated category paths in the record.
 
Methods inherited from class com.ibm.mm.beans.infomining.CMBTextAnalysisBean
addCMBStoreRecordRequestListener, addCMBTextAnalysisReplyListener, addCMBTextAnalysisRequestListener, finalize, onCMBTextAnalysisRequest, removeCMBStoreRecordRequestListener, removeCMBTextAnalysisReplyListener, removeCMBTextAnalysisRequestListener
 
Methods inherited from class com.ibm.mm.beans.infomining.CMBConnectedMiningBean
getConnection, isConnected, onCMBConnectionReply, setConnection, validateConnection
 
Methods inherited from class com.ibm.mm.beans.infomining.CMBInfoMiningBean
addCMBExceptionListener, addCMBTraceListener, isTraceEnabled, removeCMBExceptionListener, removeCMBTraceListener, setTraceEnabled
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBCategorizationService

public CMBCategorizationService()
Constructs a new CMBCategorizationService.
Method Detail

setCatalogName

public void setCatalogName(java.lang.String catalogName)
Sets the name of the catalog to be used.
Parameters:
catalogName - the catalog name.
See Also:
getCatalogName()

getCatalogName

public java.lang.String getCatalogName()
Returns the current catalog name.
Returns:
the catalog name.
See Also:
setCatalogName(String)

setMinConfidence

public void setMinConfidence(float minConfidence)
Sets the minimum confidence. The value specifies how big the confidence level of a determined category at least must be before it is returned.
Parameters:
minConfidence - a value between 0.0 and 1.0
See Also:
getMinConfidence()

getMinConfidence

public float getMinConfidence()
Returns the current minimum confidence.
Returns:
the current minimum confidence.
See Also:
setMinConfidence(float)

setMaxResults

public void setMaxResults(int maxResults)
Sets the maximum number of categories to be returned during the analysis of an item. A value 0 means all categories are shown.
Parameters:
maxResults - the number of categories to be returned
See Also:
getMaxResults()

getMaxResults

public int getMaxResults()
Returns the current maximum number of categories to be returned during the analysis of an item.
Returns:
the current maximum number of categories to be returned.
See Also:
setMaxResults(int)

setResultListSeparator

public void setResultListSeparator(char separator)
Sets the character to be used to separated category paths in the record.
Parameters:
separator - the character to be used as separator
See Also:
getResultListSeparator()

getResultListSeparator

public char getResultListSeparator()
Returns the character that is used to separate category paths in the record.
Returns:
the current path separator character
See Also:
setResultListSeparator(char)

setCategorySeparator

public void setCategorySeparator(char separator)
Sets the character to be used to separated category names.
Parameters:
spearator - the character to be used to separate category names
See Also:
getCategorySeparator()

getCategorySeparator

public char getCategorySeparator()
Returns the character that is used to separate category names.
Returns:
the category name separator
See Also:
setCategorySeparator(char)


IBM Information Integrator for Content V8.2 APIs

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