|
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.server.dkAbstractDatastore | +--com.ibm.mm.sdk.server.DKDatastoreJDBC
The DKDatastoreJDBC class is the JDBC implementation of the abstract class dkDatastore. The datastore provides facilities to query, retrieve, update, store, and manage rows stored in a database table.
IBM Confidential
dkDatastore
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 | |
DKDatastoreJDBC()
Constructs the datastore and initializes the datastore. |
|
DKDatastoreJDBC(java.lang.String configuration)
|
Method Summary | |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Adds a new extension object. |
void |
addObject(dkDataObject ddo)
Adds this ddo to this datastore. |
void |
commit()
Commits a datastore transaction |
void |
connect(java.lang.String datastore_name,
java.lang.String user_name,
java.lang.String authentication,
java.lang.String connect_string)
Connects to a datastore. |
DKHandle |
connection()
Gets the connection handle for a datastore |
DKDDO |
createDDO(java.lang.String objectType,
int Flags)
Creates a new DDO with object type, properties and attributes set for a given backend server. |
java.lang.String |
createPidIdString(DKNVPair[] list)
Builds the Pid Id string based on the specified column, value pairs |
dkQuery |
createQuery(DKCQExpr qe)
Creates a query object. |
dkQuery |
createQuery(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Creates a query object. |
dkDatastoreDef |
datastoreDef()
Get datastore definition |
java.lang.String |
datastoreName()
Gets the name of this datastore object. |
java.lang.String |
datastoreType()
Gets the datastore type for this datastore object |
void |
deleteObject(dkDataObject ddo)
Deletes this ddo from this datastore. |
void |
destroy()
datastore destroy - datastore cleanup if needed |
void |
disconnect()
Disconnects to a datastore. |
java.lang.Object |
evaluate(DKCQExpr qe)
evaluates the query. |
java.lang.Object |
evaluate(dkQuery query)
evaluates the query. |
java.lang.Object |
evaluate(java.lang.String command,
short commandLangType,
DKNVPair[] params)
evaluates the query. |
dkResultSetCursor |
execute(DKCQExpr cqe)
executes the query. |
dkResultSetCursor |
execute(dkQuery query)
executes the query. |
dkResultSetCursor |
execute(java.lang.String command,
short commandLangType,
DKNVPair[] params)
executes the query. |
void |
executeWithCallback(DKCQExpr qe,
dkCallback callbackObj)
execute the query with callback function. |
void |
executeWithCallback(dkQuery query,
dkCallback callbackObj)
execute the query with callback function. |
void |
executeWithCallback(java.lang.String command,
short commandLangType,
DKNVPair[] params,
dkCallback callbackObj)
execute the query with callback function. |
int |
getCallbkCnt()
|
dkExtension |
getExtension(java.lang.String extensionName)
Gets the extension object from a given extenstion name. |
dkSchemaMapping |
getMapping(java.lang.String mappingName)
Get mapping information for this datastore |
java.lang.Object |
getOption(int option)
Gets a datastore option. |
int |
getRSCCnt()
|
DKHandle |
handle(java.lang.String type)
Gets a datastore handle |
boolean |
isConnected()
Checks to see if the datastore is connected. |
java.lang.String[] |
listDataSourceNames()
List the available datastore source names that can be used to connect with. |
dkCollection |
listDataSources()
List the available datastore sources that can be used to connect with. |
dkCollection |
listEntities()
Gets a list of entities from persistent datastore |
java.lang.String[] |
listEntityAttrNames(java.lang.String entityName)
Gets a list of attribute names for a given entity name. |
dkCollection |
listEntityAttrs(java.lang.String entityName)
Gets a list of attributes for a given entity name. |
java.lang.String[] |
listEntityNames()
Gets a list of entity names from persistent datastore |
java.lang.String[] |
listExtensionNames()
Gets the list of extension objects' names |
java.lang.String[] |
listMappingNames()
Gets the list of the register mappings for this datastore |
java.lang.Object |
listSchema()
Deprecated. Replace by listEntities |
java.lang.Object |
listSchemaAttributes(java.lang.String schemaEntry)
Deprecated. Replace by listEntityAttributes |
java.lang.Object |
listServers()
Deprecated. Replace by listDataSources |
DKNVPair[] |
parsePidIdString(java.lang.String Id)
Parses the Pid Id string into column, value pairs |
java.lang.String |
registerMapping(DKNVPair sourceMap)
Registers mapping information to this datastore |
void |
removeExtension(java.lang.String extensionName)
Remove an existing extension object |
void |
retrieveObject(dkDataObject ddo)
Retrieves this ddo from this datastore. |
void |
rollback()
Rollback a datastore transaction |
void |
setOption(int option,
java.lang.Object value)
Sets a datastore option. |
void |
unRegisterMapping(java.lang.String mappingName)
Unregisters mapping information for this datastore |
void |
updateObject(dkDataObject ddo)
Updates this ddo in this datastore. |
java.lang.String |
userName()
Gets the user name for this datastore object |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.mm.sdk.common.dkDatastore |
addObject, addObject, addObjects, addObjects, addObjects, changePassword, clearCache, clearCache, deleteObject, deleteObject, deleteObjects, deleteObjects, deleteObjects, evaluate, execute, executeWithCallback, listAvailableServices, listSearchableEntities, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, serviceMgr, startTransaction, updateObject, updateObject, updateObjects, updateObjects, updateObjects |
Constructor Detail |
public DKDatastoreJDBC() throws DKException, java.lang.Exception
public DKDatastoreJDBC(java.lang.String configuration) throws DKException, java.lang.Exception
Method Detail |
public void connect(java.lang.String datastore_name, java.lang.String user_name, java.lang.String authentication, java.lang.String connect_string) throws DKException, java.lang.Exception
connect
in interface dkDatastore
connect
in class dkAbstractDatastore
datastore_name
- the datastore name used for connectionuser_name
- the user name used for connectionauthentication
- the authentication used for connectionconnect_string
- the connect string used for connection. This
is used to provide additional connection options.public void disconnect() throws DKException, java.lang.Exception
disconnect
in interface dkDatastore
disconnect
in class dkAbstractDatastore
public java.lang.Object getOption(int option) throws DKException, java.lang.Exception
getOption
in interface dkDatastore
getOption
in class dkAbstractDatastore
option
- the option identifierpublic void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
setOption
in interface dkDatastore
setOption
in class dkAbstractDatastore
option
- the option identifiervalue
- the option valuepublic java.lang.Object evaluate(java.lang.String command, short commandLangType, DKNVPair[] params) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value pairpublic java.lang.Object evaluate(dkQuery query) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
query
- a query objectpublic java.lang.Object evaluate(DKCQExpr qe) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
qe
- a common query expression objectpublic dkResultSetCursor execute(java.lang.String command, short commandLangType, DKNVPair[] params) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value pairpublic dkResultSetCursor execute(dkQuery query) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
query
- a query objectpublic dkResultSetCursor execute(DKCQExpr cqe) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
cqe
- a common query expression objectpublic void executeWithCallback(dkQuery query, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
query
- a query objectcallbackObj
- a dkCallback objectpublic void executeWithCallback(java.lang.String command, short commandLangType, DKNVPair[] params, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value paircallbackObj
- a dkCallback objectpublic void executeWithCallback(DKCQExpr qe, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
qe
- a common query expression objectcallbackObj
- a dkCallback objectpublic dkQuery createQuery(java.lang.String command, short commandLangType, DKNVPair[] params) throws DKException, java.lang.Exception
createQuery
in interface dkDatastore
createQuery
in class dkAbstractDatastore
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value pairpublic dkQuery createQuery(DKCQExpr qe) throws DKException, java.lang.Exception
createQuery
in interface dkDatastore
createQuery
in class dkAbstractDatastore
qe
- a common query expression objectpublic void addObject(dkDataObject ddo) throws DKException, java.lang.Exception
addObject
in interface dkDatastore
addObject
in class dkAbstractDatastore
ddo
- the ddo to be added to this datastorepublic void retrieveObject(dkDataObject ddo) throws DKException, java.lang.Exception
retrieveObject
in interface dkDatastore
retrieveObject
in class dkAbstractDatastore
ddo
- the ddo to be retrieved from this datastorepublic void updateObject(dkDataObject ddo) throws DKException, java.lang.Exception
updateObject
in interface dkDatastore
updateObject
in class dkAbstractDatastore
ddo
- the ddo to be updated in this datastorepublic void deleteObject(dkDataObject ddo) throws DKException, java.lang.Exception
deleteObject
in interface dkDatastore
deleteObject
in class dkAbstractDatastore
ddo
- the ddo to be deleted from this datastorepublic void commit() throws DKException, java.lang.Exception
commit
in interface dkDatastore
commit
in class dkAbstractDatastore
public void rollback() throws DKException, java.lang.Exception
rollback
in interface dkDatastore
rollback
in class dkAbstractDatastore
public boolean isConnected() throws java.lang.Exception
isConnected
in interface dkDatastore
isConnected
in class dkAbstractDatastore
public java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in interface dkDatastore
datastoreName
in class dkAbstractDatastore
public java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in interface dkDatastore
datastoreType
in class dkAbstractDatastore
public DKHandle connection() throws java.lang.Exception
connection
in interface dkDatastore
connection
in class dkAbstractDatastore
public DKHandle handle(java.lang.String type) throws java.lang.Exception
handle
in interface dkDatastore
handle
in class dkAbstractDatastore
type
- type of datastore handle wantedpublic java.lang.String userName() throws java.lang.Exception
userName
in interface dkDatastore
userName
in class dkAbstractDatastore
public dkCollection listDataSources() throws DKException, java.lang.Exception
listDataSources
in interface dkDatastore
listDataSources
in class dkAbstractDatastore
public java.lang.String[] listDataSourceNames() throws DKException, java.lang.Exception
listDataSourceNames
in interface dkDatastore
listDataSourceNames
in class dkAbstractDatastore
public java.lang.Object listServers() throws DKException, java.lang.Exception
listServers
in interface dkDatastore
listServers
in class dkAbstractDatastore
listDataSources()
public java.lang.Object listSchema() throws DKException, java.lang.Exception
listSchema
in interface dkDatastore
listSchema
in class dkAbstractDatastore
listEntities()
public java.lang.Object listSchemaAttributes(java.lang.String schemaEntry) throws DKException, java.lang.Exception
listSchemaAttributes
in interface dkDatastore
listSchemaAttributes
in class dkAbstractDatastore
schemaEntry
- the name of the schema.listEntityAttrs(java.lang.String)
public dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in interface dkDatastore
listEntities
in class dkAbstractDatastore
DKException
- if error occurspublic java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in interface dkDatastore
listEntityNames
in class dkAbstractDatastore
DKException
- if error occurspublic dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in interface dkDatastore
listEntityAttrs
in class dkAbstractDatastore
entityName
- name of entity to retrieve attributes forDKException
- if the entity name does not existpublic java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrNames
in interface dkDatastore
listEntityAttrNames
in class dkAbstractDatastore
entityName
- name of entity to retrieve attribute names forDKException
- if the entity name does not existpublic dkDatastoreDef datastoreDef() throws DKException, java.lang.Exception
datastoreDef
in interface dkDatastore
datastoreDef
in class dkAbstractDatastore
public java.lang.String registerMapping(DKNVPair sourceMap) throws DKException, java.lang.Exception
registerMapping
in interface dkDatastore
registerMapping
in class dkAbstractDatastore
sourceMap
- source name and mappingpublic void unRegisterMapping(java.lang.String mappingName) throws DKException, java.lang.Exception
unRegisterMapping
in interface dkDatastore
unRegisterMapping
in class dkAbstractDatastore
mappingName
- name of the mapping informationpublic java.lang.String[] listMappingNames() throws DKException, java.lang.Exception
listMappingNames
in interface dkDatastore
listMappingNames
in class dkAbstractDatastore
public dkSchemaMapping getMapping(java.lang.String mappingName) throws DKException, java.lang.Exception
getMapping
in interface dkDatastore
getMapping
in class dkAbstractDatastore
mappingName
- name of the mapping informationpublic dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
getExtension
in interface dkDatastore
getExtension
in class dkAbstractDatastore
extensionName
- name of the extension object.public void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension
in interface dkDatastore
addExtension
in class dkAbstractDatastore
extensionName
- name of new extension objectextensionObj
- the extension object to be setpublic void removeExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
removeExtension
in interface dkDatastore
removeExtension
in class dkAbstractDatastore
extensionName
- name of extension object to be removedpublic java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
listExtensionNames
in interface dkDatastore
listExtensionNames
in class dkAbstractDatastore
public DKDDO createDDO(java.lang.String objectType, int Flags) throws DKException, java.lang.Exception
createDDO
in interface dkDatastore
createDDO
in class dkAbstractDatastore
objectType
- the name of the table and (optionally) schema in
the form
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |