Index

DKMatchesInfoTS

Purpose:

The DKMatchesInfoTS class provides the interface for the match information determined by a text query result item.

Class summary:

Example code
    class DKMatchesInfoTS : public dkDataObjectBase
    {
   public:
     ...
     DKMatchesInfoTS();
     virtual ~DKMatchesInfoTS();
     short protocol();
     DKString getObjectType();
     DKString getDocumentName();
     void setDocumentName(const char* docName);
     long numberOfSections();
     DKMatchesDocSectionTS* getSection(long sectionIndex);
     void addSection(DKMatchesDocSectionTS* section);
    }
 

Members:

Constructors and destructor
     DKMatchesInfoTS();
     virtual ~DKMatchesInfoTS();

Member functions

protocol
Gets the protocol type associated with this data object.
     short protocol();
 

getObjectType
Gets the type of this object.
     DKString getObjectType();
 

getDocumentName
Gets the document name.
     DKString getDocumentName();
 

setDocumentName
Sets the document name.
     void setDocumentName(const char* docName);
 

numberOfSections
Returns the number of document sections contained in the document.
     long numberOfSections();
 

getSection
Gets the document section. The sectionIndex value ranges between 1 and the total number of sections. If no document sections are found, this function returns the value NULL.
     DKMatchesDocSectionTS* getSection(long sectionIndex);
 

addSection
Adds a document section.
     void addSection(DKMatchesDocSectionTS* section);
 

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