IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.sdk.common.infomining
Class DKIKFTextDocument

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.infomining.DKIKFTextDocument
All Implemented Interfaces:
java.io.Serializable

public abstract class DKIKFTextDocument
extends java.lang.Object
implements java.io.Serializable

Represents the textual content of an arbitrary document.

See Also:
Serialized Form

Constructor Summary
DKIKFTextDocument()
           
 
Method Summary
static DKIKFTextDocument create(java.lang.String content)
          Creates a new text document with the specified content.
static DKIKFTextDocument create(java.lang.String content, java.lang.String name)
          Creates a new text document with the specified content and a name.
static DKIKFTextDocument create(java.lang.String content, java.lang.String name, java.lang.String language)
          Creates a new text document with the specified content and a name.
abstract  java.lang.String getContent()
          Returns the content of the document.
abstract  java.lang.String getLanguage()
          get the language code of this document.
abstract  java.lang.String getName()
          get the name of this document.
abstract  void setLanguage(java.lang.String language)
          set the language of this document.
abstract  void setName(java.lang.String name)
          set the name of this document.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIKFTextDocument

public DKIKFTextDocument()
Method Detail

create

public static DKIKFTextDocument create(java.lang.String content)
Creates a new text document with the specified content.

create

public static DKIKFTextDocument create(java.lang.String content,
                                       java.lang.String name)
Creates a new text document with the specified content and a name.

create

public static DKIKFTextDocument create(java.lang.String content,
                                       java.lang.String name,
                                       java.lang.String language)
                                throws DKIKFInvalidLanguageCodeException
Creates a new text document with the specified content and a name.

getContent

public abstract java.lang.String getContent()
Returns the content of the document.

setLanguage

public abstract void setLanguage(java.lang.String language)
                          throws DKIKFInvalidLanguageCodeException
set the language of this document. The language codes look as follows: _ or just where is a lowercase string and is an uppercase string, e.g. "en_US", "de_CH", or "de, "ja".

getLanguage

public abstract java.lang.String getLanguage()
get the language code of this document. The language codes look as follows: _ or just where is a lowercase string and is an uppercase string, e.g. "en_US", "de_CH", or "de, "ja".

setName

public abstract void setName(java.lang.String name)
set the name of this document.

getName

public abstract java.lang.String getName()
get the name of this document.

IBM Information Integrator for Content V8.2 APIs

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