Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKBlobIP

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractXDO
        |
        +--com.ibm.mm.sdk.common.dkBlob
              |
              +--com.ibm.mm.sdk.common.DKBlobIP
All Implemented Interfaces:
DKConstant, DKConstantIP, dkDataObjectBase, DKMessageId, DKMessageIdIP, dkXDO, dkXDOBase, java.io.Serializable

public class DKBlobIP
extends dkBlob
implements DKConstant, DKConstantIP, DKMessageIdIP, java.io.Serializable

For ImagePlus 390, a blob (XDO) represents an IODM document or annotation object.

See Also:
Serialized Form

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.DKConstantIP
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdIP
copyright, DK_IP_MSG_API_PROTOCOL_ERROR, DK_IP_MSG_CLIENT_API_NOT_OK, DK_IP_MSG_DATASTORE_READONLY, DK_IP_MSG_DOCIDNOTSET, DK_IP_MSG_FAF_ERROR, DK_IP_MSG_FAF_INTERNAL_ERROR, DK_IP_MSG_FAF_NOT_OK, DK_IP_MSG_FAF_WARNING, DK_IP_MSG_FOLDER_NOT_EMPTY, DK_IP_MSG_HOST_TIMEOUT, DK_IP_MSG_INVALID_CONN_OPTION, DK_IP_MSG_INVALID_DOCTYPE, DK_IP_MSG_INVALID_IODM_RC, DK_IP_MSG_INVALID_PARM, DK_IP_MSG_IODM_FAILURE, DK_IP_MSG_IODM_NOT_AVAILABLE, DK_IP_MSG_LOCKEDBYANOTHER, DK_IP_MSG_MISSING_CONN_OPTION, DK_IP_MSG_MSGID_NOT_FOUND, DK_IP_MSG_PROTOCOL_ERROR
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKBlobIP(DKBlobIP aDKBlobIP)
          Copy constructor.
DKBlobIP(dkDatastore aDatastore)
          Constructs the blob and defers initialization until implementation methods are called.
DKBlobIP(dkDatastore aDatastore, byte[] aByteArr)
          Constructs the blob and sets the blob object's content based on the specified byte array.
 
Method Summary
 void add()
          Adds this object's content, which is buffered in memory, to IP/390 as an IODM document or annotation.
 void add(java.lang.String aFullFileName)
          Adds this object's content, which is in the specified file, to IP/390 as an IODM document or annotation.
 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 specifed XDO object
 DKBlobIP concatenate(byte[] aByteArr)
          Deprecated. not really needed
 DKBlobIP concatenate(DKBlobIP aDKBlobIP)
          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 specified XDO object.
 void del()
          ImagePlus 390 only supports the deleting of annotations, not IODM documents.
 void del(boolean flush)
          ImagePlus 390 only supports the deleting of annotations, not IODM documents.
 void deletingValue()
          Deprecated. no meaning for IP/390
 boolean equals(dkXDOBase adkXDOBase)
          Deprecated. no need to do this, no meaning
 int getAffiliatedType()
          Gets the affiliated type of the object.
 byte[] getContent()
          Gets the content (lob data) of this object
 int getContentClass()
          Gets the content class for this 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
 DKDDO getDDO()
          Gets the DDO specified for the IODM annotation.
 java.lang.String getDescription()
          Gets the description specified for the IODM annotation.
 dkExtension getExtension(java.lang.String extensionName)
          Gets the extension object.
 java.lang.String getMimeType()
          Gets the MIME type represents this object's content class
 java.lang.String getObjectType()
          Gets the object type, which is always DKBlobIP
 java.lang.String getOpenHandler()
          Gets the current program name of the handler for this object instance
 int getPageCount()
          Gets the Number of pages in the ODM document or annotation represented by this blob.
 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 getSize()
          Gets the size of this object without retrieving the object content.
 java.lang.String getUpdatedTimestamp()
          Gets the data & time that the object was updated
 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, not necessarily on the IP/390 server).
 boolean isNull()
          Checks if the part content is null (in memory, not necessarily on the IP/390 server).
 boolean isOpenSynchronous()
          Gets the current synchronization property
 boolean isSet()
          Checks if the part content is set (in memory, not necessarily on the IP/390 server).
 int length()
          If the content is in memory, this method gets the length of this object's content.
 java.lang.String mimeType()
          Gets the MIME type represents this object's content class
 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's content from a stored IODM document or annotation.
 void retrieve(java.lang.String aFileName)
          Retrieves the object's content from a stored IODM document or annotation.
 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 using the specified byte array stream
 void setContentClass(int aCClass)
          Sets the content class for this object.
 void setContentFromClientFile(java.lang.String afileName)
          Replaces the lob data of this object with the contents of the file afileName
 void setDDO(DKDDO aDDO)
          Sets the document DDO associated with the IODM annotation.
 void setDescription(java.lang.String desc)
          Sets the description field for an IODM annotation.
 void setExtension(java.lang.String extensionName, dkExtension extensionObj)
          Sets the extension object.
 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.
 void setNull()
          Sets the part content to null (in memory, not necessarily on the IP/390 server).
 void setPageCount(int aCount)
          Sets the Number of pages in the ODM document or annotation represented by this blob.
 void setPid(DKPid aDKPid)
          Deprecated. Replace by setPidObject(DKPid aPidXDO)
 void setPidObject(DKPid aPidXDO)
          Sets the pid information of this object based on the information in the specified pid.
 void setRank(int aRank)
          Sets the ranking value of a query.
 int size()
          Gets the size of this object content in the datastore
 java.lang.String subString(int startpos, int alength)
          Deprecated. no need to do this, no meaning
 void update()
          ImagePlus 390 only supports the updating of annotations, not IODM documents.
 void update(java.lang.String aFileName)
          ImagePlus 390 only supports the updating of annotations, not IODM documents.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractXDO
cloneSkeleton, datastore, getClassName, getContentType, getDatastore, getOption, getParent, getRootObject, protocol, setClassName, setContentType, setDatastore, setMimeType, setOption, setParent, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKBlobIP

public DKBlobIP(dkDatastore aDatastore)
         throws DKUsageError,
                java.lang.Exception
Constructs the blob and defers initialization until implementation methods are called.
Parameters:
aDatastore - a DKDatastoreIP representing the associated IP datastore
Throws:
DKUsageError, - Exception If invalid datastore type

DKBlobIP

public DKBlobIP(dkDatastore aDatastore,
                byte[] aByteArr)
         throws DKException,
                java.lang.Exception
Constructs the blob and sets the blob object's content based on the specified byte array.
Parameters:
aDatastore - a DKDatastoreIP representing the associated IP datastore
aByteArr - a byte array to be set as this object's content
Throws:
DKException, - Exception If error occurred

DKBlobIP

public DKBlobIP(DKBlobIP aDKBlobIP)
         throws DKException
Copy constructor.
Parameters:
aDKBlobIP - an instance of DKBlobIP
Throws:
DKException - If error occurred
Method Detail

getObjectType

public java.lang.String getObjectType()
Gets the object type, which is always DKBlobIP
Returns:
the object type "DKBlobIP"

deletingValue

public void deletingValue()
Deprecated. no meaning for IP/390

Deletes value, this function performs as setNull in this class

isContentChanged

public boolean isContentChanged()
Checks if the part content changed (in memory, not necessarily on the IP/390 server).
Overrides:
isContentChanged in class dkAbstractXDO
Returns:
true if the object content is changed; false otherwise.

isSet

public boolean isSet()
Checks if the part content is set (in memory, not necessarily on the IP/390 server).
Overrides:
isSet in class dkAbstractXDO
Returns:
true if the object content is set; false otherwise.

isNull

public boolean isNull()
Checks if the part content is null (in memory, not necessarily on the IP/390 server).
Overrides:
isNull in class dkAbstractXDO
Returns:
true if the object content is null; false otherwise.

setNull

public void setNull()
Sets the part content to null (in memory, not necessarily on the IP/390 server).
Overrides:
setNull in class dkAbstractXDO

equals

public boolean equals(dkXDOBase adkXDOBase)
               throws DKException
Deprecated. no need to do this, no meaning

Check if the xdo objects have same type, pid, content and indexed by same search engine
Overrides:
equals in class dkAbstractXDO
Parameters:
adkXDOBase - an instance of dkXDOBase
Returns:
true if the objects have same type, pid, content and search index false otherwise.
Throws:
DKException - If objects are not the same class

notEqual

public boolean notEqual(dkXDOBase adkXDOBase)
                 throws DKException
Deprecated. no need to do this, no meaning

check if the xdo objects is not equal.
Overrides:
notEqual in class dkAbstractXDO
Parameters:
adkXDOBase - an instance of dkXDOBase
Returns:
true if the objects do not have same type, pid, content and search index false otherwise.
Throws:
DKException - If objects are not the same class

getPid

public DKPid getPid()
Deprecated. Replace by getPidObject()

Gets a copy of the persistent ID object of this DKBlobIP object
Overrides:
getPid in class dkAbstractXDO
Returns:
a copy of the persistent ID object of this DKBlobIP object
See Also:
getPidObject()

setPid

public void setPid(DKPid aDKPid)
            throws DKUsageError
Deprecated. Replace by setPidObject(DKPid aPidXDO)

Sets the pid information of this object with the new provided pid
Overrides:
setPid in class dkAbstractXDO
Parameters:
aDKPid - a DKPidXDO object
Throws:
DKUsageError - If provided pid is null
See Also:
setPidObject(DKPid aPidXDO)

getPidObject

public DKPid getPidObject()
Gets a copy of the persistent ID object of this object
Overrides:
getPidObject in class dkAbstractXDO
Returns:
a copy of the persistent ID object of this object

setPidObject

public void setPidObject(DKPid aPidXDO)
                  throws DKException
Sets the pid information of this object based on the information in the specified pid.
Overrides:
setPidObject in class dkAbstractXDO
Parameters:
aPidXDO - a DKPidXDO object
Throws:
DKException - If provided pid is null

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this object's content, which is buffered in memory, to IP/390 as an IODM document or annotation.
Overrides:
add in class dkAbstractXDO
Throws:
DKException, - Exception If error occurred

add

public void add(java.lang.String aFullFileName)
         throws DKException,
                java.lang.Exception
Adds this object's content, which is in the specified file, to IP/390 as an IODM document or annotation.
Overrides:
add in class dkAbstractXDO
Parameters:
aFullFileName - a fully qualified path and file name, default is current directory
Throws:
DKException, - Exception If error occurred

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieves the object's content from a stored IODM document or annotation. The retrieved content is buffered in memory.
Overrides:
retrieve in class dkAbstractXDO
Throws:
DKException, - Exception If error occurred

retrieve

public void retrieve(java.lang.String aFileName)
              throws DKException,
                     java.lang.Exception
Retrieves the object's content from a stored IODM document or annotation. The retrieved content is put into the specified file.
Overrides:
retrieve in class dkAbstractXDO
Parameters:
aFileName - a fully qualified path and file name, default is current directory
Throws:
DKException, - Exception If error occurred

update

public void update(java.lang.String aFileName)
            throws DKException,
                   java.lang.Exception
ImagePlus 390 only supports the updating of annotations, not IODM documents. Before the annotation can be updated, the document (DDO) to which the annotation belongs must 1) be locked using the DKDatastoreIP checkOut method and 2) associated with this object using the setDDO method. Based on the contents of the specified file, this method then updates the IODM annotation associated with the locked document (DDO). Note: The locked document (DDO) will be unlocked upon return.
Overrides:
update in class dkAbstractXDO
Parameters:
aFileName - a fully qualified path and file name, default is current directory
Throws:
DKException, - Exception If error occurred

update

public void update()
            throws DKException,
                   java.lang.Exception
ImagePlus 390 only supports the updating of annotations, not IODM documents. Before the annotation can be updated, the document (DDO) to which the annotation belongs must 1) be locked using the DKDatastoreIP checkOut method and 2) associated with this object using the setDDO method. Based on the buffered contents of this object, this method then updates the IODM annotation associated with the locked document (DDO). Note: The locked document (DDO) will be unlocked upon return.
Overrides:
update in class dkAbstractXDO
Throws:
DKException, - Exception If error occurred

del

public void del()
         throws DKException,
                java.lang.Exception
ImagePlus 390 only supports the deleting of annotations, not IODM documents. Before the annotation can be deleted, the document (DDO) to which the annotation belongs must 1) be locked using the DKDatastoreIP checkOut method and 2) associated with this object using the setDDO method. This method then deletes the IODM annotation associated with the locked document (DDO). NOTE: The annotation object is actually set to a null- terminated string. There is a limitation with deleting the entire object from IODM at this time.
Overrides:
del in class dkAbstractXDO
Throws:
DKException, - Exception If error occurred

del

public void del(boolean flush)
         throws DKException,
                java.lang.Exception
ImagePlus 390 only supports the deleting of annotations, not IODM documents. Before the annotation can be deleted, the document (DDO) to which the annotation belongs must 1) be locked using the DKDatastoreIP checkOut method and 2) associated with this object using the setDDO method. This method then deletes the IODM annotation associated with the locked document (DDO). NOTE: The annotation object is actually set to a null- terminated string. There is a limitation with deleting the entire object from IODM at this time.
Overrides:
del in class dkAbstractXDO
Parameters:
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.
Throws:
DKException, - Exception If error occurred

copyData

public void copyData(dkXDO adkXDO)
              throws DKException,
                     java.lang.Exception
Replaces the content of this object with the content of the specified XDO object.
Overrides:
copyData in class dkAbstractXDO
Parameters:
adkXDO - the other XDO object
Throws:
DKException, - Exception If error occurred

compareData

public boolean compareData(dkXDO adkXDO)
                    throws DKException,
                           java.lang.Exception
Compares the content of this object with the content of the specifed XDO object
Overrides:
compareData in class dkAbstractXDO
Parameters:
adkXDO - the other XDO object
Throws:
DKException, - Exception If object type is different

setContent

public void setContent(byte[] aByteArray)
Sets the content of this object using the specified byte array stream
Overrides:
setContent in class dkAbstractXDO
Parameters:
aByteArray - a byte array

getContent

public byte[] getContent()
                  throws DKException,
                         java.lang.Exception
Gets the content (lob data) of this object
Overrides:
getContent in class dkAbstractXDO
Returns:
the object content as a byte array stream
Throws:
DKException, - Exception If object type is different

getContentToClientFile

public void getContentToClientFile(java.lang.String afileName,
                                   int fileOption)
                            throws DKException,
                                   java.lang.Exception
Copies the lob data of this object to the given file
Overrides:
getContentToClientFile in class dkAbstractXDO
Parameters:
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 file
Throws:
DKException, - Exception If error occurred

setContentFromClientFile

public void setContentFromClientFile(java.lang.String afileName)
                              throws DKException
Replaces the lob data of this object with the contents of the file afileName
Overrides:
setContentFromClientFile in class dkAbstractXDO
Parameters:
afileName - a fully qualified path with file name, default is current directory(if no path)
Throws:
DKException - If error occurred

concatReplace

public dkBlob concatReplace(dkBlob adkBlob)
                     throws DKException,
                            java.lang.Exception
Deprecated. no need to do this, no meaning

Concatenates this object's content with the specified object content the results of the concatenation replaces the existing contents of this object
Overrides:
concatReplace in class dkBlob
Parameters:
adkBlob - another dkBlob object
Returns:
a dkBlob object

concatReplace

public dkBlob concatReplace(byte[] aByteArr)
                     throws DKException,
                            java.lang.Exception
Deprecated. no need to do this, no meaning

Concatenates this object's content with the specified stream the results of the concatenation replaces the existing contents of this object
Overrides:
concatReplace in class dkBlob
Parameters:
aByteArr - a byte array stream
Returns:
a dkBlob object

length

public int length()
If the content is in memory, this method gets the length of this object's content. Otherwise, this method returns a length of 0.
Overrides:
length in class dkAbstractXDO
Returns:
a byte length of this object content in memory

indexOf

public int indexOf(java.lang.String astring,
                   int startpos)
            throws DKException,
                   java.lang.Exception
Deprecated. no need to do this, no meaning

Returns the byte offset of the first occurrence of the search argument within this object, starting the search at offset startPos. If the search argument is not found, return 0.
Overrides:
indexOf in class dkBlob
Parameters:
astring - the search string argument
startpos - the offset position start to search
Returns:
the byte offset of the first occurrence of the search argument; return 0 if the search argument is not found

indexOf

public int indexOf(dkBlob adkBlob,
                   int startpos)
            throws DKException,
                   java.lang.Exception
Deprecated. no need to do this, no meaning

Returns the byte offset of the first occurrence of the search argument within this object, starting the search at offset startPos. If the search argument is not found, return 0.
Overrides:
indexOf in class dkBlob
Parameters:
adkBlob - the lobData of this dkBlob is the search argument
startpos - the offset position start to search
Returns:
the byte offset of the first occurrence of the search argument; return 0 if the search argument is not found

subString

public java.lang.String subString(int startpos,
                                  int alength)
                           throws DKException,
                                  java.lang.Exception
Deprecated. no need to do this, no meaning

return a string object containing a substring of the lob data of this object. The substring will be taken starting at byte offset startpos, and extracting alength bytes.
Overrides:
subString in class dkBlob
Parameters:
startpos - the byte offset position start to extract
alength - the length to extract
Returns:
a string object

remove

public dkBlob remove(int startpos,
                     int alength)
              throws DKException,
                     java.lang.Exception
Deprecated. no need to do this, no meaning

Deletes the portion of the lob data of this object starting at startpos for alength bytes
Overrides:
remove in class dkBlob
Parameters:
startpos - the byte offset position start to delete
alength - the length to delete
Returns:
a dkBlob object

insert

public dkBlob insert(java.lang.String astring,
                     int startpos)
              throws DKException,
                     java.lang.Exception
Deprecated. no need to do this, no meaning

Inserts the argument data, following position startpos in the lob data of this object
Overrides:
insert in class dkBlob
Parameters:
astring - the argument string data
startpos - the byte offset position start to insert
Returns:
a dkBlob object

insert

public dkBlob insert(dkBlob adkBlob,
                     int startpos)
              throws DKException,
                     java.lang.Exception
Deprecated. no need to do this, no meaning

Inserts the argument data, following position startpos in the lob data of this object
Overrides:
insert in class dkBlob
Parameters:
adkBlob - the lobData of this dkBlob is the argument data
startpos - the byte offset position start to insert
Returns:
a dkBlob object

open

public void open()
          throws DKException,
                 java.lang.Exception
Unloads the object content to a client file with a system generated name and then synchronously invoking a default handler against the file.
Overrides:
open in class dkAbstractXDO
Throws:
DKException, - Exception If error occurred

open

public void open(java.lang.String afileName)
          throws DKException,
                 java.lang.Exception
Unloads the object content to a file afileName provided by the application and then synchronously invoking a default handler against the file.
Overrides:
open in class dkAbstractXDO
Parameters:
afileName - a provided file name
Throws:
DKException, - Exception If error occurred

setInstanceOpenHandler

public 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.
Overrides:
setInstanceOpenHandler in class dkAbstractXDO
Parameters:
ahandler - the handler program name to view the content
newSynchronousFlag - true for synchronous process; false otherwise.

setClassOpenHandler

public 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
Overrides:
setClassOpenHandler in class dkAbstractXDO
Parameters:
ahandler - the handler program name to view the content
newSynchronousFlag - true for synchronous process; false otherwise.

getOpenHandler

public java.lang.String getOpenHandler()
Gets the current program name of the handler for this object instance
Overrides:
getOpenHandler in class dkAbstractXDO
Returns:
the handler program name

isOpenSynchronous

public boolean isOpenSynchronous()
Gets the current synchronization property
Overrides:
isOpenSynchronous in class dkAbstractXDO
Returns:
TRUE or FALSE for the handler

getContentClass

public int getContentClass()
                    throws DKException,
                           java.lang.Exception
Gets the content class for this object.
Returns:
the content class of the object

setContentClass

public void setContentClass(int aCClass)
                     throws DKException,
                            java.lang.Exception
Sets the content class for this object.
Parameters:
aCClass - the content class of the object

getAffiliatedType

public int getAffiliatedType()
Gets the affiliated type of the object. For ImagePlus 390 the possible affiliated types are DK_CM_BASE or DM_CM_ANNOTATION.
Overrides:
getAffiliatedType in class dkAbstractXDO
Returns:
the affiliated type of the object

setAffiliatedType

public void setAffiliatedType(int aAType)
Sets the affiliated type of the object. For ImagePlus 390 the possible affiliated types are DK_CM_BASE and DM_CM_ANNOTATION.
Overrides:
setAffiliatedType in class dkAbstractXDO
Parameters:
aAType - the affiliated type of the object

concatenate

public DKBlobIP concatenate(DKBlobIP aDKBlobIP)
                     throws DKException,
                            java.lang.Exception
Deprecated. not really needed

Concatenates this object content with the specified object content and returns a new DKBlobIP object containing the result.
Parameters:
aDKBlobIP - another DKBlobIP object
Returns:
a new DKBlobIP object containing the result
Throws:
DKException, - Exception If error occurred

concatenate

public DKBlobIP concatenate(byte[] aByteArr)
                     throws DKException,
                            java.lang.Exception
Deprecated. not really needed

Concatenates this object content with the specified stream and returns a new DKBlobIP object containing the result.
Parameters:
aByteArr - a byte array stream
Returns:
a new DKBlobIP object containing the result
Throws:
DKException, - Exception If error occurred

setRank

public void setRank(int aRank)
Sets the ranking value of a query.
Overrides:
setRank in class dkAbstractXDO
Parameters:
aRank - a ranking value

getRank

public int getRank()
Gets the ranking value of a query
Overrides:
getRank in class dkAbstractXDO
Returns:
a ranking value

getMimeType

public java.lang.String getMimeType()
                             throws DKException,
                                    java.lang.Exception
Gets the MIME type represents this object's content class
Overrides:
getMimeType in class dkAbstractXDO
Returns:
the MIME type
Throws:
DKException, - Exception If error occurred

mimeType

public java.lang.String mimeType()
                          throws DKException,
                                 java.lang.Exception
Gets the MIME type represents this object's content class
Returns:
the MIME type
Throws:
DKException, - Exception If error occurred

getCreatedTimestamp

public java.lang.String getCreatedTimestamp()
                                     throws DKException,
                                            java.lang.Exception
Gets the data & time that the object was created
Returns:
the data & time that the object was created
Throws:
DKException, - Exception If error occurred

getUpdatedTimestamp

public java.lang.String getUpdatedTimestamp()
                                     throws DKException,
                                            java.lang.Exception
Gets the data & time that the object was updated
Returns:
the data & time that the object was updated
Throws:
DKException, - Exception If error occurred

size

public int size()
         throws DKException,
                java.lang.Exception
Gets the size of this object content in the datastore
Overrides:
size in class dkAbstractXDO
Returns:
a byte length of this object content in the datastore

getSize

public int getSize()
            throws DKException,
                   java.lang.Exception
Gets the size of this object without retrieving the object content.
Returns:
the object size
Throws:
DKException, - Exception If error occurred

setExtension

public void setExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
Sets the extension object.

The valid extension names are:

Parameters:
extensionName - the extension name
extensionObj - a source extension object
Throws:
DKException, - Exception If error occurred

addExtension

public void addExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
Add the extension object.
Overrides:
addExtension in class dkAbstractXDO
Parameters:
extensionName - the extension name
extensionObj - a source extension object
Throws:
DKException, - Exception If error occurred

getExtension

public dkExtension getExtension(java.lang.String extensionName)
                         throws DKException,
                                java.lang.Exception
Gets the extension object.
Overrides:
getExtension in class dkAbstractXDO
Parameters:
extensionName - the extension name

The valid extension names are:

Returns:
a dkExtension object
Throws:
DKException, - Exception If error occurred

removeExtension

public void removeExtension(java.lang.String extensionName)
                     throws DKException
Remove the extension object.
Overrides:
removeExtension in class dkAbstractXDO
Parameters:
extensionName - the extension name

The valid extension names are:

Throws:
DKException - If error occurred

setPageCount

public void setPageCount(int aCount)
Sets the Number of pages in the ODM document or annotation represented by this blob. Required for the following actions: add (affiliated type of DK_CM_BASE or DK_CM_ANNOTATION)
Parameters:
aCount - number of pages in the document

getPageCount

public int getPageCount()
Gets the Number of pages in the ODM document or annotation represented by this blob.
Returns:
the page count

setDescription

public void setDescription(java.lang.String desc)
Sets the description field for an IODM annotation. This is an optional parameter, and is recognized for the following actions:
Parameters:
desc - description of the annotation

getDescription

public java.lang.String getDescription()
Gets the description specified for the IODM annotation.
Returns:
the description

getDDO

public DKDDO getDDO()
Gets the DDO specified for the IODM annotation.
Returns:
the DDO

setDDO

public void setDDO(DKDDO aDDO)
Sets the document DDO associated with the IODM annotation. The DDO must be locked before making the method call. This is an REQUIRED parameter for the following actions:
Parameters:
desc - description of the annotation

EIP Java APIs

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