|
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.DKDatastoreIP
The DKDatastoreIP class is the ImagePlus/390 implementation of the abstract class dkDatastore. The ImagePlus/390 datastore provides facilities to query, retrieve, update, store, and manage documents stored on an ImagePlus/390 server.
IBM Confidential
dkDatastore
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.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 | |
DKDatastoreIP()
Constructs and initializes an ImagePlus/390 datastore. |
|
DKDatastoreIP(java.lang.String configuration)
Constructs and initializes an ImagePlus/390 datastore. |
Method Summary | |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Adds a new extension object, which provides a set of new functions. |
void |
addObject(dkDataObject ddo)
Adds the data object (DDO) to this datastore. |
java.lang.String |
checkedOutUserid(dkDataObject dobj)
Returns the userid who currently has the document or folder checked out. |
void |
checkIn(dkDataObject dobj)
Checkin (unlock) document or folder item from datastore. |
void |
checkOut(dkDataObject dobj)
Checkout document or folder item from datastore. |
void |
connect(java.lang.String datastore_name,
java.lang.String user_name,
java.lang.String authentication,
java.lang.String connect_string)
Connects to the datastore. |
DKHandle |
connection()
Returns the connection handle for the datastore. |
DKDDO |
createDDO(java.lang.String objectType,
int Flags)
Creates a new DDO with object type, properties and attributes set for the ImagePlus/390 back-end server. |
dkQuery |
createQuery(DKCQExpr qe)
Creates a query object using the specified common query expression. |
dkQuery |
createQuery(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Creates a query object using the specified parameters. |
dkDatastoreDef |
datastoreDef()
Returns the datastore definition for this datastore. |
java.lang.String |
datastoreName()
Returns the name of this datastore object. |
java.lang.String |
datastoreType()
Returns the datastore type for this datastore object. |
void |
deleteObject(dkDataObject ddo)
Deletes the data object (DDO) from the persistent store. |
void |
disconnect()
Disconnects from the backend server. |
java.lang.Object |
evaluate(DKCQExpr qe)
Evaluates a query and returns the result as an Object containing dkQueryableCollection. |
java.lang.Object |
evaluate(dkQuery query)
Evaluates a query and returns the result as an Object containing dkQueryableCollection. |
java.lang.Object |
evaluate(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Evaluates a query and returns the result as an Object containing dkQueryableCollection. |
dkResultSetCursor |
execute(DKCQExpr cqe)
Executes a command query against the datastore and returns a result set cursor. |
dkResultSetCursor |
execute(dkQuery query)
Executes a command query against the datastore and returns a result set cursor. |
dkResultSetCursor |
execute(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Executes a command query against the datastore and returns a result set cursor. |
void |
executeWithCallback(DKCQExpr qe,
dkCallback callbackObj)
Execute a query using a callback function. |
void |
executeWithCallback(dkQuery query,
dkCallback callbackObj)
Executes a query using a callback function. |
void |
executeWithCallback(java.lang.String command,
short commandLangType,
DKNVPair[] params,
dkCallback callbackObj)
Executes a query using a callback function. |
dkExtension |
getExtension(java.lang.String extensionName)
Returns the extension object of the given extension name. |
dkSchemaMapping |
getMapping(java.lang.String mappingName)
Returns the mapping definition for the specified registered mapping. |
java.lang.Object |
getOption(int option)
Returns the value of the specified datastore option. |
boolean |
isCheckedOut(dkDataObject dobj)
Check whether a document or folder item is checked out from datastore. |
boolean |
isConnected()
Checks to see if the datastore is connected. |
java.lang.String[] |
listDataSourceNames()
Returns a list of the names of the data sources that one can connect to. |
dkCollection |
listDataSources()
Returns a list of valid servers or data sources that one can connect to. |
dkCollection |
listEntities()
Returns the list of entities defined in this datastore. |
java.lang.String[] |
listEntityAttrNames(java.lang.String entityName)
Returns a list of attribute names for a given entity name. |
dkCollection |
listEntityAttrs(java.lang.String entityName)
Returns a list of attributes for a given entity name. |
java.lang.String[] |
listEntityNames()
Gets the list of entity names defined for this datastore. |
java.lang.String[] |
listExtensionNames()
Gets the list of the names of the available extensions. |
java.lang.String[] |
listMappingNames()
Returns the list of the registered mappings for this datastore. |
java.lang.Object |
listSchema()
Deprecated. Replace by listEntities |
java.lang.Object |
listSchemaAttributes(java.lang.String schemaEntry)
Deprecated. Replace by listEntityAttrs |
java.lang.Object |
listServers()
Deprecated. Replace by listDataSources |
java.lang.String |
registerMapping(DKNVPair sourceMap)
Registers a mapping definition to this datastore. |
void |
removeExtension(java.lang.String extensionName)
Remove an existing extension object |
dkXDO |
retrieveFormOverlay(java.lang.String objid)
Retrieves the form overlay object |
void |
retrieveObject(dkDataObject ddo)
Retrieves the data object (DDO) from the persistent store into memory. |
void |
setOption(int option,
java.lang.Object value)
Sets the given "option" with specific "value". |
void |
unlockCheckedOut(dkDataObject dobj)
Unlock the checked-out document or folder item |
void |
unRegisterMapping(java.lang.String mappingName)
Unregisters mapping information from this datastore. |
void |
updateObject(dkDataObject ddo)
Updates the persistent store with the new value of this data object (DDO). |
java.lang.String |
userName()
Returns the user name that was used to logon to the datastore. |
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, commit, deleteObject, deleteObject, deleteObjects, deleteObjects, deleteObjects, destroy, evaluate, execute, executeWithCallback, handle, listAvailableServices, listSearchableEntities, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, rollback, serviceMgr, startTransaction, updateObject, updateObject, updateObjects, updateObjects, updateObjects |
Constructor Detail |
public DKDatastoreIP() throws DKException, java.lang.Exception
Reminder: A connection will not be established by this constructor.
connect(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public DKDatastoreIP(java.lang.String configuration) throws DKException, java.lang.Exception
configuration
- a string which supplies the specific initialization
parameters. Valid parameters include:
Reminder: A connection will not be established by this constructor.
connect(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
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 name associated with a specific backend server.user_name
- the name of the user connecting to the backend serverauthentication
- the authentication or password being used to connectconnect_string
- a string which supplies all of the specific connection
parameters to establish and maintain a connection to
the backend server. Valid parameters include:
DKException
- - DKUsageError: if either datastore_name, user_name, authentication
or connect_string is null.java.lang.Exception
- if an error occurs in the java classes.public void disconnect() throws DKException, java.lang.Exception
disconnect
in interface dkDatastore
disconnect
in class dkAbstractDatastore
DKException
- - DKDatastoreAccessError: if disconnecting from the backend
server is not successful.java.lang.Exception
- if an error occurs in the java classes.public java.lang.Object getOption(int option) throws DKException, java.lang.Exception
getOption
in interface dkDatastore
getOption
in class dkAbstractDatastore
option
- an option identifierDKException
- \
- DKUsageError: if an option is specified that is not valid for
this type of datastore.java.lang.Exception
- if an error occurs in the java classes.public void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
setOption
in interface dkDatastore
setOption
in class dkAbstractDatastore
option
- an option identifervalue
- the new value for the "option"DKException
- - DKUsageError: if an option is specified that is not valid for
this type of datastore.java.lang.Exception
- if an error occurs in the java classes.public 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 string that represent the query criteriacommandLangType
- a query language type, for ImagePlus, it will be
DK_PARAMETRIC_QL_TYPEparams
- additional query options in name/value pairs listjava.lang.Exception
- if an error occurs in the java classes.DKException
- - DKUsageError: if "command" argument is nullDKNVPair
public java.lang.Object evaluate(dkQuery query) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
query
- a given query objectDKException
- - DKUsageError: if the "query" input is null or not of
Parametric query type.java.lang.Exception
- if an error occurs in the java classes.public java.lang.Object evaluate(DKCQExpr qe) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
qe
- a common query expression object - an alternate form
of a query stringDKException
- java.lang.Exception
- if an error occurs in the java classes.public 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 string that represents the query criteriacommandLangType
- a query language type, for ImagePlus, it will be
DK_PARAMETRIC_QL_TYPEparams[]
- additional query options in a name/value pairs listDKException
- - DKUsageError: if "command" is null or invalid, or
"commandLangType" is not Parametric Query type.
- DKDatastoreError: if the datastore is not connected.
- DKDatastoreAccessError: if the backend server returns an error during retrievaljava.lang.Exception
- if an error occurs in the java classes.DKNVPair
public dkResultSetCursor execute(dkQuery query) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
query
- a Parametric dkQuery objectDKException
- - DKUsageError: if "query" object is null or query.qlType() is not
DK_PARAMETRIC_QL_TYPE
- DKDatastoreError: if the datastore is not connected.
- DKDatastoreAccessError: if the backend server returns an error during retrievaljava.lang.Exception
- if an error occurs in the java classes.public dkResultSetCursor execute(DKCQExpr cqe) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
cqe
- a common query expression object - an alternate form of
a query stringDKException
- - DKDatastoreError: if the datastore is not connected.
- DKDatastoreAccessError: if the backend server returns an
error during retrievaljava.lang.Exception
- if an error occurs in the java classes.public 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 objectDKException
- - DKUsageError: if "query" object is null or query.qlType() is not
DK_PARAMETRIC_QL_TYPE
- DKDatastoreError: if the datastore is not connected.
- DKDatastoreAccessError: if the backend server returns an error
during retrievaljava.lang.Exception
- if an error occurs in the java classes.dkCallback
public 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 objectDKException
- - DKUsageError: if "command" is null or invalid, or
"commandLangType" is not Parametric Query type.
- DKDatastoreError: if the datastore is not connected.
- DKDatastoreAccessError: if the backend server returns an error during retrievaljava.lang.Exception
- if an error occurs in the java classes.dkCallback
,
DKNVPair
public void executeWithCallback(DKCQExpr qe, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
qe
- a common query expression object - an alternate form
of a query stringcallbackObj
- a dkCallback objectDKException
- - DKDatastoreError: if the datastore is not connected.
- DKDatastoreAccessError: if the backend server returns an error during retrievaljava.lang.Exception
- if an error occurs in the java classes.dkCallback
public 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 string that represents the query criteriacommandLangType
- a query type. For ImagePlus, this will always be DK_PARAMETRIC_QL_TYPEparams[]
- additional query options in name/value pairs listDKException
- - DKUsageError: if "command" is nulljava.lang.Exception
- if an error occurs in the java classes.evaluate(com.ibm.mm.sdk.common.dkQuery)
,
execute(com.ibm.mm.sdk.common.dkQuery)
,
executeWithCallback(com.ibm.mm.sdk.common.dkQuery, com.ibm.mm.sdk.common.dkCallback)
,
DKNVPair
,
DKParametricQuery
public dkQuery createQuery(DKCQExpr qe) throws DKException, java.lang.Exception
createQuery
in interface dkDatastore
createQuery
in class dkAbstractDatastore
qe
- a common query expression object - an alternate form of
a query stringDKException
- - DKUsageError: if "query" object is null or query.qlType() is not
DK_PARAMETRIC_QL_TYPEjava.lang.Exception
- if an error occurs in the java classes.#evaluate(com.ibm.mm.sdk.common.dkquery)
,
#execute(com.ibm.mm.sdk.common.dkquery)
,
executeWithCallback(com.ibm.mm.sdk.common.dkQuery, com.ibm.mm.sdk.common.dkCallback)
,
DKParametricQuery
public 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 datastoreDKException
- - DKDatastoreAccessError: if the backend server returns an error during object creation
- DKDataObjectAlreadyExists: if the DDO being added already exists in this datastorejava.lang.Exception
- if an error occurs in the java classes.DKDDO
public void deleteObject(dkDataObject ddo) throws DKException, java.lang.Exception
deleteObject
in interface dkDatastore
deleteObject
in class dkAbstractDatastore
ddo
- The DDO object to be deletedDKException
- - DKDatastoreAccessError: if the backend server returns an error during object creation
- DKDataObjectNotFound: if the DDO being deleted does not exist in this datastorejava.lang.Exception
- if an error occurs in the java classes.DKDDO
public 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 datastoreDKException
- - DKDatastoreAccessError: if the backend server returns an error during object creationjava.lang.Exception
- if an error occurs in the java classes.DKDDO
public 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 datastoreDKException
- java.lang.Exception
- if an error occurs in the java classes.DKDDO
public boolean isConnected() throws java.lang.Exception
isConnected
in interface dkDatastore
isConnected
in class dkAbstractDatastore
java.lang.Exception
- if an error occurs in the java classes.public java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in interface dkDatastore
datastoreName
in class dkAbstractDatastore
java.lang.Exception
- if an error occurs in the java classes.public java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in interface dkDatastore
datastoreType
in class dkAbstractDatastore
java.lang.Exception
- if an error occurs in the java classes.public DKHandle connection() throws java.lang.Exception
connection
in interface dkDatastore
connection
in class dkAbstractDatastore
java.lang.Exception
- if an error occurs in the java classes.public java.lang.String userName() throws java.lang.Exception
userName
in interface dkDatastore
userName
in class dkAbstractDatastore
java.lang.Exception
- if an error occurs in the java classes.public dkCollection listDataSources() throws DKException, java.lang.Exception
listDataSources
in interface dkDatastore
listDataSources
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.public java.lang.String[] listDataSourceNames() throws DKException, java.lang.Exception
listDataSourceNames
in interface dkDatastore
listDataSourceNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.public java.lang.Object listServers() throws DKException, java.lang.Exception
listServers
in interface dkDatastore
listServers
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.listDataSources()
public dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in interface dkDatastore
listEntities
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.public java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in interface dkDatastore
listEntityNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.public 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
- java.lang.Exception
- if an error occurs in the java classes.public 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
- java.lang.Exception
- if an error occurs in the java classes.public java.lang.Object listSchema() throws DKException, java.lang.Exception
listSchema
in interface dkDatastore
listSchema
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.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 schemaDKException
- java.lang.Exception
- if an error occurs in the java classes.listEntityAttrs(java.lang.String)
public dkDatastoreDef datastoreDef() throws DKException, java.lang.Exception
datastoreDef
in interface dkDatastore
datastoreDef
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.DKDatastoreDefIP
public java.lang.String registerMapping(DKNVPair sourceMap) throws DKException, java.lang.Exception
registerMapping
in interface dkDatastore
registerMapping
in class dkAbstractDatastore
sourceMap
- source name and mapping, a DKNVPair class with the following
possible values:
unRegisterMapping(java.lang.String)
public void unRegisterMapping(java.lang.String mappingName) throws DKException, java.lang.Exception
unRegisterMapping
in interface dkDatastore
unRegisterMapping
in class dkAbstractDatastore
mappingName
- name of the mapping informationregisterMapping(com.ibm.mm.sdk.common.DKNVPair)
public java.lang.String[] listMappingNames() throws DKException, java.lang.Exception
listMappingNames
in interface dkDatastore
listMappingNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.registerMapping(com.ibm.mm.sdk.common.DKNVPair)
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 definitionDKException
- java.lang.Exception
- if an error occurs in the java classes.registerMapping(com.ibm.mm.sdk.common.DKNVPair)
public 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.DKException
- java.lang.Exception
- if an error occurs in the java classes.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 setDKException
- java.lang.Exception
- if an error occurs in the java classes.public 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 removedDKException
- java.lang.Exception
- if an error occurs in the java classes.public java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
listExtensionNames
in interface dkDatastore
listExtensionNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- if an error occurs in the java classes.public DKDDO createDDO(java.lang.String objectType, int Flags) throws DKException, java.lang.Exception
createDDO
in interface dkDatastore
createDDO
in class dkAbstractDatastore
objectType
- the object type you want to createFlags
- to indicate various options to specify more detail
characteristics of the DDO to create. For example,
it may be a directive to create a document DDO, a
folder, etc.DKException
- java.lang.Exception
- if an error occurs in the java classes.public dkXDO retrieveFormOverlay(java.lang.String objid) throws DKException, java.lang.Exception
retrieveFormOverlay
in interface dkDatastoreIntIP
id
- the id string to retrieve the objectpublic void unlockCheckedOut(dkDataObject dobj) throws DKException, java.lang.Exception
unlockCheckedOut
in interface dkDatastoreIntIP
dobj
- data object (document or folder item)public void checkOut(dkDataObject dobj) throws DKException, java.lang.Exception
checkOut
in interface dkDatastoreIntIP
dobj
- data object (document or folder item)public void checkIn(dkDataObject dobj) throws DKException, java.lang.Exception
checkIn
in interface dkDatastoreIntIP
dobj
- data object (document or folder item)public boolean isCheckedOut(dkDataObject dobj) throws DKException, java.lang.Exception
isCheckedOut
in interface dkDatastoreIntIP
dobj
- data object (document or folder item)public java.lang.String checkedOutUserid(dkDataObject dobj) throws DKException, java.lang.Exception
checkedOutUserid
in interface dkDatastoreIntIP
dobj
- data object (document or folder item)
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |