Index

DKDatastoreDefDL

Purpose:

DKDatastoreDefDL is a subclass of dkDatastoreDef which provides the actual functions to access and manipulate Content Manager datastore metadata, such as the creation and deletion of index-classes, attributes, listing them, and so forth.

Class summary:

class DKDatastoreDefDL : public dkDatastoreDef
 {
   public:
      DKDatastoreDefDL(dkDatastore* ds);
      virtual ~DKDatastoreDefDL();
  
      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();
      virtual dkAttrDef* createAttr();
      virtual dkCollection* listAttrs();
      virtual DKString* listAttrNames(long& arraySize);
      virtual void addAttr(dkAttrDef* attrDef);
      virtual void delAttr(dkAttrDef* attrDef);
 }

Members:

Constructors and destructor
DKDatastoreDefDL(dkDatastore *ds);
virtual ~DKDatastoreDefDL();

Member functions

createEntity
Creates an index class, a DKIndexClassDefDL object.
virtual dkEntityDef* createEntity();

getEntity
Gets the DKIndexClassDefDL object for the given index class name from the datastore definition.

Exceptions
DKException -- If an error occurs in the server.

virtual dkEntityDef* getEntity(const char* entityName);

listEntities
Gets the list of index classes defined in this datastore.

Exceptions
DKException -- If an error occurs in the server.

virtual dkCollection* listEntities();

listEntityNames
Gets the list of index class names defined in this datastore.

Exceptions
DKException -- If an error occurs in the server.

virtual DKString* listEntityNames(long& arraySize);

listEntityAttrs
Gets the list of attributes for a given index class name.

Exceptions
DKException -- If the index-class name does not exist.

virtual dkCollection* listEntityAttrs(const char* entityName); 

listEntityAttrNames
Gets the list of attribute names for a given index class name.

Exceptions
DKException -- If the index-class name does not exist.

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

add
Adds the definition of the given index class to the persistent datastore.
      virtual void add(dkEntityDef* entityDef);

del
Deletes the definition of the given index class from the persistent datastore.
      virtual void del(dkEntityDef* entityDef);

datastoreAdmin
Gets a datastore administration object from the Content Manager datastore. This object implements administration functions, for example, creating or deleting users, and so forth.
      virtual dkDatastoreAdmin* datastoreAdmin();

createAttr
Creates a new attribute definition object for this datastore so that you can set its data.
      virtual dkAttrDef* createAttr();

listAttrs
Gets a list of all attributes defined in the current server.
      virtual dkCollection* listAttrs();

listAttrNames
Gets a list of attribute names defined in the current server.
      virtual DKString* listAttrNames(long& arraySize);

addAttr
      virtual void addAttr(dkAttrDef* attrDef);

delAttr
      virtual void delAttr(dkAttrDef* attrDef);

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