|
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.dkAbstractXDO | +--com.ibm.mm.sdk.common.dkClob | +--com.ibm.mm.sdk.common.DKClobDL
DKClobDL: a clob (XDO) represents a part object of DL. This class will be removed, please use DKBlobDL.
Field Summary | |
static short |
APPEND
|
static short |
NOOVERWRITE
|
static short |
OVERWRITE
|
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.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKClobDL(DKClobDL aDKClobDL)
Deprecated. This class will be removed, please use DKBlobDL |
|
DKClobDL(dkDatastore aDatastore)
Deprecated. This class will be removed, please use DKBlobDL |
|
DKClobDL(dkDatastore aDatastore,
byte[] aByteArr)
Deprecated. This class will be removed, please use DKBlobDL |
Method Summary | |
void |
add()
Adds the object content from memory to the datastore |
void |
add(java.lang.String aFullFileName)
Adds the object content from existing file to the datastore |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Add the extension object. |
void |
changeStorage()
Changes the system-managed storage (SMS) criteria for an object. |
boolean |
compareData(dkXDO adkXDO)
Compares the content of this object with the content of the other XDO object |
DKClobDL |
concatenate(byte[] aByteArr)
Deprecated. not really needed |
DKClobDL |
concatenate(DKClobDL aDKClobDL)
Deprecated. not really needed |
dkClob |
concatReplace(byte[] aByteArr)
Deprecated. no need to do this, no meaning |
dkClob |
concatReplace(dkClob adkClob)
Deprecated. no need to do this, no meaning |
void |
copyData(dkXDO adkXDO)
Replaces the content of this object with the content of the other XDO object |
void |
del()
Deletes the object content from datastore |
void |
del(boolean flush)
Deletes the object content from datastore |
void |
deletingValue()
Deprecated. no meaning for Digital Library |
boolean |
equals(dkXDOBase adkXDOBase)
Deprecated. no need to do this, no meaning |
DKAnnotation |
getAffiliatedData()
Deprecated. Replace by getExtension(String extensionName) |
int |
getAffiliatedType()
Gets the affiliated type of the object if DK_ANNOTATION, the getExtension("DKAnnotationDL") should point to DKAnnotationDL |
byte[] |
getContent()
Gets the content of this object |
int |
getContentClass()
Gets the content class of the object |
void |
getContentToClientFile(java.lang.String afileName,
int fileOption)
Copies the lob data of this object to the given file |
java.lang.String |
getCreatedTimestamp()
Gets the data & time that the object was created |
dkExtension |
getExtension(java.lang.String extensionName)
Gets the extension object. |
boolean |
getIndexFlag()
Deprecated. Replace by isCategoryOf(..) method of this class |
java.lang.String |
getObjectType()
Gets the object type. |
java.lang.String |
getOpenHandler()
Gets the current program name of the handler for this object instance |
java.lang.Object |
getOption(int option)
Gets the delete or retrieval option to perform the delete or retrieve action. |
DKPid |
getPid()
Deprecated. Replace by getPidObject() |
DKPid |
getPidObject()
Gets a copy of the persistent ID object of this object |
int |
getRank()
Gets the ranking value of a query |
java.lang.String |
getRepType()
Gets the DL representation type of the object content |
int |
getRetrievalAction()
Deprecated. Replace by getOption(int option) |
java.lang.String |
getSearchEngine()
Deprecated. Replace by DKSearchEngineInfoDL.getSearchEngine() |
java.lang.String |
getSearchIndex()
Deprecated. Replace by DKSearchEngineInfoDL.getSearchIndex() |
java.lang.String |
getSearchInfo()
Deprecated. Replace by DKSearchEngineInfoDL.getSearchInfo() |
int |
getSize()
Gets the size of this object without retrieve object content. |
java.lang.String |
getUpdatedTimestamp()
Gets the data & time that the object was updated |
int |
indexOf(dkClob adkClob,
int startpos)
Deprecated. no need to do this, no meaning |
int |
indexOf(java.lang.String astring,
int startpos)
Deprecated. no need to do this, no meaning |
dkClob |
insert(dkClob adkClob,
int startpos)
Deprecated. no need to do this, no meaning |
dkClob |
insert(java.lang.String astring,
int startpos)
Deprecated. no need to do this, no meaning |
boolean |
isCategoryOf(int categoryName)
Check the object category. |
boolean |
isContentChanged()
Checks if the part content changed (in memory). |
boolean |
isNull()
Checks if the part content is null (in memory). |
boolean |
isOpenSynchronous()
Gets the current synchronization property |
boolean |
isSet()
Checks if the part content is set (in memory). |
int |
length()
Gets the length of this object content in memory |
java.lang.String |
mimeType()
Gets the MIME type represents this object's contentClass |
boolean |
notEqual(dkXDOBase adkXDOBase)
Deprecated. no need to do this, no meaning |
void |
open()
Unloads the object content to a client file with a system generated name and then synchronously invoking a default handler against the file. |
void |
open(java.lang.String afileName)
Unloads the object content to a file afileName provided by the application and then synchronously invoking a default handler against the file. |
int |
partId()
Gets the part id of this XDO |
dkClob |
remove(int startpos,
int alength)
Deprecated. no need to do this, no meaning |
void |
removeExtension(java.lang.String extensionName)
Remove the extension object. |
void |
retrieve()
Retrieves the object content from the datastore to the memory buffer |
void |
retrieve(java.lang.String aFileName)
Retrieves the object content from the datastore to a file name |
int |
retrieveObjectState(int object)
Retrieve the state of search indexed object or media object. |
void |
setAffiliatedData(DKAnnotation apAData)
Deprecated. Replace by setExtension(..) |
void |
setAffiliatedType(int aAType)
Sets the affiliated type of the object |
void |
setClassOpenHandler(java.lang.String ahandler,
boolean newSynchronousFlag)
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object class |
void |
setContent(byte[] aByteArray)
Sets the content of this object with a byte array stream argument |
void |
setContentClass(int aCClass)
Sets the content class of the object |
void |
setContentFromClientFile(java.lang.String afileName)
Replaces the lob data of this object with the contents of the file afileName |
void |
setExtension(java.lang.String extensionName,
dkExtension extensionObj)
Sets the extension object. |
void |
setIndexFlag(boolean aFlag)
Deprecated. no need to use this |
void |
setInstanceOpenHandler(java.lang.String ahandler,
boolean newSynchronousFlag)
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object instant |
void |
setNull()
Sets the part content to null (in memory). |
void |
setOption(int option,
java.lang.Object value)
Sets the delete or retrieval option to perform the delete or retrieve action. |
void |
setPid(DKPid aDKPid)
Deprecated. Replace by setPidObject(DKPid aPidXDO) |
void |
setPidObject(DKPid aPidXDO)
Sets the pid information of this object with the new provided pid |
void |
setRank(int aRank)
Sets the ranking value of a query |
void |
setRepType(java.lang.String aRType)
Sets the DL representation type of the object content |
void |
setRetrievalAction(int aRetriveAction)
Deprecated. Replace by setOption(int option, Object value) |
void |
setSearchEngine(java.lang.String aSearchEngine)
Deprecated. Replace by DKSearchEngineInfoDL.setSearchEngine(..) |
void |
setSearchIndex(java.lang.String aSearchIndex)
Deprecated. Replace by DKSearchEngineInfoDL.setSearchIndex(..) |
void |
setSearchInfo(java.lang.String aSearchInfo)
Deprecated. Replace by DKSearchEngineInfoDL.setSearchInfo(..) |
void |
setToBeIndexed()
Indexes an existing part object by search engine |
DKClobDL |
subLob(int startpos,
int alength)
Deprecated. not really needed |
java.lang.String |
subString(int startpos,
int alength)
Deprecated. no need to do this, no meaning |
void |
update()
Updates the object content in datastore with the content in memory |
void |
update(java.lang.String aFileName)
Updates the object content in datastore with a file |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractXDO |
cloneSkeleton, datastore, getClassName, getContentType, getDatastore, getMimeType, getParent, getRootObject, protocol, setClassName, setContentType, setDatastore, setMimeType, setParent, setRootObject, size |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final short OVERWRITE
public static final short NOOVERWRITE
public static final short APPEND
Constructor Detail |
public DKClobDL(dkDatastore aDatastore) throws DKUsageError, java.lang.Exception
aDatastore
- a DKDatastoreDL representing the associated DL datastoreDKUsageError,
- Exception If invalid datastore typepublic DKClobDL(dkDatastore aDatastore, byte[] aByteArr) throws DKException, java.lang.Exception
aDatastore
- a DKDatastoreDL representing the associated DL datastoreaByteArr
- a byte array to be set as this object's contentDKException,
- Exception If error occurredpublic DKClobDL(DKClobDL aDKClobDL) throws DKException
aDKClobDL
- an instance of DKClobDLDKException
- If error occurredMethod Detail |
public java.lang.String getObjectType()
public void deletingValue()
public boolean isContentChanged()
isContentChanged
in class dkAbstractXDO
true
if the object content is changed;
false
otherwise.public boolean isSet()
isSet
in class dkAbstractXDO
true
if the object content is set;
false
otherwise.public boolean isNull()
isNull
in class dkAbstractXDO
true
if the object content is null;
false
otherwise.public void setNull()
setNull
in class dkAbstractXDO
public boolean equals(dkXDOBase adkXDOBase) throws DKException
equals
in class dkAbstractXDO
adkXDOBase
- an instance of dkXDOBasetrue
if the objects have same type, pid, content and search index
false
otherwise.DKException
- If objects are not the same classpublic boolean notEqual(dkXDOBase adkXDOBase) throws DKException
notEqual
in class dkAbstractXDO
adkXDOBase
- an instance of dkXDOBasetrue
if the objects do not have same type, pid, content and search index
false
otherwise.DKException
- If objects are not the same classpublic DKPid getPid()
getPid
in class dkAbstractXDO
getPidObject()
public void setPid(DKPid aDKPid) throws DKUsageError
setPid
in class dkAbstractXDO
aDKPid
- a DKPidXDO objectDKUsageError
- If provided pid is nullsetPidObject(DKPid aPidXDO)
public DKPid getPidObject()
getPidObject
in class dkAbstractXDO
public void setPidObject(DKPid aPidXDO) throws DKException
setPidObject
in class dkAbstractXDO
aPidXDO
- a DKPidXDO objectDKException
- If provided pid is nullpublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void add(java.lang.String aFullFileName) throws DKException, java.lang.Exception
add
in class dkAbstractXDO
aFullFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void retrieve() throws DKException, java.lang.Exception
retrieve
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void retrieve(java.lang.String aFileName) throws DKException, java.lang.Exception
retrieve
in class dkAbstractXDO
aFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void update(java.lang.String aFileName) throws DKException, java.lang.Exception
update
in class dkAbstractXDO
aFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void update() throws DKException, java.lang.Exception
update
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void del() throws DKException, java.lang.Exception
del
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void del(boolean flush) throws DKException, java.lang.Exception
del
in class dkAbstractXDO
flush
- if true the memory content will be flush, if false
and content is not set, the object will be retreived before delete it.
The default is flush.DKException,
- Exception If error occurredpublic void copyData(dkXDO adkXDO) throws DKException, java.lang.Exception
copyData
in class dkAbstractXDO
adkXDO
- the other XDO objectDKException,
- Exception If error occurredpublic boolean compareData(dkXDO adkXDO) throws DKException, java.lang.Exception
compareData
in class dkAbstractXDO
adkXDO
- the other XDO objectDKException,
- Exception If object type is differentpublic void setContent(byte[] aByteArray)
setContent
in class dkAbstractXDO
aByteArray
- a byte arraypublic byte[] getContent() throws DKException, java.lang.Exception
getContent
in class dkAbstractXDO
DKException,
- Exception If object type is differentpublic void getContentToClientFile(java.lang.String afileName, int fileOption) throws DKException, java.lang.Exception
getContentToClientFile
in class dkAbstractXDO
afileName
- a fully qualified path with file name, default is current directory(if no path)fileOption
- 1 will create or overwrite an existing file; 2 will only create file, but
will also throw an exception if the file already exists; 3 appends to an existing fileDKException,
- Exception If error occurredpublic void setContentFromClientFile(java.lang.String afileName) throws DKException
setContentFromClientFile
in class dkAbstractXDO
afileName
- a fully qualified path with file name, default is current directory(if no path)DKException
- If error occurredpublic dkClob concatReplace(dkClob adkClob) throws DKException, java.lang.Exception
concatReplace
in class dkClob
adkClob
- another dkClob objectpublic dkClob concatReplace(byte[] aByteArr) throws DKException, java.lang.Exception
concatReplace
in class dkClob
aByteArr
- a byte array streampublic int length()
length
in class dkAbstractXDO
public int indexOf(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkClob
astring
- the search string argumentstartpos
- the offset position start to searchpublic int indexOf(dkClob adkClob, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkClob
adkClob
- the lobData of this dkClob is the search argumentstartpos
- the offset position start to searchpublic java.lang.String subString(int startpos, int alength) throws DKException, java.lang.Exception
subString
in class dkClob
startpos
- the byte offset position start to extractalength
- the length to extractpublic dkClob remove(int startpos, int alength) throws DKException, java.lang.Exception
remove
in class dkClob
startpos
- the byte offset position start to deletealength
- the length to deletepublic dkClob insert(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
insert
in class dkClob
astring
- the argument string datastartpos
- the byte offset position start to insertpublic dkClob insert(dkClob adkClob, int startpos) throws DKException, java.lang.Exception
insert
in class dkClob
adkClob
- the lobData of this dkClob is the argument datastartpos
- the byte offset position start to insertpublic void open() throws DKException, java.lang.Exception
open
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void open(java.lang.String afileName) throws DKException, java.lang.Exception
open
in class dkAbstractXDO
afileName
- a provided file nameDKException,
- Exception If error occurredpublic void setInstanceOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setInstanceOpenHandler
in class dkAbstractXDO
ahandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public void setClassOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setClassOpenHandler
in class dkAbstractXDO
ahandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public java.lang.String getOpenHandler()
getOpenHandler
in class dkAbstractXDO
public boolean isOpenSynchronous()
isOpenSynchronous
in class dkAbstractXDO
public java.lang.String getRepType()
public void setRepType(java.lang.String aRType)
aRType
- the DL representation type of the object contentpublic int getContentClass()
public void setContentClass(int aCClass)
aCClass
- the content class of the objectpublic int getAffiliatedType() throws DKException, java.lang.Exception
getAffiliatedType
in class dkAbstractXDO
public void setAffiliatedType(int aAType) throws DKException, java.lang.Exception
setAffiliatedType
in class dkAbstractXDO
aAType
- the affiliated type of the objectpublic DKAnnotation getAffiliatedData()
getExtension(String extensionName)
public void setAffiliatedData(DKAnnotation apAData)
apAData
- a DKAnnotation object contains the annotation data informationssetExtension(String extensionName, dkExtension extensionObj)
public java.lang.String getSearchEngine() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredto get the DKSearchEngineInfoDL object
public void setSearchEngine(java.lang.String aSearchEngine) throws DKException, java.lang.Exception
aSearchEngine
- the search engine name; SM for text search, QBIC for image searchDKException,
- Exception If error occurredto set
the DKSearchEngineInfoDL object
public java.lang.String getSearchIndex() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredto get the DKSearchEngineInfoDL object
public void setSearchIndex(java.lang.String aSearchIndex) throws DKException, java.lang.Exception
aSearchIndex
- the search index name like "SearchService-IndexName"DKException,
- Exception If error occurredto set
the DKSearchEngineInfoDL object
public java.lang.String getSearchInfo() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredto get the DKSearchEngineInfoDL object
public void setSearchInfo(java.lang.String aSearchInfo) throws DKException, java.lang.Exception
aSearchInfo
- the three chars code, valid in the NLS language tableDKException,
- Exception If error occurredto set
the DKSearchEngineInfoDL object
public boolean getIndexFlag()
true
if a part object is indexed by a search engine
false
otherwise.for details
public void setIndexFlag(boolean aFlag)
aFlag
- a flag to indicate the part object is indexed by a search enginepublic DKClobDL concatenate(DKClobDL aDKClobDL) throws DKException, java.lang.Exception
aDKClobDL
- another DKClobDL objectDKException,
- Exception If error occurredpublic DKClobDL concatenate(byte[] aByteArr) throws DKException, java.lang.Exception
aByteArr
- a byte array streamDKException,
- Exception If error occurredpublic DKClobDL subLob(int startpos, int alength) throws DKException, java.lang.Exception
startpos
- the byte offset position to startalength
- the length of bytes to obtainDKException,
- Exception If error occurredpublic void setRank(int aRank)
setRank
in class dkAbstractXDO
aRank
- a ranking valuepublic int getRank()
getRank
in class dkAbstractXDO
public java.lang.String mimeType() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic void setToBeIndexed() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic java.lang.String getCreatedTimestamp() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic java.lang.String getUpdatedTimestamp() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic int getRetrievalAction() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredfor details
public void setRetrievalAction(int aRetriveAction) throws DKException, java.lang.Exception
the
- retrieval optionDKException,
- Exception If error occurredfor details
public int getSize() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic java.lang.Object getOption(int option) throws DKException, java.lang.Exception
getOption
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
setOption
in class dkAbstractXDO
option
- an option
The valid options are:
value
- the option value
For DK_OPT_DL_DELETE_OPTION, the valid values are:
Delete item if no more part left in the item.
Don't delete the item, even if there is no more part left in the item.
Don't delete the item if there is no part left in the item. Cannot delete media parts (media objects) when they are in use.
Don't delete the item, even if there is no part left in the item. You can delete media parts (media objects), even if they are in use.
Delete the item if there is no part left in the item. Cannot delete media parts (media objects) when they are in use.
Delete the item if there is no part left in the item. Can delete media parts (media objects), even if they are in use.
For DK_OPT_DL_RETRIEVAL_ACTION, the valid values are:
DKException,
- Exception If error occurredpublic void setExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
extensionName
- the extension name
The valid extension names are:
For an annotation object, you need to set this extension object to hold the affiliated informations.
For a search indexed object, you need to set this extension object to hold the search indexed informations.
For a media object, you need to set this extension object to hold the media user data.
If you want to associate this part with different storage colleciton name, you need to set this extension object to hold the storage collection informations.
extensionObj
- a source extension objectDKException,
- Exception If error occurredpublic void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension
in class dkAbstractXDO
extensionName
- the extension nameextensionObj
- a source extension objectDKException,
- Exception If error occurredpublic dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
getExtension
in class dkAbstractXDO
extensionName
- the extension name
The valid extension names are:
DKException,
- Exception If error occurredpublic void removeExtension(java.lang.String extensionName) throws DKException
removeExtension
in class dkAbstractXDO
extensionName
- the extension name
The valid extension names are:
DKException
- If error occurredpublic boolean isCategoryOf(int categoryName) throws DKException, java.lang.Exception
categoryName
- the category name
The valid category names are:
true
if the object is the specified category;
false
otherwise.DKException,
- Exception If error occurredpublic int retrieveObjectState(int object) throws DKException, java.lang.Exception
object
- the type of object
The valid input are:
For media object, the valid states are:
For search indexed object, the valid states are:
DKException,
- Exception If error occurredpublic void changeStorage() throws DKException, java.lang.Exception
The collection name, management class name and storage class name will be all converted to upper case by the system. These names must be valid on the object server where you store the object. If you change the collection name and specify a null string as the class name, the function places the object in the default class for the specified collection.
You cannot move the object from one server to another using this function, therefore you cannot change the StoreSite. If the change causes any physical movement of the object, it might be deferred until the storage management cycle runs on the server.
DKException,
- Exception If error occurredpublic int partId()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |