IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.beans.infomining
Class CMBClusteringService

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.CMBClusteringService
All Implemented Interfaces:
com.ibm.mm.beans.CMBConnectionReplyListener, CMBTextAnalysisRequestListener, java.util.EventListener, java.io.Serializable

public class CMBClusteringService
extends CMBTextAnalysisBean

The CMBClusteringService is a non-visual bean that can be used to group documents to clusters according to the similarity of their content.

   Properties and Events Overview:

   pre-conditions         open server connection
   properties (default)   clusterFeatureCount (1)
                          maxClusterCount (20)
                          minClusterCount (1)
                          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
CMBClusteringService()
          Creates a new CMBClusteringService.
 
Method Summary
 void analyze(java.util.Vector itemVector)
          Adds a document to the set of documents to be clustered.
 CMBClusterResult cluster()
          Clusters all documents sent to analyze(Vector).
 int getClusterFeatureCount()
          Returns the number of cluster features to be returned.
 int getMaxClusterCount()
          Returns the maximum number of clusters to be returned.
 int getMinClusterCount()
          Returns the minimum number of clusters to be returned.
 void setClusterFeatureCount(int clusterFeatureCount)
          Sets the number of cluster features to be returned.
 void setMaxClusterCount(int maxClusterCount)
          Sets the maximum number of clusters to be returned during the analysis of an item.
 void setMinClusterCount(int minClusterCount)
          Sets the minimum number of clusters to be returned during the analysis of an item.
 
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

CMBClusteringService

public CMBClusteringService()
Creates a new CMBClusteringService.
Method Detail

setMinClusterCount

public void setMinClusterCount(int minClusterCount)
Sets the minimum number of clusters to be returned during the analysis of an item.
Parameters:
minClusterCount - the minimal number of clusters to be returned
See Also:
getMinClusterCount()

setMaxClusterCount

public void setMaxClusterCount(int maxClusterCount)
Sets the maximum number of clusters to be returned during the analysis of an item. A value 0 means all the clusters are shown.
Parameters:
maxClusterCount - the maximal number of clusters to be returned
See Also:
getMaxClusterCount()

getMinClusterCount

public int getMinClusterCount()
Returns the minimum number of clusters to be returned.
Returns:
minimum number of clusters to be returned
See Also:
setMinClusterCount(int)

getMaxClusterCount

public int getMaxClusterCount()
Returns the maximum number of clusters to be returned.
Returns:
maximum number of clusters to be returned
See Also:
setMaxClusterCount(int)

setClusterFeatureCount

public void setClusterFeatureCount(int clusterFeatureCount)
Sets the number of cluster features to be returned. A value 0 means all the cluster features are shown
Parameters:
clusterFeatureCount - the number of cluster features to be returned
See Also:
getClusterFeatureCount()

getClusterFeatureCount

public int getClusterFeatureCount()
Returns the number of cluster features to be returned.
Returns:
the number of cluster features to be returned
See Also:
setClusterFeatureCount(int)

cluster

public CMBClusterResult cluster()
                         throws CMBClusteringException
Clusters all documents sent to analyze(Vector).
Throws:
CMBClusteringException - if an error occured while processing the documents.

analyze

public void analyze(java.util.Vector itemVector)
             throws CMBInvalidTypeException,
                    CMBNoSuchKeyException
Adds a document to the set of documents to be clustered.
Throws:
CMBInvalidTypeException - if the content read from the record is of the wrong type
CMBNoSuchKeyException - if the wrong key is used to read the content from the record
CMBDocumentAlreadyAnalyzedException - if the document for the specified item has already been analyzed
CMBInvalidLanguageCodeException - if a wrong language code is read from the record
CMBUnsupportedLanguageException - if the language specified in the record is not supported
CMBDocumentProcessingException - if an error occured while processing the document for the item
See Also:
cluster()


IBM Information Integrator for Content V8.2 APIs

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