|
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.dkAbstractDatastoreDef | +--com.ibm.mm.sdk.common.DKDatastoreDefIP
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
dkEntityDef
,
DKEntityDefIP
,
com.ibm.mm.sdk.common.DKDatastoreIP
, Serialized FormFields 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 | |
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 |
public DKDatastoreDefIP(dkDatastore ds)
Method Detail |
public dkEntityDef createEntity()
createEntity
in class dkAbstractDatastoreDef
DKEntityDefIP
public dkEntityDef getEntity(java.lang.String entityName) throws DKException
getEntity
in class dkAbstractDatastoreDef
entityName
- name of entity definition to retrieveDKException
- if the specified entity
name does not exist.public dkCollection listEntities() throws DKException
listEntities
in class dkAbstractDatastoreDef
DKException
- if an error occurs.public java.lang.String[] listEntityNames() throws DKException
listEntityNames
in class dkAbstractDatastoreDef
DKException
- if an error occurs.public dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in class dkAbstractDatastoreDef
entityName
- name of the entity to retrieve the attributes forDKException
- if the specified entity name does not exist.public java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrNames
in class dkAbstractDatastoreDef
entityName
- name of the entity to retrieve the attribute
names forDKException
- if the specified entity name does not exist.public void add(dkEntityDef entityObj) throws DKException
add
in class dkAbstractDatastoreDef
entityObj
- entity object to be added.DKException
- if the entity object is invalid
on the back-end server while adding the enityt.public void del(dkEntityDef entityObj) throws DKException
del
in class dkAbstractDatastoreDef
entityObj
- the entity object to be deleted.DKException
- if the entityObj is invalid or does not exist on
the backend server.public dkDatastoreAdmin datastoreAdmin() throws DKException, java.lang.Exception
datastoreAdmin
in class dkAbstractDatastoreDef
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |