|
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.DKBlobIP
For ImagePlus 390, a blob (XDO) represents an IODM document or annotation object.
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.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 |
public DKBlobIP(dkDatastore aDatastore) throws DKUsageError, java.lang.Exception
aDatastore
- a DKDatastoreIP representing the associated IP datastoreDKUsageError,
- Exception If invalid datastore typepublic DKBlobIP(dkDatastore aDatastore, byte[] aByteArr) throws DKException, java.lang.Exception
aDatastore
- a DKDatastoreIP representing the associated IP datastoreaByteArr
- a byte array to be set as this object's contentDKException,
- Exception If error occurredpublic DKBlobIP(DKBlobIP aDKBlobIP) throws DKException
aDKBlobIP
- an instance of DKBlobIPDKException
- If error occurredMethod Detail |
public java.lang.String getObjectType()
public void deletingValue()
public boolean isContentChanged()
isContentChanged
in class dkAbstractXDO
true
if the object content is changed;
false
otherwise.public boolean isSet()
isSet
in class dkAbstractXDO
true
if the object content is set;
false
otherwise.public boolean isNull()
isNull
in class dkAbstractXDO
true
if the object content is null;
false
otherwise.public void setNull()
setNull
in class dkAbstractXDO
public boolean equals(dkXDOBase adkXDOBase) throws DKException
equals
in class dkAbstractXDO
adkXDOBase
- an instance of dkXDOBasetrue
if the objects have same type, pid, content and search index
false
otherwise.DKException
- If objects are not the same classpublic boolean notEqual(dkXDOBase adkXDOBase) throws DKException
notEqual
in class dkAbstractXDO
adkXDOBase
- an instance of dkXDOBasetrue
if the objects do not have same type, pid, content and search index
false
otherwise.DKException
- If objects are not the same classpublic DKPid getPid()
getPid
in class dkAbstractXDO
getPidObject()
public void setPid(DKPid aDKPid) throws DKUsageError
setPid
in class dkAbstractXDO
aDKPid
- a DKPidXDO objectDKUsageError
- If provided pid is nullsetPidObject(DKPid aPidXDO)
public DKPid getPidObject()
getPidObject
in class dkAbstractXDO
public void setPidObject(DKPid aPidXDO) throws DKException
setPidObject
in class dkAbstractXDO
aPidXDO
- a DKPidXDO objectDKException
- If provided pid is nullpublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void add(java.lang.String aFullFileName) throws DKException, java.lang.Exception
add
in class dkAbstractXDO
aFullFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void retrieve() throws DKException, java.lang.Exception
retrieve
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void retrieve(java.lang.String aFileName) throws DKException, java.lang.Exception
retrieve
in class dkAbstractXDO
aFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void update(java.lang.String aFileName) throws DKException, java.lang.Exception
update
in class dkAbstractXDO
aFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void update() throws DKException, java.lang.Exception
update
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void del() throws DKException, java.lang.Exception
del
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void del(boolean flush) throws DKException, java.lang.Exception
del
in class dkAbstractXDO
flush
- if true the memory content will be flush, if false
and content is not set, the object will be retreived before delete it.
The default is flush.DKException,
- Exception If error occurredpublic void copyData(dkXDO adkXDO) throws DKException, java.lang.Exception
copyData
in class dkAbstractXDO
adkXDO
- the other XDO objectDKException,
- Exception If error occurredpublic boolean compareData(dkXDO adkXDO) throws DKException, java.lang.Exception
compareData
in class dkAbstractXDO
adkXDO
- the other XDO objectDKException,
- Exception If object type is differentpublic void setContent(byte[] aByteArray)
setContent
in class dkAbstractXDO
aByteArray
- a byte arraypublic byte[] getContent() throws DKException, java.lang.Exception
getContent
in class dkAbstractXDO
DKException,
- Exception If object type is differentpublic void getContentToClientFile(java.lang.String afileName, int fileOption) throws DKException, java.lang.Exception
getContentToClientFile
in class dkAbstractXDO
afileName
- a fully qualified path with file name, default is current directory(if no path)fileOption
- 1 will create or overwrite an existing file; 2 will only create file, but
will also throw an exception if the file already exists; 3 appends to an existing fileDKException,
- Exception If error occurredpublic void setContentFromClientFile(java.lang.String afileName) throws DKException
setContentFromClientFile
in class dkAbstractXDO
afileName
- a fully qualified path with file name, default is current directory(if no path)DKException
- If error occurredpublic dkBlob concatReplace(dkBlob adkBlob) throws DKException, java.lang.Exception
concatReplace
in class dkBlob
adkBlob
- another dkBlob objectpublic dkBlob concatReplace(byte[] aByteArr) throws DKException, java.lang.Exception
concatReplace
in class dkBlob
aByteArr
- a byte array streampublic int length()
length
in class dkAbstractXDO
public int indexOf(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkBlob
astring
- the search string argumentstartpos
- the offset position start to searchpublic int indexOf(dkBlob adkBlob, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkBlob
adkBlob
- the lobData of this dkBlob is the search argumentstartpos
- the offset position start to searchpublic java.lang.String subString(int startpos, int alength) throws DKException, java.lang.Exception
subString
in class dkBlob
startpos
- the byte offset position start to extractalength
- the length to extractpublic dkBlob remove(int startpos, int alength) throws DKException, java.lang.Exception
remove
in class dkBlob
startpos
- the byte offset position start to deletealength
- the length to deletepublic dkBlob insert(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
insert
in class dkBlob
astring
- the argument string datastartpos
- the byte offset position start to insertpublic dkBlob insert(dkBlob adkBlob, int startpos) throws DKException, java.lang.Exception
insert
in class dkBlob
adkBlob
- the lobData of this dkBlob is the argument datastartpos
- the byte offset position start to insertpublic void open() throws DKException, java.lang.Exception
open
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic void open(java.lang.String afileName) throws DKException, java.lang.Exception
open
in class dkAbstractXDO
afileName
- a provided file nameDKException,
- Exception If error occurredpublic void setInstanceOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setInstanceOpenHandler
in class dkAbstractXDO
ahandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public void setClassOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setClassOpenHandler
in class dkAbstractXDO
ahandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public java.lang.String getOpenHandler()
getOpenHandler
in class dkAbstractXDO
public boolean isOpenSynchronous()
isOpenSynchronous
in class dkAbstractXDO
public int getContentClass() throws DKException, java.lang.Exception
public void setContentClass(int aCClass) throws DKException, java.lang.Exception
aCClass
- the content class of the objectpublic int getAffiliatedType()
getAffiliatedType
in class dkAbstractXDO
public void setAffiliatedType(int aAType)
setAffiliatedType
in class dkAbstractXDO
aAType
- the affiliated type of the objectpublic DKBlobIP concatenate(DKBlobIP aDKBlobIP) throws DKException, java.lang.Exception
aDKBlobIP
- another DKBlobIP objectDKException,
- Exception If error occurredpublic DKBlobIP concatenate(byte[] aByteArr) throws DKException, java.lang.Exception
aByteArr
- a byte array streamDKException,
- Exception If error occurredpublic void setRank(int aRank)
setRank
in class dkAbstractXDO
aRank
- a 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,
- Exception If error occurredpublic java.lang.String getCreatedTimestamp() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic java.lang.String getUpdatedTimestamp() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic int size() throws DKException, java.lang.Exception
size
in class dkAbstractXDO
public int getSize() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic void setExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
The valid extension names are:
For IP/390, the storage management info extension is required for the following actions:
extensionName
- the extension nameextensionObj
- a source extension objectDKException,
- Exception If error occurredpublic void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension
in class dkAbstractXDO
extensionName
- the extension nameextensionObj
- a source extension objectDKException,
- Exception If error occurredpublic dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
getExtension
in class dkAbstractXDO
extensionName
- the extension name
The valid extension names are:
DKException,
- Exception If error occurredpublic void removeExtension(java.lang.String extensionName) throws DKException
removeExtension
in class dkAbstractXDO
extensionName
- the extension name
The valid extension names are:
DKException
- If error occurredpublic void setPageCount(int aCount)
aCount
- number of pages in the documentpublic int getPageCount()
public void setDescription(java.lang.String desc)
desc
- description of the annotationpublic java.lang.String getDescription()
public DKDDO getDDO()
public void setDDO(DKDDO aDDO)
desc
- description of the annotation
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |