|
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.dkClob | +--com.ibm.mm.sdk.common.DKClobJDBC
DKClobJDBC: a Clob (XDO) represents a part object of JDBC
Field Summary | |
static short |
APPEND
|
static short |
NOOVERWRITE
|
static short |
OVERWRITE
|
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.DKMessageIdJDBC |
DK_JDBC_MSG_MSGID_ADD_FAILED, DK_JDBC_MSG_MSGID_DELETE_FAILED, DK_JDBC_MSG_MSGID_NOT_FOUND, DK_JDBC_MSG_MSGID_RETRIEVE_FAILED, DK_JDBC_MSG_MSGID_SQL_ERROR, DK_JDBC_MSG_MSGID_UPDATE_FAILED |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKClobJDBC()
Constructs the Clob and defers initialization until implementation methods are called. |
|
DKClobJDBC(DKClobJDBC aDKClobJDBC)
Copy constructor. |
|
DKClobJDBC(dkDatastore aDatastore)
Constructs the Clob and defers initialization until implementation methods are called. |
|
DKClobJDBC(dkDatastore aDatastore,
byte[] aByteArr)
Constructs the Clob and set the object's content. |
Method Summary | |
void |
add()
Adds the object content from memory to the datastore |
void |
add(java.lang.String aFullFileName)
Adds the object content from existing file to the datastore |
dkXDO |
cloneSkeleton()
Clone this XDO with its persistent-id only, that is, with its data content set to empty. |
boolean |
compareData(dkXDO adkXDO)
Compares the content of this object with the content of the other XDO object |
void |
copyData(dkXDO adkXDO)
Replaces the content of this object with the content of the other XDO object |
void |
del()
Deletes the object content from datastore |
void |
del(boolean flush)
Deletes the object content from datastore |
void |
deletingValue()
Deprecated. no meaning for Digital Library |
boolean |
equals(dkXDOBase adkXDOBase)
Deprecated. no need to do this, no meaning |
java.lang.String |
getColumn()
Gets the column name of this object content (a convenient way to get the persistent information) |
byte[] |
getContent()
Gets the content of this object |
void |
getContentToClientFile(java.lang.String afileName,
int fileOption)
Copies the lob data of this object to the given file name |
java.lang.String |
getDataPredicate()
Gets the predicate that indicate the object (a convenient way to get the persistent information) |
java.lang.String |
getMimeType()
Gets the MIME type represents this object's content |
java.lang.String |
getObjectType()
Gets the object type. |
java.lang.String |
getOpenHandler()
Gets the current program name of the handler for this object instance |
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 |
java.lang.String |
getTable()
Gets the table name of this object content (a convenient way to get the persistent information) |
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 content in memory |
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. |
void |
retrieve()
Retrieves the object content from the datastore to the memory buffer |
void |
retrieve(java.lang.String aFileName)
Retrieves the object content from the datastore to a file name |
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 |
setColumn(java.lang.String aColumnName)
Sets the column name of this object content (a convenient way to set the persistent information) |
void |
setContent(byte[] aByteArray)
Sets the content of this object with a byte array stream argument |
void |
setContentFromClientFile(java.lang.String afileName)
Replaces the lob data of this object with the contents of the file afileName |
void |
setDataPredicate(java.lang.String aDataPredicate)
Sets the predicate that indicate the object (a convenient way to set the persistent information) |
void |
setDatastore(dkDatastore ds)
Sets the reference to the owner datastore 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 instant |
void |
setNull()
Sets the part content to null (in memory). |
void |
setPid(DKPid aPidXDO)
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 |
void |
setTable(java.lang.String aTableName)
Sets the table name of this object content (a convenient way to set the persistent information) |
int |
size()
Gets the size of this object from datastore without retrieve object content. |
void |
update()
Updates the object content in datastore with the content in memory |
void |
update(java.lang.String aFileName)
Updates the object content in datastore with a file |
Methods inherited from class com.ibm.mm.sdk.common.dkClob |
concatReplace, concatReplace, indexOf, indexOf, insert, insert, remove, subString |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractXDO |
addExtension, datastore, getAffiliatedType, getClassName, getContentType, getDatastore, getExtension, getOption, getParent, getRootObject, protocol, removeExtension, setAffiliatedType, setClassName, setContentType, setMimeType, setOption, setParent, setRootObject |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final short OVERWRITE
public static final short NOOVERWRITE
public static final short APPEND
Constructor Detail |
public DKClobJDBC() throws DKUsageError, java.lang.Exception
DKUsageError,
- Exception If invalid datastore typepublic DKClobJDBC(dkDatastore aDatastore) throws DKUsageError, java.lang.Exception
aDatastore
- a DKDatastoreJDBC representing the associated JDBC datastoreDKUsageError,
- Exception If invalid datastore typepublic DKClobJDBC(dkDatastore aDatastore, byte[] aByteArr) throws DKException, java.lang.Exception
aDatastore
- a DKDatastoreJDBC representing the associated JDBC datastoreaByteArr
- a byte array to be set as this object's contentDKException,
- Exception If error occurredpublic DKClobJDBC(DKClobJDBC aDKClobJDBC) throws DKException
aDKClobJDBC
- an instance of DKClobJDBCDKException
- 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 and content
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, and content
false
otherwise.DKException
- If objects are not the same classpublic DKPid getPid()
getPid
in class dkAbstractXDO
getPidObject()
public void setPid(DKPid aPidXDO) 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() throws DKException, java.lang.Exception
update
in class dkAbstractXDO
DKException,
- 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 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 true.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 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 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 int size() throws DKException, java.lang.Exception
size
in class dkAbstractXDO
DKException,
- Exception If error occurredpublic int length() throws DKException, java.lang.Exception
length
in class dkAbstractXDO
public dkXDO cloneSkeleton() throws DKUsageError, java.lang.Exception
cloneSkeleton
in class dkAbstractXDO
public java.lang.String getTable()
public void setTable(java.lang.String aTableName)
aTableName
- the table name of the object contentpublic java.lang.String getColumn()
public void setColumn(java.lang.String aColumnName)
aColumnName
- the column name of the object contentpublic java.lang.String getDataPredicate()
public void setDataPredicate(java.lang.String aDataPredicate)
aDataPredicate
- a predicate that indicate the objectpublic 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 |