|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractXDO | +--com.ibm.mm.sdk.common.dkBlob | +--com.ibm.mm.sdk.common.DKBlobOD
DKBlobOD: a BLOB (XDO) represents a part object of OnDemand
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 |
public static final short TODO
public static final short OVERWRITE
public static final short NOOVERWRITE
public static final short APPEND
Constructor Detail |
public DKBlobOD(dkDatastore aDatastore) throws DKUsageError, java.lang.Exception
aDatastore
- an instance of DKDatastoreODDKUsageError
- If invalid datastore typejava.lang.Exception
- if error detectedpublic DKBlobOD(dkDatastore aDatastore, byte[] aByteArr) throws DKException, java.lang.Exception
aDatastore
- an instance of dkDatastoreaByteArr
- a byte array to be set as this object's contentDKException
- If error occurredjava.lang.Exception
- if error detectedpublic DKBlobOD(DKBlobOD aDKBlobOD) throws DKException
aDKBlobOD
- an instance of DKBlobODDKException
- If error occurredMethod Detail |
public java.lang.String getObjectType()
public long getEntityId()
public void setEntityId(long id)
public void deletingValue()
public boolean isContentChanged()
isContentChanged
in class dkAbstractXDO
true
if the object content is changed;
false
otherwise.public boolean isSet()
isSet
in class dkAbstractXDO
true
if the object content is set;
false
otherwise.public boolean isNull()
isNull
in class dkAbstractXDO
true
if the object content is null;
false
otherwise.public void setNull()
setNull
in class dkAbstractXDO
public boolean equals(dkXDOBase adkXDOBase) throws DKException
equals
in class dkAbstractXDO
adkXDOBase
- an instance of dkXDOBasetrue
if the objects have same values except pid and
connection handle;
false
otherwise.DKException
- If error occurredpublic boolean notEqual(dkXDOBase adkXDOBase) throws DKException
notEqual
in class dkAbstractXDO
adkXDOBase
- an instance of dkXDOBasetrue
if the objects don't have same values except pid
and connection handle;
false
otherwise.DKException
- If error occurredpublic DKPid getPid()
getPid
in class dkAbstractXDO
getPidObject()
public void setPid(DKPid aDKPid) throws DKUsageError
setPid
in class dkAbstractXDO
aDKPid
- a persistent ID objectDKUsageError
- If error occurredsetPidObject(DKPid aPidXDO)
public DKPid getPidObject()
getPidObject
in class dkAbstractXDO
public void setPidObject(DKPid aPidXDO) throws DKException
setPidObject
in class dkAbstractXDO
aPidXDO
- a DKPidXDO objectDKException
- If provided pid is nullpublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractXDO
DKException
- If error occurredjava.lang.Exception
- If error occurredpublic void add(java.lang.String aFullFileName) throws DKException, java.lang.Exception
add
in class dkAbstractXDO
aFullFileName
- the file nameDKException
- If error occurredjava.lang.Exception
- If error occurredpublic void retrieve() throws DKException, java.lang.Exception
retrieve
in class dkAbstractXDO
DKException
- If error occurredjava.lang.Exception
- If error occurredpublic void retrieve(java.lang.String aFileName) throws DKException, java.lang.Exception
retrieve
in class dkAbstractXDO
aFileName
- the file nameDKException
- If error occurredjava.lang.Exception
- If error occurredpublic void update() throws DKException, java.lang.Exception
update
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void update(java.lang.String aFullFileName) throws DKException, java.lang.Exception
update
in class dkAbstractXDO
aFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void del() throws DKException, java.lang.Exception
del
in class dkAbstractXDO
DKException
- If error occurredjava.lang.Exception
- If error occurredpublic void del(boolean flush) throws DKException, java.lang.Exception
del
in class dkAbstractXDO
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.DKException
- If error occurredjava.lang.Exception
- If error occurredpublic void copyData(dkXDO adkXDO) throws DKException, java.lang.Exception
copyData
in class dkAbstractXDO
adkXDO
- the xdo object to replace withDKException
- If error occurredjava.lang.Exception
- If error occurredpublic boolean compareData(dkXDO adkXDO) throws DKException, java.lang.Exception
compareData
in class dkAbstractXDO
adkXDO
- the xdo object to compare withDKException
- If error occurredDKException
- If error occurredpublic void setContent(byte[] aByteArray)
setContent
in class dkAbstractXDO
aByteArray
- the byte arrayDKException
- If error occurredjava.lang.Exception
- If error occurredpublic byte[] getContent() throws DKException, java.lang.Exception
getContent
in class dkAbstractXDO
DKException
- If error occurredjava.lang.Exception
- If error occurredpublic void getContentToClientFile(java.lang.String afileName, int fileOption) throws DKException, java.lang.Exception
getContentToClientFile
in class dkAbstractXDO
afileName
- the file name to write the data tofileOption
- 1: will create or overwrite an existing file;
2: will only create file, but will also throw an
exception if the file already exists;
3: appends to an existing fileDKException
- If error occurredjava.lang.Exception
- If error occurredpublic void setContentFromClientFile(java.lang.String afileName) throws DKException
setContentFromClientFile
in class dkAbstractXDO
afileName
- the file name to read the data fromDKException
- If error occurredpublic dkBlob concatReplace(dkBlob adkBlob) throws DKException, java.lang.Exception
concatReplace
in class dkBlob
adkBlob
- another dkBlob objectpublic dkBlob concatReplace(byte[] aByteArr) throws DKException, java.lang.Exception
concatReplace
in class dkBlob
aByteArr
- a byte array streampublic int length()
length
in class dkAbstractXDO
public int indexOf(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkBlob
astring
- the search string argumentstartpos
- the offset position start to searchpublic int indexOf(dkBlob adkBlob, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkBlob
adkBlob
- the lobData of this dkBlob is the search argumentstartpos
- the offset position start to searchpublic java.lang.String subString(int startpos, int alength) throws DKException, java.lang.Exception
subString
in class dkBlob
startpos
- the byte offset position start to extractalength
- the length to extractpublic dkBlob remove(int startpos, int alength) throws DKException, java.lang.Exception
remove
in class dkBlob
startpos
- the byte offset position start to deletealength
- the length to deletepublic dkBlob insert(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
insert
in class dkBlob
astring
- the argument string datastartpos
- the byte offset position start to insertpublic dkBlob insert(dkBlob adkBlob, int startpos) throws DKException, java.lang.Exception
insert
in class dkBlob
adkBlob
- the lobData of this dkBlob is the argument datastartpos
- the byte offset position start to insertpublic void open() throws DKException, java.lang.Exception
open
in class dkAbstractXDO
DKException
- if error detectedjava.lang.Exception
- If error occurredpublic void open(java.lang.String afileName) throws DKException, java.lang.Exception
open
in class dkAbstractXDO
afileName
- the file to unload the data toDKException
- if error detectedjava.lang.Exception
- if error detectedpublic void setInstanceOpenHandler(java.lang.String aHandler, boolean newSynchronousFlag)
setInstanceOpenHandler
in class dkAbstractXDO
aHandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public void setClassOpenHandler(java.lang.String aHandler, boolean newSynchronousFlag)
setClassOpenHandler
in class dkAbstractXDO
aHandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public java.lang.String getOpenHandler()
getOpenHandler
in class dkAbstractXDO
public boolean isOpenSynchronous()
isOpenSynchronous
in class dkAbstractXDO
public int getAffiliatedType()
getAffiliatedType
in class dkAbstractXDO
public void setAffiliatedType(int aAType)
setAffiliatedType
in class dkAbstractXDO
aAType
- the affiliated type of the objectpublic DKAnnotationOD getAffiliatedData()
getExtension(String extensionName)
public void setAffiliatedData(DKAnnotationOD apAData)
apAData
- a DKAnnotation object contains the annotation data informationssetExtension(String extensionName, dkExtension extensionObj)
public DKBlobOD concatenate(DKBlobOD aDKBlobOD) throws DKException, java.lang.Exception
aDKBlobV
- the object to concatenate withDKException
- if error detectedjava.lang.Exception
- if error detectedpublic DKBlobOD concatenate(byte[] aByteArr) throws DKException, java.lang.Exception
aByteArr
- the byte array to concatenate withDKException
- if error detectedjava.lang.Exception
- if error detectedpublic DKBlobOD subLob(int startPos, int length) throws DKException, java.lang.Exception
startPos
- the starting position for the subset of the datalength
- the length of the subset of the dataDKException
- if error detectedjava.lang.Exception
- if error detectedpublic void setRank(int aRank)
setRank
in class dkAbstractXDO
aRank
- the ranking valuepublic int getRank()
getRank
in class dkAbstractXDO
public java.lang.String getMimeType() throws DKException, java.lang.Exception
getMimeType
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic java.lang.String mimeType() throws DKException, java.lang.Exception
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic void setMimeType(java.lang.String mimetype)
dkAbstractXDO
Note:DKUsageError exception thrown if method is not implemented
setMimeType
in class dkAbstractXDO
com.ibm.mm.sdk.common.dkAbstractXDO
mimeType
- the MIME typedkAbstractXDO.getMimeType()
public int size() throws DKException, java.lang.Exception
size
in class dkAbstractXDO
public int getSize() throws DKException, java.lang.Exception
DKException
- if error detectedDKException
- if error detectedpublic java.lang.Object getOption(int option) throws DKException, java.lang.Exception
getOption
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic int getOptionInt(int option) throws DKException, java.lang.Exception
public void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
setOption
in class dkAbstractXDO
option
- an option
The valid options are:
value
- the option value
For DK_CM_OPT_XDO_TEXT_CONVERSION, the valid value is:
For DK_CM_OPT_XDO_AFP_CONVERSION, the valid values are:
For DK_CM_OPT_XDO_VIEWER, the valid values are:
DKException,
- Exception If error occurredpublic void setExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
extensionName
- the extension name
The valid extension names are:
extensionObj
- a source extension objectDKException
- If error occurredjava.lang.Exception
- if error detectedpublic void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension
in class dkAbstractXDO
extensionName
- the extension nameextensionObj
- a source extension objectDKException
- If error occurredjava.lang.Exception
- If error occurredpublic dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
getExtension
in class dkAbstractXDO
extensionName
- the extension name
The valid extension names are:
DKException
- If error occurredjava.lang.Exception
- If error occurredpublic void removeExtension(java.lang.String extensionName) throws DKException
removeExtension
in class dkAbstractXDO
extensionName
- the extension name
The valid extension names are:
DKException
- If error occurredpublic boolean isCategoryOf(int categoryName) throws DKException, java.lang.Exception
categoryName
- the category name
The valid category name is:
true
if the object is the specified category;
false
otherwise.DKException
- If error occurredjava.lang.Exception
- If error occurredpublic int retrieveObjectState(int object) throws DKException, java.lang.Exception
object
- the type of object
The valid input is:
For search indexed object, the valid states are:
DKException
- If error occurredjava.lang.Exception
- If error occurredpublic int partId()
public void setDatastore(dkDatastore ds)
setDatastore
in class dkAbstractXDO
ds
- a dkDatastore
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |