|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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 :
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.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.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 |
public DKTextICM() throws DKUsageError, java.lang.Exception
DKUsageError
- on errors.java.lang.Exception
- on errors.public DKTextICM(dkDatastore ds) throws DKUsageError, java.lang.Exception
ds
- - the associated datastore, a DKDatastoreICM object.DKUsageError
- on invalid datastore type.java.lang.Exception
- on errors.public DKTextICM(dkDatastore ds, byte[] buf) throws DKException, java.lang.Exception
ds
- the associated datastore, a DKDatastoreICM object.buf
- the byte array as the initial content of the text resource.DKException
- on errors.java.lang.Exception
- on errors.public DKTextICM(DKTextICM aDKTextICM) throws DKException, java.lang.Exception
aDKTextICM
- an instance of DKTextICM to copy from.DKException
- on errors.java.lang.Exception
- on errors.Method Detail |
public void setTextSearchableFlag(boolean tieFlag)
tieFlag
- true to index; false to not index.getTextSearchableFlag()
public boolean getTextSearchableFlag()
setTextSearchableFlag(boolean)
public int getCCSID()
public java.lang.String getLanguageCode()
setLanguageCode(java.lang.String)
public java.lang.String getFormat()
setFormat(java.lang.String)
public void setCCSID(int _ccsid)
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.public void setFormat(java.lang.String _format)
format
- the document format - HTML, XML, TEXT, etc.public void setLanguageCode(java.lang.String _langCode)
langCode
- the language code. The default is EN_US.public void setModel(java.lang.String model) throws DKException
model
- the document model.DKException
- on errors.public java.lang.String getDefaultDocModel() throws DKException
DKException
- on errors.setModel(java.lang.String)
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |