Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKBlobOD

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

public class DKBlobOD
extends dkBlob
implements DKConstantOD, DKMessageId, java.io.Serializable

DKBlobOD: a BLOB (XDO) represents a part object of OnDemand

See Also:
Serialized Form

Field Summary
static short APPEND
           
static short NOOVERWRITE
           
static short OVERWRITE
           
static short TODO
           
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantOD
    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
DKBlobOD(DKBlobOD aDKBlobOD)
          Copy constructor.
DKBlobOD(dkDatastore aDatastore)
          Constructs the BLOB and defers initialization until implementation methods are called.
DKBlobOD(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.
 boolean compareData(dkXDO adkXDO)
          Compares the LOB data content with the given XDO object
 DKBlobOD concatenate(byte[] aByteArr)
          Concatenates this object with the given stream
 DKBlobOD concatenate(DKBlobOD aDKBlobOD)
          Concatenates this object with the given object
 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 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
 DKAnnotationOD 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 Stream object containing the LOB data of this object.
 void getContentToClientFile(java.lang.String afileName, int fileOption)
          Copies the LOB data of this object to the named file.
 long getEntityId()
           
 dkExtension getExtension(java.lang.String extensionName)
          Gets the extension object.
 java.lang.String getMimeType()
          Gets the MIME type represents this object's contentClass
 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 option to perform the linedata to ASCII conversion.
 int getOptionInt(int option)
           
 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 length of this object without retrieving the object
 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 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.
 int partId()
          Gets the part id of this XDO
 dkBlob remove(int startpos, int alength)
          Deprecated. no need to do this, no meaning
 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(DKAnnotationOD 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)
          Replaces the LOB data of this object with the given byte array.
 void setContentFromClientFile(java.lang.String afileName)
          Replaces the LOB data of this object with the contents of the given file
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setEntityId(long id)
           
 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 instance.
 void setMimeType(java.lang.String mimetype)
          Sets the MIME type for this object.
 void setNull()
          Sets the part content to null (in memory).
 void setOption(int option, java.lang.Object value)
          Sets the option to perform the linedata to ASCII conversion.
 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
 int size()
          Gets the size of this object content in the datastore
 DKBlobOD subLob(int startPos, int length)
          Similar to subString, but returns the subString data in the form of a DKBlobOD object.
 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 aFullFileName)
          Updates the object content in datastore with a file
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractXDO
cloneSkeleton, datastore, getClassName, getContentType, getDatastore, getParent, getRootObject, protocol, setClassName, setContentType, setParent, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TODO

public static final short TODO

OVERWRITE

public static final short OVERWRITE

NOOVERWRITE

public static final short NOOVERWRITE

APPEND

public static final short APPEND
Constructor Detail

DKBlobOD

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

DKBlobOD

public DKBlobOD(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

DKBlobOD

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

getObjectType

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

getEntityId

public long getEntityId()

setEntityId

public void setEntityId(long id)

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. Replace by getPidObject()

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

setPid

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

Replaces the existing persistent ID object for this DKBlobOD 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.
Overrides:
retrieve in class dkAbstractXDO
Parameters:
aFileName - the file name
Throws:
DKException - If error occurred
java.lang.Exception - If error occurred

update

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

update

public void update(java.lang.String aFullFileName)
            throws DKException,
                   java.lang.Exception
Updates the object content in datastore with a file
Overrides:
update in class dkAbstractXDO
Parameters:
aFileName - a fully qualified path and file name, default is current directory
Throws:
DKException, - 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
Deprecated. no need to do this, no meaning

Concatenates this object content with another 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 content with another 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()
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
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 - 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.

getAffiliatedType

public int getAffiliatedType()
Gets the affiliated type of the object if DK_ANNOTATION, the getExtension("DKAnnotationDL") should point to DKAnnotationDL
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
Overrides:
setAffiliatedType in class dkAbstractXDO
Parameters:
aAType - the affiliated type of the object

getAffiliatedData

public DKAnnotationOD getAffiliatedData()
Deprecated. Replace by getExtension(String extensionName)

Gets the affiliated data of this object, if the affiliatedType is DK_ANNOTATION, this should get the DKAnnotation object.
Returns:
a DKAnnotation object contains the annotation data informations
See Also:
getExtension(String extensionName)

setAffiliatedData

public void setAffiliatedData(DKAnnotationOD apAData)
Deprecated. Replace by setExtension(..)

Sets the affiliated data of this object, if the affiliatedType is DK_ANNOTATION, this should be provided.
Parameters:
apAData - a DKAnnotation object contains the annotation data informations
See Also:
setExtension(String extensionName, dkExtension extensionObj)

concatenate

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

concatenate

public DKBlobOD 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 DKBlobOD object containing the result.
Throws:
DKException - if error detected
java.lang.Exception - if error detected

subLob

public DKBlobOD subLob(int startPos,
                       int length)
                throws DKException,
                       java.lang.Exception
Similar to subString, but returns the subString data in the form of a DKBlobOD object.
Parameters:
startPos - the starting position for the subset of the data
length - the length of the subset of the data
Returns:
the DKBlobOD 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 represents this object's contentClass
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 representing this object's contentClass
Returns:
the MIME type
Throws:
DKException - if error detected
java.lang.Exception - if error detected

setMimeType

public void setMimeType(java.lang.String mimetype)
Description copied from class: dkAbstractXDO
Sets the MIME type for this object. The subclass need to override the behaviour of the default implementation of this method.

Note:DKUsageError exception thrown if method is not implemented

Overrides:
setMimeType in class dkAbstractXDO
Following copied from class: com.ibm.mm.sdk.common.dkAbstractXDO
Parameters:
mimeType - the MIME type
See Also:
dkAbstractXDO.getMimeType()

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 option to perform the linedata to ASCII conversion.
Overrides:
getOption in class dkAbstractXDO
Returns:
an ASCII conversion option
Throws:
DKException, - Exception If error occurred

getOptionInt

public int getOptionInt(int option)
                 throws DKException,
                        java.lang.Exception

setOption

public void setOption(int option,
                      java.lang.Object value)
               throws DKException,
                      java.lang.Exception
Sets the option to perform the linedata to ASCII conversion.
Overrides:
setOption in class dkAbstractXDO
Parameters:
option - an option

The valid options are:

  • DK_CM_OPT_XDO_TEXT_CONVERSION
  • DK_CM_OPT_XDO_AFP_CONVERSION
  • DK_CM_OPT_XDO_VIEWER
value - the option value

For DK_CM_OPT_XDO_TEXT_CONVERSION, the valid value is:

  • DK_CM_TEXT_ASCII

For DK_CM_OPT_XDO_AFP_CONVERSION, the valid values are:

  • DK_CM_AFP_HTML
  • DK_CM_AFP_PDF

For DK_CM_OPT_XDO_VIEWER, the valid values are:

  • DK_CM_APPLET
  • DK_CM_PLUGIN
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.
Parameters:
extensionName - the extension name

The valid extension names are:

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

The valid category name is:

  • DK_INDEXED_OBJECT
Returns:
true if the object is the specified category; false otherwise.
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

partId

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

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Overrides:
setDatastore in class dkAbstractXDO
Parameters:
ds - a dkDatastore

EIP Java APIs

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