Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKTextICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDataObjectBase
        |
        +--com.ibm.mm.sdk.common.dkDataObject
              |
              +--com.ibm.mm.sdk.common.DKDDOBase
                    |
                    +--com.ibm.mm.sdk.common.DKDDO
                          |
                          +--com.ibm.mm.sdk.common.dkResource
                                |
                                +--com.ibm.mm.sdk.common.DKLobICM
                                      |
                                      +--com.ibm.mm.sdk.common.DKTextICM
All Implemented Interfaces:
DKConstant, DKConstantICM, dkDataObjectBase, DKMessageId, DKMessageIdICM, dkXDO, dkXDOBase, com.ibm.mm.sdk.internal.PRMConstantICM, java.io.Serializable

public class DKTextICM
extends DKLobICM
implements java.io.Serializable

This class represents text resource objects stored in the Resource Manager configured for Content Manager. It inherits from a more generic resource class dkResource and DKLobICM.
A resource object consists of a content stored in a Resource Manager and the meta-data describing this content stored in the Library Server of Content Manager.
A text resource object can be made text searchable by creating a text index on the content of this text resource object.
There are some document properties important for text search:
CCSID :


Format : Language code : Text document model :
Important note: Notice that this class represents these four properties, CCSID, format, language code, and model, in each instance. Although these values are saved in the persistent store, they are for information only and optional. They are not really used for text indexing purposes now. Also, each instance may have different values. Currently, the text indexing process refers to the resource item type definition to get the value of the CCSID, format, language code, and the text document model. It is not using the values stored in each instance. Therefore, all resource item instances defined under the same resource item definition use these same values for building the text index. In the future, the implementation may change to actually enable text indexing to use values in each instance.
Content Manager text search supports search on words, terms, free text, with boolean operators AND and OR, search with wildcards, words within the same sentence or paragraph (or proximity search), and search on structured document. For more information on text search, refer to the section on Understanding the Query Language in the Application Programming Guide(APG), under the Working With Content Manager 8.1 in Java chapter.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.internal.PRMConstantICM
background, badrequest, BOUNDARYTAG, COLON, CONTENTTYPE, CRLF, DK_ICM_BLOBTABLE, DK_ICM_FSEXPORT, DK_ICM_FTPROOT, DK_ICM_HTTPROOT, DK_ICM_LBOS_AREA, DK_ICM_LBOS_DRIVE, DK_ICM_LBOS_SUBPATH, DK_ICM_NONNORMALMEDIA, DK_ICM_NORMALMEDIA, DK_ICM_RMVERSION, DK_ICM_STAGING_AREA, DK_ICM_STAGING_DRIVE, DK_ICM_STAGING_SUBPATH, DK_ICM_TABLECOLLECTION, DK_ICM_TABLECOLLECTIONNAME, DK_ICM_VOL_FREESPACE, DK_ICM_VOL_LOGICALNAME, DK_ICM_VOL_MOUNTPOINT, DK_ICM_VOL_PATH, DK_ICM_VOL_SIZE, DK_ICM_VOL_STATUS, DK_ICM_VOL_STATUS_ASSIGNED, DK_ICM_VOL_STATUS_OVERFLOW, DK_ICM_VOL_VOLUMEID, eoh, expire, FORMDATACOLLECTION, FORMDATAFILENAME, FORMDATAOBJNAME, FORMDATAORDER, FORMDATAREPTYPE, FORMDATARESNUM, FORMDATAVERSID, GBYTE, ICM_DEFAULTCOLLECTION, ICM_DEFAULTCOLLECTIONID, ICM_DEFAULTREPTYPE, ICM_RESOURCETYPE_BASE, ICM_RESOURCETYPE_CONTAINER, ICM_RESOURCETYPE_STREAM, ICM_RESOURCETYPE_TEXT, ICM_RESOURCETYPE_VIDEO, ICM_RESOURCETYPE_XML, ICMADMIN, ICMCACHE, ICMCACHERETRIEVE, ICMCATALOG, ICMCHANGESMS, ICMCHANGESMSINFO, ICMCREATE, ICMCREATEENTITY, ICMDEBUG, ICMDELETE, ICMDELETEENTITY, ICMENDTRANS, ICMFSEXPORT, ICMFTPEXPORT, ICMHTTPEXPORT, ICMIMPORTFROMFS, ICMIMPORTFROMWEB, ICMKEYFLUSH, ICMLIST, ICMLISTDEVMGR, ICMLISTMGTCLASSES, ICMLISTSMSINFO, ICMLISTSTGCLASSES, ICMLISTSTGGROUPS, ICMLISTVOLUMES, ICMMIDTIERCREATE, ICMMIDTIERDELETE, ICMMIDTIERRETRIEVE, ICMMIDTIERSTOREFROMASYNC, ICMMIDTIERSTOREFROMFTP, ICMMIDTIERUPDATE, ICMORDER, ICMPLAY, ICMQUERY, ICMQUERYENTITY, ICMREPLACE, ICMREPLACEFROM, ICMREPLACEFROMASYNC, ICMREPLICATE, ICMRETRIEVE, ICMRETRIEVEASYNC, ICMRETRIEVETO, ICMRETRIEVETOASYNC, ICMRETRIEVETOOLD, ICMRM_DELETE_FAILED, ICMRM_DELETE_OK, ICMRM_OPT_RETRIEVAL_ACTION, ICMRM_REPLACE_FAILED, ICMRM_REPLACE_OK, ICMRM_RETRIEVAL_GET_IT, ICMRM_RETRIEVAL_GET_IT_PREFETCH, ICMRM_RETRIEVAL_NO_MOUNT, ICMRM_RETRIEVAL_NO_MOUNT_PREFETCH, ICMRM_RETRIEVAL_STAGE_IT, ICMRM_RETRIEVAL_STAGE_IT_PREFETCH, ICMRM_RETRIEVE_FAILED, ICMRM_RETRIEVE_OK, ICMRM_STAGE_FAILED, ICMRM_STAGE_OK, ICMRM_STORE_FAILED, ICMRM_STORE_OK, ICMRM_UPDATE_FAILED, ICMRM_UPDATE_OK, ICMRMBITRATE, ICMRMCACHETYPE, ICMRMCOLLECTION, ICMRMCOMMIT, ICMRMCONTENTDISPOSITION, ICMRMCONTENTLENGTH, ICMRMCONTENTRANGE, ICMRMCONTENTTYPE, ICMRMCREATEDATE, ICMRMDURATION, ICMRMFILELENGTH, ICMRMFILELIST, ICMRMFILENAME, ICMRMFILEPATH, ICMRMFUNCTION, ICMRMGROUP, ICMRMHOSTNAME, ICMRMITEMID, ICMRMLIBNAME, ICMRMMODE, ICMRMNAME, ICMRMOBJNAME, ICMRMOFFLINE, ICMRMORDER, ICMRMPASSWORD, ICMRMPORT, ICMRMPROTOCOL, ICMRMRCLIST, ICMRMREFERENCEDATE, ICMRMREPTYPE, ICMRMRESNUM, ICMRMRETENTION, ICMRMROLLBACK, ICMRMSERVERPORT, ICMRMSTARTTIME, ICMRMSTOPTIME, ICMRMSTREAMMODE, ICMRMTARGETCOLLECTION, ICMRMTOKEN, ICMRMTXID, ICMRMUPDATEDATE, ICMRMURL, ICMRMUSER, ICMRMUSERID, ICMRMVERSID, ICMRMVERSION, ICMSMSLOGOFF, ICMSMSLOGON, ICMSTORE, ICMSTORECACHE, ICMSTOREFROM, ICMSTOREFROMASYNC, ICMSTOREFROMASYNCOLD, ICMSTOREFROMBROWSER, ICMSTOREFROMFTP, ICMSTOREFROMOLD, ICMSTOREFROMWEB, ICMSTREAMADMIN, ICMSTREAMDELIVERYSERVICES, ICMSTREAMIMPORTSERVICES, ICMTABLECOLLECTIONID, ICMUPDATE, ICMUPDATEENTITY, ICMUPDATEFROMBROWSER, ICMUPDATEFROMFS, ICMUPDATEFROMWEB, ICMVIEW, ID, KBYTE, MAXBLOBSIZE, MBYTE, METHOD_CONNECT, METHOD_COPY, METHOD_DELETE, METHOD_GET, METHOD_HEAD, METHOD_LOCK, METHOD_MKCOL, METHOD_MOVE, METHOD_OPTIONS, METHOD_POST, METHOD_PROPFIND, METHOD_PROPPATCH, METHOD_PUT, METHOD_TRACE, METHOD_UNLOCK, MIMETYPE, notfound, OBJARCHIVED, OBJDELETEPENDING, OBJDISCARDED, OBJSTAGED, OBJSTOREPENDING, OBJUPDATED, ok, SEMICOLON, TENMB, TENMEG, TWOMEG
 
Constructor Summary
DKTextICM()
          The default constructor for text resource objects.
DKTextICM(dkDatastore ds)
          Constructs a text resource object associated with the given datastore.
DKTextICM(dkDatastore ds, byte[] buf)
          Constructs a text resouce object associated with the datastore, then sets the initial content to the given byte array.
Caution: this constructor is only applicable for small objects.
DKTextICM(DKTextICM aDKTextICM)
          The copy constructor for this object.
 
Method Summary
 int getCCSID()
          Gets the Coded Character Set Identifier of this text object.
 java.lang.String getDefaultDocModel()
          Gets the text document model of this text object.
 java.lang.String getFormat()
          Gets the document format of this text object.
 java.lang.String getLanguageCode()
          Gets the language code of this text object.
 boolean getTextSearchableFlag()
          Gets the value of a flag to index the content of this object for text search.
 void setCCSID(int _ccsid)
          Sets the Coded Character Set Identifier for this text object.
 void setFormat(java.lang.String _format)
          Sets the document format for this text object.
 void setLanguageCode(java.lang.String _langCode)
          Sets the language code for this text object.
 void setModel(java.lang.String model)
          Sets the text document model for this text object.
 void setTextSearchableFlag(boolean tieFlag)
          Sets a flag to index the content of this object for text search.
 
Methods inherited from class com.ibm.mm.sdk.common.DKLobICM
add, add, add, add, add, add, addExtension, addFrom, addFrom, addFrom, addFromAsync, addFromAsync, addReplicaInfo, addReplicaInfo, addRMInfo, addURLInfo, catalogContent, changeSMSInfo, changeSMSInfo, changeStorage, compareData, copyData, del, del, equals, getAffiliatedType, getContent, getContentToClientFile, getContentURL, getContentURL, getCreatedTimestamp, getExtension, getHttpStoreMethod, getInputContentlength, getInputCreatedate, getInputFilelist, getInputFilename, getInputFilepath, getInputProtocol, getInputRetention, getInputStream, getItemId, getMimeType, getName, getNewVersion, getOpenHandler, getOption, getOrgFileName, getPartNumber, getReferencedTimestamp, getResourceName, getRMName, getSize, getSMSCollName, getThirdPartyHostname, getThirdPartyPassword, getThirdPartyPort, getThirdPartyStore, getThirdPartyUserid, getToken, getUpdateDate, getUpdatedTimestamp, getUser, getVersionNumber, isContentChanged, isNull, isOpenSynchronous, isSet, length, loadDataFromFile, open, open, querySMSInfo, removeExtension, retrieve, retrieve, retrieve, retrieve, retrieve, retrieveTo, retrieveToAsync, setAffiliatedType, setClassOpenHandler, setContent, setContentChanged, setContentFromClientFile, setDatastore, setExtension, setHttpStoreMethod, setInputContentlength, setInputCreatedate, setInputFilelist, setInputFilename, setInputFilepath, setInputProtocol, setInputRetention, setInstanceOpenHandler, setMimeType, setName, setNewVersion, setNull, setOption, setOrgFileName, setPartNumber, setResourceName, setRMName, setSemanticType, setSMSCollName, setThirdPartyHostname, setThirdPartyPassword, setThirdPartyPort, setThirdPartyStore, setThirdPartyUserid, setUpdateDate, size, update, update, update, update, update, update, updateFrom, updateFrom, updateFrom, updateFromAsync, updateFromAsync, updateFromAsync
 
Methods inherited from class com.ibm.mm.sdk.common.dkResource
cloneSkeleton, getClassName, getContentType, getRank, notEqual, protocol, setClassName, setContentType, setRank
 
Methods inherited from class com.ibm.mm.sdk.common.DKDDO
add, del, del, fromXML, fromXML, getDatastore, retrieve, toXML, update
 
Methods inherited from class com.ibm.mm.sdk.common.DKDDOBase
addData, addData, addData, addDataProperty, addDataProperty, addDataProperty, addProperty, addProperty, addProperty, dataCount, dataId, dataId, dataIdsByNameSpace, dataNameSpaceCount, dataPropertyCount, dataPropertyId, getData, getDataByName, getDataByName, getDataName, getDataNameSpace, getDataProperty, getDataPropertyByName, getDataPropertyByName, getDataPropertyByName, getDataPropertyName, getObjectType, getProperty, getPropertyByName, getPropertyName, isDataPropertySet, isDataSet, isNull, isPropertySet, propertyCount, propertyId, setData, setDataName, setDataName, setDataNameSpace, setDataProperty, setDataPropertyName, setNull, setObjectType, setProperty, setPropertyName, updatable
 
Methods inherited from class com.ibm.mm.sdk.common.dkDataObject
getPid, getPidObject, setPid, setPidObject
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDataObjectBase
getParent, getRootObject, setParent, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.dkXDO
datastore, getDatastore, getPid, getPidObject, setPid, setPidObject
 
Methods inherited from interface com.ibm.mm.sdk.common.dkDataObjectBase
getObjectType, getParent, getRootObject, setParent, setRootObject
 

Constructor Detail

DKTextICM

public DKTextICM()
          throws DKUsageError,
                 java.lang.Exception
The default constructor for text resource objects.
Throws:
DKUsageError - on errors.
java.lang.Exception - on errors.

DKTextICM

public DKTextICM(dkDatastore ds)
          throws DKUsageError,
                 java.lang.Exception
Constructs a text resource object associated with the given datastore.
Parameters:
ds - - the associated datastore, a DKDatastoreICM object.
Throws:
DKUsageError - on invalid datastore type.
java.lang.Exception - on errors.

DKTextICM

public DKTextICM(dkDatastore ds,
                 byte[] buf)
          throws DKException,
                 java.lang.Exception
Constructs a text resouce object associated with the datastore, then sets the initial content to the given byte array.
Caution: this constructor is only applicable for small objects.
Parameters:
ds - the associated datastore, a DKDatastoreICM object.
buf - the byte array as the initial content of the text resource.
Throws:
DKException - on errors.
java.lang.Exception - on errors.

DKTextICM

public DKTextICM(DKTextICM aDKTextICM)
          throws DKException,
                 java.lang.Exception
The copy constructor for this object.
Parameters:
aDKTextICM - an instance of DKTextICM to copy from.
Throws:
DKException - on errors.
java.lang.Exception - on errors.
Method Detail

setTextSearchableFlag

public void setTextSearchableFlag(boolean tieFlag)
Sets a flag to index the content of this object for text search. NOTE: Setting of this flag does not trigger the immediate indexing of this object, instead the object will get indexed the next time the indexing takes place.
Parameters:
tieFlag - true to index; false to not index.
See Also:
getTextSearchableFlag()

getTextSearchableFlag

public boolean getTextSearchableFlag()
Gets the value of a flag to index the content of this object for text search.
Returns:
boolean true if set; false otherwise.
See Also:
setTextSearchableFlag(boolean)

getCCSID

public int getCCSID()
Gets the Coded Character Set Identifier of this text object. The description of CCSID is given at the beginning of this class.
Returns:
the integer CCSID.

getLanguageCode

public java.lang.String getLanguageCode()
Gets the language code of this text object. The default language code is EN_US.
See Also:
setLanguageCode(java.lang.String)

getFormat

public java.lang.String getFormat()
Gets the document format of this text object. The description of document format and its usage is given at the beginning of this class.
Returns:
the document format; the default value is "TEXT", a flat ASCII text.
See Also:
setFormat(java.lang.String)

setCCSID

public void setCCSID(int _ccsid)
Sets the Coded Character Set Identifier for this text object. Specifying of the CCSID is for information only and optional. It is not really used for text indexing purposes at this time. The default is the CCSID of the underlying database engine.
Parameters:
ccsid - - an integer value of CCSID. For valid values of CCSID and its usage, refer to the documentation described in the beginning of this class.

setFormat

public void setFormat(java.lang.String _format)
Sets the document format for this text object. Specifying of the document format is for information only and optional. It is not really used for text indexing purposes at this time. The default is TEXT. The description of document format and its usage is given at the beginning of this class.
Parameters:
format - the document format - HTML, XML, TEXT, etc.

setLanguageCode

public void setLanguageCode(java.lang.String _langCode)
Sets the language code for this text object. Specifying of the language code is for information only and optional. It is not really used for text indexing purposes at this time. The default is EN_US. The description of language code and its usage is given at the beginning of this class.
Parameters:
langCode - the language code. The default is EN_US.

setModel

public void setModel(java.lang.String model)
              throws DKException
Sets the text document model for this text object. Specifying of the document model is for information only and optional. It is not really used for text indexing purposes at this time. This method is only relevant if you want to perform structured document search on the content of this text object. It is not applicable for flat ASCII documents.
The text format must be one of the structured document format, such as HTML, XML, or GPP. For more details, see the description and usage at the beginning of this class.
Parameters:
model - the document model.
Throws:
DKException - on errors.

getDefaultDocModel

public java.lang.String getDefaultDocModel()
                                    throws DKException
Gets the text document model of this text object. See setModel method for more information.
Returns:
the document model.
Throws:
DKException - on errors.
See Also:
setModel(java.lang.String)

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.