Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKBlobV4

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

public class DKBlobV4
extends dkBlob
implements DKConstantV4, DKMessageId, java.io.Serializable

DKBlobV4: a BLOB (XDO) represents a part object of VI400

See Also:
Serialized Form

Field Summary
static short APPEND
           
static short NOOVERWRITE
           
static short OVERWRITE
           
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantV4
    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.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKBlobV4(DKBlobV4 aDKBlobV4)
          Copy constructor.
DKBlobV4(dkDatastore aDatastore)
          Constructs the BLOB and defers initialization until implementation methods are called.
DKBlobV4(dkDatastore aDatastore, byte[] aByteArr)
          Constructs the BLOB and set the object's content.
 
Method Summary
 void add()
          Adds the object content in 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)
          Adds the extension object.
 void changeStorage()
          Changes the system-managed storage (SMS) criteria for an object.
 boolean compareData(dkXDO adkXDO)
          Compares the LOB data content with the given XDO object
 DKBlobV4 concatenate(byte[] aByteArr)
          Concatenates this object with the given stream
 DKBlobV4 concatenate(DKBlobV4 aDKBlobV4)
          Concatenates this object with the given object
 dkBlob concatReplace(byte[] aByteArr)
          Concatenates this object with the given stream, the results of the concatenation replaces the existing contents of this object.
 dkBlob concatReplace(dkBlob adkBlob)
          Concatenates this object with the given dkBlob object, the results of the concatenation replaces the existing contents of this object.
 void copyData(dkXDO adkXDO)
          Replaces the LOB data of this object with the contents of the given XDO object.
 void del()
          Deletes the object content from the datastore.
 void del(boolean flush)
          Deletes the object content from the datastore with the given flush flag
 void deletingValue()
          Deletes value, this function performs no action in this class.
 boolean equals(dkXDOBase adkXDOBase)
          Compares to see if the xdo objects are equal
 DKAnnotation getAffiliatedData()
          Deprecated. Replaced by getExtension(String extensionName)
 int getAffiliatedType()
          Gets the affiliated type of the object
 byte[] getContent()
          Gets the Stream object containing the LOB data 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 named file.
 java.lang.String getCreatedTimestamp()
          Gets the date and time that the object was created
 dkExtension getExtension(java.lang.String extensionName)
          Gets the extension object.
 boolean getIndexFlag()
          Deprecated. Replaced by isCategoryOf(int) method of this class
 java.lang.String getItemId()
          Gets the V4 item id of the object content
 java.lang.String getMimeType()
          Gets the MIME type representing this object's contentClass - not supported
 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.
 int getPartId()
          Gets the part id of this XDO
 DKPid getPid()
          Deprecated. Replaced 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 VI400 representation type of the piece of content
 int getRetrievalAction()
          Deprecated. Replaced by getOption(int option)
 int getSize()
          Gets the length of this object without retrieving the object
 java.lang.String getUpdatedTimestamp()
          Gets the date and time that the object was updated
 int indexOf(dkBlob adkBlob, int startPos)
          Gets the byte offset of the first occurrence of the search argument within this object, starting the search at offset startPos.
 int indexOf(java.lang.String aString, int startPos)
          Gets the byte offset of the first occurrence of the search argument within this object, starting the search at offset startPos.
 dkBlob insert(dkBlob adkBlob, int startPos)
          Inserts the argument data, starting at position startPos in the LOB data of this object.
 dkBlob insert(java.lang.String aString, int startPos)
          Inserts the argument data, starting at position startPos in the LOB data of this object.
 boolean isCategoryOf(int categoryName)
          Checks 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.
 java.lang.String mimeType()
          Gets the MIME type representing this object's contentClass
 boolean notEqual(dkXDOBase adkXDOBase)
          Compares to see if the xdo objects are not equal
 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 the file provided by the application then synchronously invoking a default handler against the file.
 dkBlob remove(int startPos, int length)
          Deletes the portion of the LOB data of this object starting at startPos for length bytes.
 void removeExtension(java.lang.String extensionName)
          Removes the extension object.
 void retrieve()
          Retrieves the object content to a buffer area from datastore.
 void retrieve(java.lang.String aFileName)
          Retrieves the object content from the Datastore to a file.
 int retrieveObjectState(int object)
          Retrieves the state of search indexed object
 void setAffiliatedData(DKAnnotation anAnnotation)
          Deprecated. Replaced 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)
          Replaces the LOB data of this object with the given byte array.
 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 given file
 void setExtension(java.lang.String extensionName, dkExtension extensionObj)
          Sets the extension object.
 void setIndexFlag(boolean aFlag)
          Deprecated. don't use this method
 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 instance.
 void setItemId(java.lang.String aItemId)
          Sets the V4 item id of the object content
 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 setPartId(int partId)
          Gets the part id of this XDO
 void setPid(DKPid aDKPid)
          Deprecated. Replaced 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 VI400 representation type of the piece of content
 void setRetrievalAction(int aRetriveAction)
          Deprecated. Replaced by setOption(int option, Object value)
 void setToBeIndexed()
          Index an existing part object by search engine - not supported by this datastore type
 int size()
          Gets the size of this object content in the datastore
 DKBlobV4 subLob(int startPos, int length)
          Similar to subString, but returns the subString data in the form of a DKBlobV4 object.
 java.lang.String subString(int startPos, int length)
          Gets an String object containing a substring of the LOB data of this object.
 void update()
          Updates the object content in the datastore
 void update(java.lang.String aFileName)
          Updates the object in datastore with a file - not supported by this datastore type
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractXDO
cloneSkeleton, datastore, getClassName, getContentType, getDatastore, getParent, getRootObject, protocol, setClassName, setContentType, setDatastore, setMimeType, setParent, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OVERWRITE

public static final short OVERWRITE

NOOVERWRITE

public static final short NOOVERWRITE

APPEND

public static final short APPEND
Constructor Detail

DKBlobV4

public DKBlobV4(dkDatastore aDatastore)
         throws DKUsageError,
                java.lang.Exception
Constructs the BLOB and defers initialization until implementation methods are called.
Parameters:
aDatastore - an instance of DKDatastoreV4
Throws:
DKUsageError - If invalid datastore type
java.lang.Exception - if error detected

DKBlobV4

public DKBlobV4(dkDatastore aDatastore,
                byte[] aByteArr)
         throws DKException,
                java.lang.Exception
Constructs the BLOB and set the object's content.
Parameters:
aDatastore - an instance of dkDatastore
aByteArr - a byte array to be set as this object's content
Throws:
DKException - If error occurred
java.lang.Exception - if error detected

DKBlobV4

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

getObjectType

public java.lang.String getObjectType()
Gets the object type.
Returns:
the object type

deletingValue

public void deletingValue()
Deletes value, this function performs no action in this class.

isContentChanged

public boolean isContentChanged()
Checks if the part content changed (in memory).
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).
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).
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).
Overrides:
setNull in class dkAbstractXDO

equals

public boolean equals(dkXDOBase adkXDOBase)
               throws DKException
Compares to see if the xdo objects are equal
Overrides:
equals in class dkAbstractXDO
Parameters:
adkXDOBase - an instance of dkXDOBase
Returns:
true if the objects have same values except pid and connection handle; false otherwise.
Throws:
DKException - If error occurred

notEqual

public boolean notEqual(dkXDOBase adkXDOBase)
                 throws DKException
Compares to see if the xdo objects are not equal
Overrides:
notEqual in class dkAbstractXDO
Parameters:
adkXDOBase - an instance of dkXDOBase
Returns:
true if the objects don't have same values except pid and connection handle; false otherwise.
Throws:
DKException - If error occurred

getPid

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

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

setPid

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

Replaces the existing persistent ID object for this DKBlobV4 object with the given object.
Overrides:
setPid in class dkAbstractXDO
Parameters:
aDKPid - a persistent ID object
Throws:
DKUsageError - If error occurred
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 with the new provided 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 the object content in the datastore.
Overrides:
add in class dkAbstractXDO
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

add

public void add(java.lang.String aFullFileName)
         throws DKException,
                java.lang.Exception
Adds the object content(from existing file) to the datastore.
Overrides:
add in class dkAbstractXDO
Parameters:
aFullFileName - the file name
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieves the object content to a buffer area from datastore.
Overrides:
retrieve in class dkAbstractXDO
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

retrieve

public void retrieve(java.lang.String aFileName)
              throws DKException,
                     java.lang.Exception
Retrieves the object content from the Datastore to a file. Not supported by this datastore type.
Overrides:
retrieve in class dkAbstractXDO
Parameters:
aFileName - the file name
Throws:
DKException - always

update

public void update(java.lang.String aFileName)
            throws DKException,
                   java.lang.Exception
Updates the object in datastore with a file - not supported by this datastore type
Overrides:
update in class dkAbstractXDO
Parameters:
aFileName - the file name
Throws:
DKException - always

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates the object content in the datastore
Overrides:
update in class dkAbstractXDO
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes the object content from the datastore.
Overrides:
del in class dkAbstractXDO
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

del

public void del(boolean flush)
         throws DKException,
                java.lang.Exception
Deletes the object content from the datastore with the given flush flag
Overrides:
del in class dkAbstractXDO
Parameters:
flush - true if the content in memoryl is to be flushed. false: if the content is not set in memory, the object will be retreived before deleting it.
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

copyData

public void copyData(dkXDO adkXDO)
              throws DKException,
                     java.lang.Exception
Replaces the LOB data of this object with the contents of the given XDO object.
Overrides:
copyData in class dkAbstractXDO
Parameters:
adkXDO - the xdo object to replace with
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

compareData

public boolean compareData(dkXDO adkXDO)
                    throws DKException,
                           java.lang.Exception
Compares the LOB data content with the given XDO object
Overrides:
compareData in class dkAbstractXDO
Parameters:
adkXDO - the xdo object to compare with
Returns:
true if the objects are equal; false otherwies
Throws:
DKException - If error occurred
DKException - If error occurred

setContent

public void setContent(byte[] aByteArray)
Replaces the LOB data of this object with the given byte array.
Overrides:
setContent in class dkAbstractXDO
Parameters:
aByteArray - the byte array
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

getContent

public byte[] getContent()
                  throws DKException,
                         java.lang.Exception
Gets the Stream object containing the LOB data of this object.
Overrides:
getContent in class dkAbstractXDO
Returns:
the data in a byte array
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

getContentToClientFile

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

concatReplace

public dkBlob concatReplace(dkBlob adkBlob)
                     throws DKException,
                            java.lang.Exception
Concatenates this object with the given dkBlob object, the results of the concatenation replaces the existing contents of this object.
Overrides:
concatReplace in class dkBlob
Parameters:
adkBlob - the BLob object to concatenate with
Returns:
the resulting BLob object
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

concatReplace

public dkBlob concatReplace(byte[] aByteArr)
                     throws DKException,
                            java.lang.Exception
Concatenates this object with the given stream, the results of the concatenation replaces the existing contents of this object.
Overrides:
concatReplace in class dkBlob
Parameters:
aByteArr - the byte array
Returns:
the resulting BLob object
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

length

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

indexOf

public int indexOf(java.lang.String aString,
                   int startPos)
            throws DKException,
                   java.lang.Exception
Gets the byte offset of the first occurrence of the search argument within this object, starting the search at offset startPos.
Overrides:
indexOf in class dkBlob
Parameters:
aString - the search string
startPos - the starting position to begin the search
Returns:
the byte offset of the first occurrence of the search argument; 0 if the search argument is not found
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

indexOf

public int indexOf(dkBlob adkBlob,
                   int startPos)
            throws DKException,
                   java.lang.Exception
Gets the byte offset of the first occurrence of the search argument within this object, starting the search at offset startPos.
Overrides:
indexOf in class dkBlob
Parameters:
adkBlob - the search object
startPos - the starting position to begin the search
Returns:
the byte offset of the first occurrence of the search argument; 0 if the search argument is not found
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

subString

public java.lang.String subString(int startPos,
                                  int length)
                           throws DKException,
                                  java.lang.Exception
Gets an String object containing a substring of the LOB data of this object.
Overrides:
subString in class dkBlob
Parameters:
startPos - the starting position for the substring
length - the length of the substring
Returns:
the substring
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

remove

public dkBlob remove(int startPos,
                     int length)
              throws DKException,
                     java.lang.Exception
Deletes the portion of the LOB data of this object starting at startPos for length bytes.
Overrides:
remove in class dkBlob
Parameters:
startPos - the starting position for the substring to be deleted
length - the length of the substring to be deleted
Returns:
the resulting LOB data
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

insert

public dkBlob insert(java.lang.String aString,
                     int startPos)
              throws DKException,
                     java.lang.Exception
Inserts the argument data, starting at position startPos in the LOB data of this object.
Overrides:
insert in class dkBlob
Parameters:
aString - the string to be inserted
startPos - the starting position for the substring to be inserted
Returns:
the resulting LOB data
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

insert

public dkBlob insert(dkBlob adkBlob,
                     int startPos)
              throws DKException,
                     java.lang.Exception
Inserts the argument data, starting at position startPos in the LOB data of this object.
Overrides:
insert in class dkBlob
Parameters:
adkBlob - the LOB data to be inserted
startPos - the starting position for the substring to be inserted
Returns:
the resulting LOB data
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

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 - if error detected
java.lang.Exception - If error occurred

open

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

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 instance.
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 current program name

isOpenSynchronous

public boolean isOpenSynchronous()
Gets the current synchronization property
Overrides:
isOpenSynchronous in class dkAbstractXDO
Returns:
true, if synchronous; false, otherwise.

getRepType

public java.lang.String getRepType()
Gets the VI400 representation type of the piece of content
Returns:
the VI400 representation type of the piece of content

setRepType

public void setRepType(java.lang.String aRType)
                throws DKException
Sets the VI400 representation type of the piece of content
Parameters:
aRType - the VI400 representation type of the piece of content

getItemId

public java.lang.String getItemId()
Gets the V4 item id of the object content
Returns:
the V4 item id of the object content

setItemId

public void setItemId(java.lang.String aItemId)
Sets the V4 item id of the object content
Parameters:
aRType - the V4 item id of the object content

getContentClass

public int getContentClass()
Gets the content class of the object
Returns:
the content class of the object. SIM_CC_UNKNOWN indicates undefined content class.

setContentClass

public void setContentClass(int aCClass)
Sets the content class of the object
Parameters:
aCClass - the content class. SIM_CC_UNKNOWN indicates undefined content class

getAffiliatedType

public int getAffiliatedType()
                      throws DKException,
                             java.lang.Exception
Gets the affiliated type of the object
Overrides:
getAffiliatedType in class dkAbstractXDO
Returns:
The affiliated type of the object. If DK_CM_ANNOTATION, the getExtension("DKAnnotationV4") should point to DKAnnotationV4.

setAffiliatedType

public void setAffiliatedType(int aAType)
                       throws DKException,
                              java.lang.Exception
Sets the affiliated type of the object
Overrides:
setAffiliatedType in class dkAbstractXDO
Parameters:
aATyp - the affiliated type of the object

getAffiliatedData

public DKAnnotation getAffiliatedData()
Deprecated. Replaced by getExtension(String extensionName)

Gets the affiliated data of this object. If the affiliatedType is DK_CM_ANNOTATION, the DKAnnotation object will be returned.
Returns:
a DKAnnotation object contains the annotation data information
See Also:
getExtension(String extensionName)

setAffiliatedData

public void setAffiliatedData(DKAnnotation anAnnotation)
Deprecated. Replaced by setExtension(..)

Sets the affiliated data of this object
Parameters:
anAnnotation - a DKAnnotation object contains the annotation data information
See Also:
setExtension(String extensionName, dkExtension extensionObj)

getIndexFlag

public boolean getIndexFlag()
Deprecated. Replaced by isCategoryOf(int) method of this class

Gets the flag that indicates a part object is indexed by a search engine - not supported by this datastore type
Returns:
false always
See Also:
isCategoryOf(int)

setIndexFlag

public void setIndexFlag(boolean aFlag)
                  throws DKException,
                         java.lang.Exception
Deprecated. don't use this method

Sets the flag that indicates a part object is to be indexed by a search engine - not supported by this datastore type
Parameters:
aFlag - a flag to indicate the part object is to be indexed by a search engine
Throws:
DKException - always

concatenate

public DKBlobV4 concatenate(DKBlobV4 aDKBlobV4)
                     throws DKException,
                            java.lang.Exception
Concatenates this object with the given object
Parameters:
aDKBlobV - the object to concatenate with
Returns:
a DKBlobV4 object containing the result.
Throws:
DKException - if error detected
java.lang.Exception - if error detected

concatenate

public DKBlobV4 concatenate(byte[] aByteArr)
                     throws DKException,
                            java.lang.Exception
Concatenates this object with the given stream
Parameters:
aByteArr - the byte array to concatenate with
Returns:
a DKBlobV4 object containing the result.
Throws:
DKException - if error detected
java.lang.Exception - if error detected

subLob

public DKBlobV4 subLob(int startPos,
                       int length)
                throws DKException,
                       java.lang.Exception
Similar to subString, but returns the subString data in the form of a DKBlobV4 object.
Parameters:
startPos - the starting position for the subset of the data
length - the length of the subset of the data
Returns:
the DKBlobV4 object, the subset of the data
Throws:
DKException - if error detected
java.lang.Exception - if error detected

setRank

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

getRank

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

getMimeType

public java.lang.String getMimeType()
                             throws DKException,
                                    java.lang.Exception
Gets the MIME type representing this object's contentClass - not supported
Overrides:
getMimeType in class dkAbstractXDO
Returns:
always null string

mimeType

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

setToBeIndexed

public void setToBeIndexed()
                    throws DKException,
                           java.lang.Exception
Index an existing part object by search engine - not supported by this datastore type
Throws:
DKException - always

getCreatedTimestamp

public java.lang.String getCreatedTimestamp()
                                     throws DKException,
                                            java.lang.Exception
Gets the date and time that the object was created
Returns:
the object creation time stamp
Throws:
DKException - if error detected
java.lang.Exception - if error detected

getUpdatedTimestamp

public java.lang.String getUpdatedTimestamp()
                                     throws DKException,
                                            java.lang.Exception
Gets the date and time that the object was updated
Returns:
the object updated time stamp
Throws:
DKException - if error detected
java.lang.Exception - if error detected

getRetrievalAction

public int getRetrievalAction()
                       throws DKException,
                              java.lang.Exception
Deprecated. Replaced by getOption(int option)

Gets the retrieval option to perform the retrieve action.
Returns:
the retrieval option
Throws:
DKException - if error detected
java.lang.Exception - if error detected
See Also:
getOption(int)

setRetrievalAction

public void setRetrievalAction(int aRetriveAction)
                        throws DKException,
                               java.lang.Exception
Deprecated. Replaced by setOption(int option, Object value)

Sets the retrieval option to perform the retrieve action.
Parameters:
the - retrieval option
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred
See Also:
setOption(int, Object)

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 length of this object without retrieving the object
Returns:
the length of this object
Throws:
DKException - if error detected
DKException - if error detected

getOption

public java.lang.Object getOption(int option)
                           throws DKException,
                                  java.lang.Exception
Gets the delete or retrieval option to perform the delete or retrieve action.
Overrides:
getOption in class dkAbstractXDO
Returns:
a delete or retrieval option
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

setOption

public void setOption(int option,
                      java.lang.Object value)
               throws DKException,
                      java.lang.Exception
Sets the delete or retrieval option to perform the delete or retrieve action.
Overrides:
setOption in class dkAbstractXDO
Parameters:
option - an option

The valid options are:

  • DK_V4_OPT_DELETE_OPTION: for delete
  • DK_V4_OPT_RETRIEVAL_ACTION: for retrieve

value - the option value

For DK_V4_OPT_DELETE_OPTION, the valid values are:

For DK_V4_OPT_RETRIEVAL_ACTION, the valid values are:

  • DK_RETRIEVAL_GET_IT
  • DK_RETRIEVAL_GET_IT_PREFETCH
  • DK_RETRIEVAL_NO_MOUNT
  • DK_RETRIEVAL_NO_MOUNT_PREFETCH
  • DK_RETRIEVAL_STAGE_IT
  • DK_RETRIEVAL_STAGE_IT_PREFETCH
Throws:
DKException - If error occurred

setExtension

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

The valid extension names are:

  • DKAnnotationV4
    • For a dkAnnotationExt or DKAnnotationV4 object, you need to set this extension object to hold the annotation.

  • DKStorageManageInfoV4
    • 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 object
Throws:
DKException - If error occurred
java.lang.Exception - if error detected

addExtension

public void addExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
Adds the extension object.
Overrides:
addExtension in class dkAbstractXDO
Parameters:
extensionName - the extension name
extensionObj - a source extension object
Throws:
DKException - If error occurred
java.lang.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 - If error occurred
java.lang.Exception - If error occurred

removeExtension

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

The valid extension names are:

Throws:
DKException - If error occurred

isCategoryOf

public boolean isCategoryOf(int categoryName)
                     throws DKException,
                            java.lang.Exception
Checks the object category.
Parameters:
categoryName - the category name

Returns:
false always
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

retrieveObjectState

public int retrieveObjectState(int object)
                        throws DKException,
                               java.lang.Exception
Retrieves the state of search indexed object
Parameters:
object - the type of object

The valid input is:

  • DK_INDEXED_OBJECT
Returns:
the object state

For search indexed object, the valid states are:

  • 256 : to be updated
  • 512 : to be deleted
  • 769 : queued update
  • 770 : queued delete
  • 1024 : indexed
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

changeStorage

public void changeStorage()
                   throws DKException,
                          java.lang.Exception
Changes the system-managed storage (SMS) criteria for an object.

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.

Throws:
DKException, - Exception If error occurred

getPartId

public int getPartId()
Gets the part id of this XDO
Returns:
the part id

setPartId

public void setPartId(int partId)
Gets the part id of this XDO
Returns:
the part id

EIP Java APIs

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