IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.beans.infomining
Class CMBSummarizationService

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

public class CMBSummarizationService
extends CMBTextAnalysisBean

The CMBSummarizationService is a non-visual bean that can be used to determine summaries for documents.

   Properties and Events Overview:

   pre-conditions         open server connection
   properties (default)   maxLength (3)
                          ratio (0.1)
                          mode (LESS_THAN_MAXLENGTH_MODE)
                          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

Field Summary
static int EQUALS_RATIO_BUT_AT_MOST_MAXLENGTH_MODE
          return at least (ratio * total number of sentences), but at most maxLength many sentences.
static int EQUALS_RATIO_MODE
          return exactly (ratio * total number of sentences) many sentences.
static int LESS_THAN_MAXLENGTH_MODE
          return at most maxLength many sentences.
 
Constructor Summary
CMBSummarizationService()
          Creates a new CMBSummarizationService.
 
Method Summary
 int getMaxLength()
          Returns the current maximal number of sentences in a summary.
 int getMode()
          Returns the current summarizarion mode (see public fields).
 float getRatio()
          Returns the current sentence ratio.
 void setMaxLength(int maxLength)
          Sets the maximal number of sentences in a summary.
 void setMode(int mode)
          Sets the summarizarion mode (see public fields).
 void setRatio(float ratio)
          Sets the sentence ratio.
 
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
 

Field Detail

LESS_THAN_MAXLENGTH_MODE

public static final int LESS_THAN_MAXLENGTH_MODE
return at most maxLength many sentences.

EQUALS_RATIO_MODE

public static final int EQUALS_RATIO_MODE
return exactly (ratio * total number of sentences) many sentences.

EQUALS_RATIO_BUT_AT_MOST_MAXLENGTH_MODE

public static final int EQUALS_RATIO_BUT_AT_MOST_MAXLENGTH_MODE
return at least (ratio * total number of sentences), but at most maxLength many sentences.
Constructor Detail

CMBSummarizationService

public CMBSummarizationService()
Creates a new CMBSummarizationService.
Method Detail

setMaxLength

public void setMaxLength(int maxLength)
Sets the maximal number of sentences in a summary.
Parameters:
maxLength - the maximal number of sentences.
See Also:
getMaxLength(), setMode(int)

getMaxLength

public int getMaxLength()
Returns the current maximal number of sentences in a summary.
Returns:
the current maximal number of sentences.
See Also:
setMaxLength(int)

setRatio

public void setRatio(float ratio)
Sets the sentence ratio.
See Also:
getRatio(), setMode(int)

getRatio

public float getRatio()
Returns the current sentence ratio.
Returns:
the current sentence ratio.
See Also:
setRatio(float)

setMode

public void setMode(int mode)
Sets the summarizarion mode (see public fields).
Parameters:
the - new mode.
See Also:
getMode()

getMode

public int getMode()
Returns the current summarizarion mode (see public fields).
Returns:
the current summarizarion mode (see public fields).
See Also:
setMode(int)


IBM Information Integrator for Content V8.2 APIs

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