Next: , Previous: WordKey SYNOPSIS, Up: WordKey


10.12.3 WordKey DESCRIPTION

Describes the key used to store a entry in the inverted index. Each field in the key has a bit in the set member that says if it is set or not. This bit allows to say that a particular field is undefined regardless of the actual value stored. The methods IsDefined, SetDefined and Undefined are used to manipulate the defined status of a field. The Pack and Unpack methods are used to convert to and from the disk storage representation of the key.

Although constructors may be used, the prefered way to create a WordKey object is by using the WordContext::Key method.

The following constants are defined:

`WORD_KEY_WORD'
the index of the word identifier with the key for Set and Get methods.
`WORD_KEY_VALUE_INVALID'
a value that is invalid for any field of the key.