|
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.dkBlob | +--com.ibm.mm.sdk.common.DKBlobDES
DKBlobDES: a blob (XDO) represents a part object of DES
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.DKMessageIdDES |
DK_DES_MSG_MSGID_NOT_FOUND |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKBlobDES(DKBlobDES aDKBlobDES)
Copy constructor. |
|
DKBlobDES(dkDatastore aDatastore)
Constructs the blob and defers initialization until implementation methods are called. |
|
DKBlobDES(dkDatastore aDatastore,
byte[] aByteArr)
Constructs the blob and set the object's content. |
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. |
boolean |
compareData(dkXDO adkXDO)
Compares the content of this object with the content of the other XDO object |
DKBlobDES |
concatenate(byte[] aByteArr)
Deprecated. not really needed |
DKBlobDES |
concatenate(DKBlobDES aDKBlobDES)
Deprecated. not really needed |
dkBlob |
concatReplace(byte[] aByteArr)
Deprecated. no need to do this, no meaning |
dkBlob |
concatReplace(dkBlob adkBlob)
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 |
byte[] |
getContent()
Gets the content of this object |
void |
getContentToClientFile(java.lang.String afileName,
int fileOption)
Copies the lob data of this object to the given file |
java.lang.String |
getDatabaseName()
Gets the databaseName |
java.lang.String |
getDocId()
Gets the DocId from the pid |
dkExtension |
getExtension(java.lang.String extensionName)
Gets the extension object. |
java.lang.String |
getFieldName()
Gets the FieldName from the pid |
java.lang.String |
getItemId()
Gets the DES item id of the object content |
java.lang.String |
getMimeType()
Gets the MIME type. |
java.lang.String |
getObjectType()
Gets the object type. |
java.lang.String |
getOpenHandler()
Gets the current program name of the handler for this object instance |
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 |
int |
indexOf(dkBlob adkBlob,
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 |
dkBlob |
insert(dkBlob adkBlob,
int startpos)
Deprecated. no need to do this, no meaning |
dkBlob |
insert(java.lang.String astring,
int startpos)
Deprecated. no need to do this, no meaning |
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. |
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. |
dkBlob |
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 |
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 |
setContentFromClientFile(java.lang.String afileName)
Replaces the lob data of this object with the contents of the file afileName |
void |
setDatabaseName(java.lang.String databaseName)
Sets the databaseName in the pid |
void |
setDocId(java.lang.String docId)
Sets the docId in the pid |
void |
setExtension(java.lang.String extensionName,
dkExtension extensionObj)
Sets the extension object. |
void |
setFieldName(java.lang.String fieldName)
Sets the fieldName in the pid |
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 |
setItemId(java.lang.String aItemId)
Sets the DES item id of the object content |
void |
setMimeType(java.lang.String mimeType)
Sets the MIME type |
void |
setNull()
Sets the part content to null (in memory). |
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 |
DKBlobDES |
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, getAffiliatedType, getClassName, getContentType, getDatastore, getOption, getParent, getRootObject, protocol, setAffiliatedType, setClassName, setContentType, setDatastore, setOption, 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 DKBlobDES(dkDatastore aDatastore) throws DKUsageError, java.lang.Exception
aDatastore
- a DKDatastoreDES representing the associated DES datastoreDKUsageError,
- Exception If invalid datastore typepublic DKBlobDES(dkDatastore aDatastore, byte[] aByteArr) throws DKException, java.lang.Exception
aDatastore
- a DKDatastoreDES representing the associated DES datastoreaByteArr
- a byte array to be set as this object's contentDKException,
- Exception If error occurredpublic DKBlobDES(DKBlobDES aDKBlobDES) throws DKException, java.lang.Exception
aDKBlobDES
- an instance of DKBlobDESDKException
- 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 dkBlob concatReplace(dkBlob adkBlob) throws DKException, java.lang.Exception
concatReplace
in class dkBlob
adkBlob
- another dkBlob objectpublic dkBlob concatReplace(byte[] aByteArr) throws DKException, java.lang.Exception
concatReplace
in class dkBlob
aByteArr
- a byte array streampublic int length() throws DKException, java.lang.Exception
length
in class dkAbstractXDO
public int indexOf(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkBlob
astring
- the search string argumentstartpos
- the offset position start to searchpublic int indexOf(dkBlob adkBlob, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkBlob
adkBlob
- the lobData of this dkBlob 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 dkBlob
startpos
- the byte offset position start to extractalength
- the length to extractpublic dkBlob remove(int startpos, int alength) throws DKException, java.lang.Exception
remove
in class dkBlob
startpos
- the byte offset position start to deletealength
- the length to deletepublic dkBlob insert(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
insert
in class dkBlob
astring
- the argument string datastartpos
- the byte offset position start to insertpublic dkBlob insert(dkBlob adkBlob, int startpos) throws DKException, java.lang.Exception
insert
in class dkBlob
adkBlob
- the lobData of this dkBlob 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 getItemId()
public void setItemId(java.lang.String aItemId)
aItemId
- - the unique item id; format is databaseName|docIdpublic java.lang.String getDatabaseName()
public void setDatabaseName(java.lang.String databaseName)
databaseName
- - name of DES database which contains this blobpublic java.lang.String getDocId()
public void setDocId(java.lang.String docId)
docId
- - docId of the DES document which contains this blobpublic java.lang.String getFieldName()
public void setFieldName(java.lang.String fieldName)
fieldName
- - fieldName which contains this blobpublic DKBlobDES concatenate(DKBlobDES aDKBlobDES) throws DKException, java.lang.Exception
aDKBlobDES
- another DKBlobDES objectDKException,
- Exception If error occurredpublic DKBlobDES concatenate(byte[] aByteArr) throws DKException, java.lang.Exception
aByteArr
- a byte array streamDKException,
- Exception If error occurredpublic DKBlobDES 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 void setMimeType(java.lang.String mimeType) throws DKException, java.lang.Exception
setMimeType
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic java.lang.String getMimeType() throws DKException, java.lang.Exception
getMimeType
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic java.lang.String mimeType() throws DKException, java.lang.Exception
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:
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 occurred
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |