Defined in file: hzDatabase.h
Derivative of: hdbIndex
hdbIndexText is a free text index applicable to members of BASETYPE_TEXT and BASETYPE_TXTDOC. Free text indexation is particularly profigate, as there is an idset for every word occuring at least once in any document. Document collections do not need to be very extensive for the word count to reach a good proportion of all the words in a given language, and of course, the collection may span multiple languages. A count of a million or so unique words, would not be unusual, and that is a lot of idsets!
Constructors/Detructors
| Default constructor | hdbIndexText() | Not specified in code. Default applies |
| Copy constructor | hdbIndexText(&) | Not specified in code. Default applies |
| Default constructor | hdbIndexText() | Not specified in code. Default applies |
Public Methods:
| hzEcode | Clear | (void) | Clear all contents of the free text index by clearing the ISAM and the map of keys |
| uint32_t | Count | (void) | |
| hzEcode | Delete | (hzString& word)uint32_t docId, | Locate the bitmap for the word and delete the object id from it. |
| hzEcode | Eval | (hzIntset& result)hzString& criteria, | Perform a search on the freetext index and place the resulting set of document ids into the supplied bitmap (arg 1). The supplied criteria (arg 2) must comprise at least one whole word and may comprise a boolean expression. |
| hzEcode | Export | (hzString& filepath)bool bFull, | Output list of words and associated idsets to the supplied filepath. The output is human radable for diagnostic purposes |
| hzEcode | Halt | (void) | Halt the operation of the free text index. This will halt the underlying hzIsam. |
| hzEcode | Init | (hzString& name)hzString& opdir, hzString& backup, uint32_t cacheMode, | Initialize the free text index with a name, an operational directory and an optional backup directory. These parameters initialize the underlying hzIsam. |
| hzEcode | Insert | (hzString& word)uint32_t docId, | Locate or insert the word and its associated bitmap, assign object id in the bitmap. |
| hzEcode | Select | (hzIntset& Result)hzString& word, | Locate the bitmap for the word and assign it to the result |
| hdbIdxtype | Whatami | (void) |
Member Variables:
| hzMapS<hzString,hzIntset> | m_Keys | Map of words to list of objects (records) containing the words |