IBM Information Integrator for Content V8.2 APIs

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

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

public class DKIKFSummarizer
extends java.lang.Object

A summarizer can be used to create summaries for documents.


Field Summary
static int MODE_EQUALS_RATIO
          return exactly (ratio * total number of sentences) many sentences.
static int MODE_EQUALS_RATIO_AND_LESS_THAN_MAXLENGTH
          return at least (ratio * total number of sentences), but at most maxLength many sentences.
static int MODE_LESS_THAN_MAXLENGTH
          return at most maxLength many sentences.
 
Constructor Summary
DKIKFSummarizer(DKIKFService ikfService)
          Creates a new summarizer object.
 
Method Summary
 DKIKFSummarizationResult analyze(DKIKFTextDocument doc)
          summarizes doc.
 int getMaxLength()
          get maximal number of sentences in summary.
 int getMode()
          get summarizarion mode (see public fields).
 float getRatio()
          get sentence ratio.
 DKIKFService getService()
          Returns the current service.
 void setMaxLength(int maxLength)
          set maximal number of sentences in summary.
 void setMode(int mode)
          set summarization mode (see public fields).
 void setRatio(float ratio)
          set sentence ratio.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODE_LESS_THAN_MAXLENGTH

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

MODE_EQUALS_RATIO

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

MODE_EQUALS_RATIO_AND_LESS_THAN_MAXLENGTH

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

DKIKFSummarizer

public DKIKFSummarizer(DKIKFService ikfService)
Creates a new summarizer object.
Method Detail

getService

public DKIKFService getService()
Returns the current service.

getMaxLength

public int getMaxLength()
get maximal number of sentences in summary.

getRatio

public float getRatio()
get sentence ratio.

getMode

public int getMode()
get summarizarion mode (see public fields).

setMaxLength

public void setMaxLength(int maxLength)
set maximal number of sentences in summary.

setRatio

public void setRatio(float ratio)
set sentence ratio.

setMode

public void setMode(int mode)
set summarization mode (see public fields).

analyze

public DKIKFSummarizationResult analyze(DKIKFTextDocument doc)
                                 throws DKIKFUnsupportedLanguageException,
                                        DKIKFDocumentProcessingException
summarizes doc.
Throws:
DKIKFDocumentLanguageNotSetException - if the sepecified document has no language
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 privilege IKFRunAnalysisFunc

IBM Information Integrator for Content V8.2 APIs

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