Index

DKDatabaseDefDES

Purpose:

The DKDatabaseDefDES class defines functions to access Extended Search (DES) entity information.

Class summary:

class DKDatabaseDefDES : public dkEntityDef
{
public:
    DKDatabaseDefDES(dkDatastore *ds);
    virtual ~DKDatabaseDefDES();
 
    virtual void add(dkEntityDef* subEntityDef);
    virtual void del(dkEntityDef* subEntityDef);
 
    virtual dkAttrDef* createAttr();
    virtual dkAttrDef* getAttr(const char* attrName);
    virtual dkCollection* listAttrs();
    virtual DKString* listAttrNames(long& arraySize);
    virtual void add();
    virtual void del();
    virtual void add(dkAttrDef* attrDef);
    virtual void del(dkAttrDef* attrDef);
    DKString getDisplayName();
    void setDisplayName(const char* psz);
    DKString getHelpText();
    void setHelpText(const char* psz);
    DKString getLanguage();
    void setLanguage(const char* psz);
    int getNumVals();
    void setNumVals(int i);
    void setDataType(DKAny a);
    DKAny getDataType();
    virtual DKBoolean isSearchable();
    void setSearchable(DKBoolean b);
    DKBoolean isRetrievable();
    void setRetrievable(DKBoolean b);
    void setValue(const DKAny& propertyValue, int iValueIndex);
    DKAny getValue(int iValueIndex);
};

Members:

Constructors and destructor

Parameters
ds -- A reference to the owner datastore object.

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

Member functions

add
Adds this entity definition to the persistent store, that is, it make this entity persistent.
     virtual void add(dkEntityDef* subEntityDef);
 

del
Deletes this entity definition from the persistent store.
     virtual void del(dkEntityDef* subEntityDef);
 

createAttr
Creates a new dkAttrDef and returns it to the caller.
     virtual dkAttrDef* createAttr();
 

getAttr
Retrieves an attribute object from a given attribute name.

Parameters
attrName -- The name of the attribute to be retrieved.

     virtual dkAttrDef* getAttr(const char* attrName);
 

listAttrs
Gets a list of attributes.
     virtual dkCollection* listAttrs();
 

listAttrNames
Gets a list of attribute names.
     virtual DKString* listAttrNames(long& arraySize);
 

add
Adds this entity definition to the persistent store. That is, it makes this entity persistent.
     virtual void add();
 

del
Deletes this entity from the persistent store, for example, a drop table. The in-memory copy is not changed.
     virtual void del();
 

add
Adds the given attribute-definition object to this entity in the persistent store.

Parameters
attrDef -- An attribute object to be added to this entity object.

    virtual void add(dkAttrDef* attrDef);
 

del
Deletes the given attribute from this entity in the persistent store.

Parameters
attrDef -- An attribute object to be deleted from this entity object.

    virtual void del(dkAttrDef* attrDef);
 

getDisplayName
Gets the display name of the database.
    DKString getDisplayName();
 

setDisplayName
Sets the display name of the database.
     void setDisplayName(const char* psz);
 

getHelpText
Gets the help text.
    DKString getHelpText();
 

setHelpText
Sets the help text.
    void setHelpText(const char* psz);
 

getLanguage
Gets the language.
    DKString getLanguage();
 

setLanguage
Sets the language.
    void setLanguage(const char* psz);
 

getNumVals
Gets the number of values.
    int getNumVals();
 

setNumVals
Sets the number of values.
    void setNumVals(int i);
 

setDataType
Sets the data type.
    void setDataType(DKAny a);
 

getDataType
Gets the data type.
    DKAny getDataType();
 

isSearchable
Returns true if the entity is searchable.
    virtual DKBoolean isSearchable();
 

setSearchable
Sets the entity to searchable.
    void setSearchable(DKBoolean b);
 

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