Index

DKSearchIndexDefTS

Purpose:

This class defines functions to access entity information for Text Search.

Class summary:

class DKSearchIndexDefTS : public dkEntityDef
 {
   public:
    DKSearchIndexDefTS(dkDatastore *ds);
    DKSearchIndexDefTS(const DKSearchIndexDefTS& def);
    virtual ~DKSearchIndexDefTS();
    long      getIndexType();
    void      setIndexType(long indexType);
    long      getIndexFeature();
    void      setIndexFeature(long indexFeature);
    long      getIndexProperty();
    void      setIndexProperty(long indexProperty);
    long      getIndexCCSID();
    void      setIndexCCSID(long indexCCSID);
    DKString  getLibraryId();
    void      setLibraryId(const char* libId);
    DKString  getLibraryClientServices();
    void      setLibraryClientServices(const char* libClientSrv);
    DKString  getLibraryServerServices();
    void      setLibraryServerServices(const char* libServerSrv);
    DKString  getIndexDataArea();
    void      setIndexDataArea(const char* indexDataArea);
    DKString  getIndexWorkArea();
    void      setIndexWorkArea(const char* indexWorkArea);
    DKString  getIndexTitle();
    void      setIndexTitle(const char* indexTitle);
    long      getIndexTitleCCSID();
    void      setIndexTitleCCSID(long indexTitleCCSID);
    DKString  getIndexDescription();
    void      setIndexDescription(const char* indexDesc);
    long      getIndexDescriptionCCSID();
    void      setIndexDescriptionCCSID(long indexDescCCSID);
    long      numberOfDocModels();
    void      addDocModel(DKDocModelTS* docModel);
    DKDocModelTS* getDocModel(long docModelIndex);
    virtual void add();
    virtual void del();
 }

Members:

Constructors and destructor

Constructs an search index definition for Text Search.

    DKSearchIndexDefTS(dkDatastore *ds);
    DKSearchIndexDefTS(const DKSearchIndexDefTS& def);
    virtual ~DKSearchIndexDefTS();

Member functions

getIndexType
Gets index type.
    long getIndexType();

setIndexType
Sets index type.
    void setIndexType(long indexType);

getIndexFeature
Gets index feature.
    long getIndexFeature();

setIndexFeature
Sets index feature.
    void setIndexFeature(long indexFeature);

getIndexProperty
Gets index property.
    long getIndexProperty();

setIndexProperty
Sets index property.
    void setIndexProperty(long indexProperty);

getIndexCCSID
Gets index CCSID (coded character set ID).
    long getIndexCCSID();

setIndexCCSID
Sets index CCSID (coded character set ID).
    void setIndexCCSID(long indexCCSID);

getLibraryId
Gets index library ID.
    DKString  getLibraryId();

setLibraryId
Sets index library ID.
    void setLibraryId(const char* libId);

getLibraryClientServices
Gets library client services.
    DKString  getLibraryClientServices();

setLibraryClientServices
Sets library client services.
    void setLibraryClientServices(const char* libClientSrv);

getLibraryServerServices
Gets library server services.
    DKString  getLibraryServerServices();

setLibraryServerServices
Sets library server services.
    void setLibraryServerServices(const char* libServerSrv);

getIndexDataArea
Gets index data area.
    DKString  getIndexDataArea();

setIndexDataArea
Sets index data area.
    void setIndexDataArea(const char* indexDataArea);

getIndexWorkArea
Gets index work area.
    DKString  getIndexWorkArea();

setIndexWorkArea
Sets index work area.
    void setIndexWorkArea(const char* indexWorkArea);

getIndexTitle
Gets index title.
    DKString  getIndexTitle();

setIndexTitle
Sets index title.
    void setIndexTitle(const char* indexTitle);

getIndexTitleCCSID
Gets index title CCSID (coded character set ID).
    long getIndexTitleCCSID();

setIndexTitleCCSID
Sets index title CCSID (coded character set ID).
    void setIndexTitleCCSID(long indexTitleCCSID);

getIndexDescription
Gets index description.
    DKString  getIndexDescription();

setIndexDescription
Sets index description.
    void setIndexDescription(const char* indexDesc);

getIndexDescriptionCCSID
Gets the index description CCSID (coded character set ID).
    long getIndexDescriptionCCSID();

setIndexDescriptionCCSID
Sets index description CCSID (coded character set ID).
    void setIndexDescriptionCCSID(long indexDescCCSID);

numberOfDocModels
Gets the number of document models.
    long numberOfDocModels();

addDocModel
Adds the document model. The docModelIndex is from 1 to the number of doc models. If the document model is not found a null is returned.
    void addDocModel(DKDocModelTS* docModel);

getDocModel
Gets the document model. The docModelIndex is from 1 to the number of doc models. If the document model is not found a null is returned.
    DKDocModelTS* getDocModel(long docModelIndex);

add
Adds this entity definition to the persistent datastore.
    virtual void add();
 

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

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