Index

DKIndexInfoTS

Purpose:

This class is used to hold information about a text search index. The field in the class mirrors the fields specified in the Text Search Engine System Administration Panel for an index. All constants are defined in the DKConstant2.h file.

Class summary:

class DKIndexInfoTS 
      {
      DKIndexInfoTS();
      virtual ~DKIndexInfoTS();
      DKString  getIndexName();
      void      setIndexName(const char* indexName);
      long      getIndexType();
      void      setIndexType(long indexType);
      long      getIndexFeature();
      void      setIndexFeature(long indexFeature);
      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);
    }

Members:

Constructors and destructor
Constructs the object.
DKIndexInfoTS();
virtual ~DKIndexInfoTS();
 

Member functions

getIndexName
Gets the index name.
DKString  getIndexName(); 

setIndexName
Sets the index name. The indexName is the name of a text search index.
void setIndexName(const char* indexName); 

getIndexType
Gets the index type. This will return DK_TSINDEXTYPE_LINGUISTIC, DK_TSINDEXTYPE_PRECISE or DK_TSINDEXTYPE_GTR.
long getIndexType(); 

setIndexType
Sets the index type. The indexType is the name of a text search index type. The index types are DK_TSINDEXTYPE_LINGUISTIC, DK_TSINDEXTYPE_PRECISE or DK_TSINDEXTYPE_GTR.
void setIndexType(long indexType); 

getIndexFeature
Gets the index feature. This will return DK_TSINDEXFEATURE_CASE_ENABLED for GTR.
long getIndexFeature(); 

setIndexFeature
Sets the index feature. The indexFeature is the name of a text search index feature. The index feature is DK_TSINDEXFEATURE_CASE_ENABLED for GTR.
void setIndexFeature(long indexFeature);

getIndexCCSID
Gets the index CCSID (coded character set ID), for example, DK_CCSID_00850.
long getIndexCCSID(); 

setIndexCCSID
Sets the index CCSID (coded character set ID). The indexCCSID is the CCSID for a text search index, for example, DK_CCSID_00850.
void setIndexCCSID(long indexCCSID); 

getLibraryId
Gets the library ID.
   DKString getLibraryId(); 

setLibraryId
Sets the library ID. The libId is the name of a library ID for a text search index.
   void setLibraryId(const char* libId); 

getLibraryClientServices
Gets the library client services.
   DKString getLibraryClientServices();

setLibraryClientServices
Sets the library client services. The libClientSrv is the name of a library client services for a text search index.
   void setLibraryClientServices(const char* libClientSrv);

getLibraryServerServices
Gets the library server services.
   DKString getLibraryServerServices(); 

setLibraryServerServices
Sets the library server services. The libServerSrv is the name of a library server services for a text search index.
   void setLibraryServerServices(const char* libServerSrv);

getIndexDataArea
Gets the index data area.
   DKString getIndexDataArea(); 

setIndexDataArea
Sets the index data area. The indexDataArea is the name of the index data area for a text search index.
   void setIndexDataArea(const char* indexDataArea);

getIndexWorkArea
Gets the index work area.
   DKString getIndexWorkArea(); 

setIndexWorkArea
Sets the index work area. The indexWorkArea is the name of the index work area for a text search index.
   void setIndexWorkArea(const char* indexWorkArea);

getIndexTitle
Gets the index title.
   DKString getIndexTitle(); 

setIndexTitle
Sets the index title. The indexTitle is the name of the index title for a text search index.
   void setIndexTitle(const char* indexTitle);

getIndexTitleCCSID
Gets the index title CCSID coded character set ID (for example, DK_CCSID_00850).
   long getIndexTitleCCSID(); 

setIndexTitleCCSID
Sets the index title CCSID (coded character set ID). The indexTitleCCSID is the index title CCSID for a text search index (for example, DK_CCSID_00850).
   void setIndexTitleCCSID(long indexTitleCCSID);

getIndexDescription
Gets the index description.
   DKString getIndexDescription(); 

setIndexDescription
Sets the index description. The indexDesc is the name of the index description for a text search index.
   void setIndexDescription(const char* indexDesc);

getIndexDescriptionCCSID
Gets the index description CCSID (coded character set ID, for example, DK_CCSID_00850).
   long getIndexDescriptionCCSID(); 

setIndexDescriptionCCSID
Sets the index description CCSID (coded character set ID). The indexDescCCSID is the description title CCSID for a text search index. (for example, DK_CCSID_00850).
   void setIndexDescriptionCCSID(long indexDescCCSID);

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