Index

DKDatastoreDefTS

Purpose:

This is the class that is used to represent a datastore definition object.

Class summary:

class DKDatastoreDefTS : public dkDatastoreDef
 {
   public:
    DKDatastoreDefTS(dkDatastore *ds);
    virtual ~DKDatastoreDefTS();
    virtual dkEntityDef* createEntity();
    virtual dkEntityDef* getEntity(const char* entityName);
    virtual dkCollection* listEntities();
    virtual DKString* listEntityNames(long& arraySize);
    virtual DKSearchIndexDefTS* createSearchIndex();
    virtual DKSearchIndexDefTS* getSearchIndex(const char* searchIndexName);
    virtual dkCollection* listSearchIndexes();
    virtual DKString* listSearchIndexNames(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
DKDatastoreDefTS(dkDatastore *ds);
virtual ~DKDatastoreDefTS();

Member functions

createEntity
Creates new entity.
virtual dkEntityDef* createEntity(); 

getEntity
Gets an entity by name.
virtual dkEntityDef* getEntity(const char* entityName);

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

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

listEntityAttrs
Gets a list of attributes for a give entity name.
virtual dkCollection* listEntityAttrs(const char* entityName); 

listEntityAttrNames
Gets a list of attribute names for a give entity name.
virtual DKString* listEntityAttrNames(const char* entityName,
long& arraySize);

add
Adds the given entity.
virtual void add(dkEntityDef* entityDef); 

del
Deletes the given entity. Note: You should clear the search index by using the clearIndex function in the DKDatastoreAdminTS class before deleting the search index.
virtual void del(dkEntityDef* entityDef); 

datastoreAdmin
Gets a datastore admin object for a datastore.
virtual dkDatastoreAdmin* datastoreAdmin();

createSearchIndex
Creates new search index.
virtual DKSearchIndexDefTS* createSearchIndex();

getSearchIndex
Gets a search index by name.
virtual DKSearchIndexDefTS* getSearchIndex(const char*                      searchIndexName);

listSearchIndexes
Gets a list of search indexes from datastore.
virtual dkCollection* listSearchIndexes();

listSearchIndexNames
Gets a list of search index names from datastore.
virtual DKString* listSearchIndexNames(long& arraySize); 

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