Index

DKDatastoreDefDES

Purpose:

This class defines functions to access Extended Search (DES) datastore information

Class summary:

class DKDatastoreDefDES : public dkDatastoreDef
{
public:
    DKDatastoreDefDES(dkDatastore* ds);
    virtual ~DKDatastoreDefDES();
 
    virtual dkEntityDef* createEntity();
 
    virtual dkEntityDef* getEntity(const char* entityName);
    virtual dkCollection* listEntities();
    virtual DKString* listEntityNames(long& arraySize);
    virtual dkCollection* listEntityAttrs(const char* entityName);
    virtual DKString* listEntityAttrNames(const char* entityName,
                                          long& arraySize);
    virtual void add(dkEntityDef* entityDef);
    virtual void del(dkEntityDef* entityDef);
    virtual dkDatastoreAdmin* datastoreAdmin();
};

Members:

Constructors and destructor

Parameters
ds -- A reference to the datastore object.

    DKDatastoreDefDES(dkDatastore* ds);
    virtual ~DKDatastoreDefDES();
 

Member functions

createEntity
Creates a new dkEntityDef and returns it.
    virtual dkEntityDef* createEntity();
 

getEntity
Gets the dkEntityDef object from the persistent datastore for the given entity name.

Parameters
entityName -- The name of an entity to retrieve.

    virtual dkEntityDef* getEntity(const char* entityName);
 

listEntities
Gets a list of entities from the persistent datastore.
    virtual dkCollection* listEntities();
 

listEntityNames
Gets a list of entity names from the persistent datastore.
    virtual DKString* listEntityNames(long& arraySize);
 

listEntityAttrs
Gets a list of attributes for a given entity name.

Parameters
entityName -- The name of the entity to retrieve attributes for.

    virtual dkCollection* listEntityAttrs(const char* entityName);
 

listEntityAttrNames
Gets a list of attribute names for a given entity name.

Parameters
entityName -- The name of the entity to retrieve attribute names for.

    virtual DKString* listEntityAttrNames(const char* entityName,
                                          long& arraySize);
 

add
Adds the given entity definition to the persitent datastore.

Parameters
entityDef -- The entity definition to be added.

    virtual void add(dkEntityDef* entityDef);
 

del
Deletes the given entity definition from the persistent datastore.

Parameters
entityDef -- The entity definition to be deleted.

    virtual void del(dkEntityDef* entityDef);
 

datastoreAdmin
Get a datastore administration object for a datastore.
    virtual dkDatastoreAdmin* datastoreAdmin();
 

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