Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreDefIP

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDatastoreDef
        |
        +--com.ibm.mm.sdk.common.DKDatastoreDefIP
All Implemented Interfaces:
DKConstant, DKConstantIP, dkDatastoreDef, DKMessageId, DKMessageIdIP, java.io.Serializable

public class DKDatastoreDefIP
extends dkAbstractDatastoreDef
implements DKConstantIP, DKMessageIdIP

This class stores the ImagePlus/390 datastore meta-data and provides methods to access this data. The meta-data is represented as a collection of dkEntityDefs of type DKEntityDefIP.

This class also provides methods to create, list, and delete entity definitions from the collection of dkEntityDefs.

IBM Confidential

See Also:
dkEntityDef, DKEntityDefIP, com.ibm.mm.sdk.common.DKDatastoreIP, Serialized Form

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.DKMessageIdIP
copyright, DK_IP_MSG_API_PROTOCOL_ERROR, DK_IP_MSG_CLIENT_API_NOT_OK, DK_IP_MSG_DATASTORE_READONLY, DK_IP_MSG_DOCIDNOTSET, DK_IP_MSG_FAF_ERROR, DK_IP_MSG_FAF_INTERNAL_ERROR, DK_IP_MSG_FAF_NOT_OK, DK_IP_MSG_FAF_WARNING, DK_IP_MSG_FOLDER_NOT_EMPTY, DK_IP_MSG_HOST_TIMEOUT, DK_IP_MSG_INVALID_CONN_OPTION, DK_IP_MSG_INVALID_DOCTYPE, DK_IP_MSG_INVALID_IODM_RC, DK_IP_MSG_INVALID_PARM, DK_IP_MSG_IODM_FAILURE, DK_IP_MSG_IODM_NOT_AVAILABLE, DK_IP_MSG_LOCKEDBYANOTHER, DK_IP_MSG_MISSING_CONN_OPTION, DK_IP_MSG_MSGID_NOT_FOUND, DK_IP_MSG_PROTOCOL_ERROR
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDatastoreDefIP(dkDatastore ds)
          Constructs and initializes an ImagePlus/390 datastore definition.
 
Method Summary
 void add(dkEntityDef entityObj)
          Adds the given entity object to the datastore.
 dkEntityDef createEntity()
          Creates a proper type of entity for this datastore.
 dkDatastoreAdmin datastoreAdmin()
          Get a datastore administration object for a datastore
 void del(dkEntityDef entityObj)
          Deletes the given entity object from the datastore.
 dkEntityDef getEntity(java.lang.String entityName)
          Returns the dkEntityDef object for the given entity name.
 dkCollection listEntities()
          Get a list of entity definitions for an ImagePlus datastore
 java.lang.String[] listEntityAttrNames(java.lang.String entityName)
          Returns a list of attribute names for the specified entity name.
 dkCollection listEntityAttrs(java.lang.String entityName)
          Returns a list of attributes for the specified entity.
 java.lang.String[] listEntityNames()
          Returns a list of entity names for this datastore.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef
clearCache, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, listEntityNames, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveEntity, setDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatastoreDefIP

public DKDatastoreDefIP(dkDatastore ds)
Constructs and initializes an ImagePlus/390 datastore definition.
Method Detail

createEntity

public dkEntityDef createEntity()
Creates a proper type of entity for this datastore. Returns a new dkEntityDef object.
Overrides:
createEntity in class dkAbstractDatastoreDef
Returns:
a new dkEntityDef of type DKEntityDefIP
See Also:
DKEntityDefIP

getEntity

public dkEntityDef getEntity(java.lang.String entityName)
                      throws DKException
Returns the dkEntityDef object for the given entity name.
Overrides:
getEntity in class dkAbstractDatastoreDef
Parameters:
entityName - name of entity definition to retrieve
Returns:
dkEntityDef object contains data about the given entityName.
Throws:
DKException - if the specified entity name does not exist.

listEntities

public dkCollection listEntities()
                          throws DKException
Get a list of entity definitions for an ImagePlus datastore
Overrides:
listEntities in class dkAbstractDatastoreDef
Returns:
a DKSequentialCollection of entity definitions, dkEntityDef
Throws:
DKException - if an error occurs.

listEntityNames

public java.lang.String[] listEntityNames()
                                   throws DKException
Returns a list of entity names for this datastore.
Overrides:
listEntityNames in class dkAbstractDatastoreDef
Returns:
an array of entity names
Throws:
DKException - if an error occurs.

listEntityAttrs

public dkCollection listEntityAttrs(java.lang.String entityName)
                             throws DKException,
                                    java.lang.Exception
Returns a list of attributes for the specified entity.
Overrides:
listEntityAttrs in class dkAbstractDatastoreDef
Parameters:
entityName - name of the entity to retrieve the attributes for
Returns:
a dkCollection of dkAttrDef objects
Throws:
DKException - if the specified entity name does not exist.

listEntityAttrNames

public java.lang.String[] listEntityAttrNames(java.lang.String entityName)
                                       throws DKException,
                                              java.lang.Exception
Returns a list of attribute names for the specified entity name.
Overrides:
listEntityAttrNames in class dkAbstractDatastoreDef
Parameters:
entityName - name of the entity to retrieve the attribute names for
Returns:
an array of attribute names
Throws:
DKException - if the specified entity name does not exist.

add

public void add(dkEntityDef entityObj)
         throws DKException
Adds the given entity object to the datastore. Note: For IP/390 this method is not supported. A DKUsageError expection will be thrown
Overrides:
add in class dkAbstractDatastoreDef
Parameters:
entityObj - entity object to be added.
Throws:
DKException - if the entity object is invalid on the back-end server while adding the enityt.

del

public void del(dkEntityDef entityObj)
         throws DKException
Deletes the given entity object from the datastore. Note: For IP/390 this method is not supported. A DKUsageError expection will be thrown
Overrides:
del in class dkAbstractDatastoreDef
Parameters:
entityObj - the entity object to be deleted.
Throws:
DKException - if the entityObj is invalid or does not exist on the backend server.

datastoreAdmin

public dkDatastoreAdmin datastoreAdmin()
                                throws DKException,
                                       java.lang.Exception
Get a datastore administration object for a datastore
Overrides:
datastoreAdmin in class dkAbstractDatastoreDef
Returns:
a dkDatastoreAdmin object

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.