Index

DKSearchEngineInfoDL

Purpose:

The DKSearchEngineInfoDL class represents the search manager information. This class also provides the information from the FRN$SEARCH index class used by all Content Manager search programs.

Heirarchy:

dkExtension
  dkSearchEngineInfo
    dkSearchEngineInfoDL
 

Class summary:

  class DKSearchEngineInfoDL: public dkSearchEngineInfo
  {
 public:
 
    dkSearchEngineInfoDL();
    dkSearchEngineInfoDL(const DKSearchEngineInfoDL& aDKSearchEngineInfoDL);
    virtual ~DKSearchEngineInfoDL();
    dkSearchEngineInfoDL& operator= (DKSearchEngineInfoDL& 
                                     aDKSearchEngineInfoDL);
    virtual void          setSearchEngine(const char* aSearchEngine);
    virtual DKString      getSearchEngine() const;
    virtual void          setSearchIndex(const char* aSearchIndex);
    virtual DKString      getSearchIndex() const;
    virtual void          setSearchInfo(const char* aSearchInfo);
    virtual DKString      getSearchInfo() const;
    dkBoolean             operator==(const DKSearchEngineInfoDL& 
                                     aDKSrchEngInfoDL) const;
    unsigned short        getSearchState() const;
    unsigned short        getSearchClassId() const;
    dkString              getServerName() const;
    dkString              getTextIndex() const;
    dkString              getDataBase() const;
    dkString              getCatalog() const;
    dkString              getSearchTimestamp() const;
 
    };
 

Members:

Constructors and destructor
      dkSearchEngineInfoDL();
      dkSearchEngineInfoDL(const DKSearchEngineInfoDL& 
                           aDKSearchEngineInfoDL);
      virtual ~DKSearchEngineInfoDL();
 

Member functions

operator=
Assignment operator.
     dkSearchEngineInfoDL& operator= (DKSearchEngineInfoDL& 
                                              aDKSearchEngineInfoDL);
 

setSearchEngine
Sets the search engine name. The valid values are:
  • SM - to be indexed by the Text Search engine
  • QBIC - to be indexed by the Image Search engine

      virtual void setSearchEngine(const char* aSearchEngine);
 

getSearchEngine
Gets the search engine name.
      virtual DKString getSearchEngine() const;
 

setSearchIndex
Sets the search index. Different search engines combine values differently:

Text Search
The search index of Text Search is the search service name-index. For example, if you have a search service name called "TM" and a constituent index name called "TMINDEX," then the search index is called "TM-TMINDEX".

Image Search
The search index of Image Search is the DataBase-Catalog-image search server. Make sure the catalog has Image Search features defined before you attempt to use this search engine. If you have an Image Search server name called "QBICSRV," a database name called "SAMPLEDB," and a catalog name called "SAMPLECAT," then the corresponding search index would be named "SAMPLEDB-SAMPLECAT-QBICSRV".

      virtual void setSearchIndex(const char* aSearchIndex);
 

getSearchIndex
Gets the search index.
      virtual DKString getSearchIndex() const;
 

setSearchInfo
Sets the search information value. This value contains the three-character national language code (NLS) of the text part indexed by the search engine. For example, the US English language uses the NLS code ENU.
      virtual void setSearchInfo(const char* aSearchInfo);
 

getSearchInfo
Gets the search information value. This value contains the three-character national language code (NLS) of the text part indexed by the search engine.
      virtual DKString getSearchInfo() const;
 

operator==
Compares the object to the given parameter object; this function will return TRUE if both objects have the same value for each data member.
      dkBoolean operator==(const DKSearchEngineInfoDL& 
                           aDKSrchEngInfoDL) const;
 

getSearchState
Gets the search indexing state. The valid values are:
  • 256 - to be updated; a call to the invokeSearchEngine(searchEngine, searchIndex) datastore function will change this value
  • 512 - to be deleted; a call to the invokeSearchEngine(searchEngine, searchIndex) datastore function will change this value
  • 769 - queued to be updated; the object is in the queue and is ready to be indexed by the search machine
  • 770 - queued to be deleted; the object is in the queue and is ready to be deleted by the search machine's indexing action
  • 1024 - indexed; the search machine has indexed the object

         unsigned short getSearchState() const;
 

getSearchClassId
Gets the index class ID of the item in the FRN$SEARCH table.
         unsigned short getSearchClassId() const;
 

getServerName
Gets the server name of the search engine.
      dkString getServerName() const;
 

getTextIndex
Gets the Text Search index name. This function only applies to an index created using the Text Search engine.
      dkString getTextIndex() const;
 

getDataBase
Gets the Image Search database name.
      dkString getDataBase() const;
 

getCatalog
Gets the Image Search catalog name.
      dkString getCatalog() const;
 

getSearchTimestamp
Gets the search indexing timestamp.
      dkString getSearchTimestamp() const;
 

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