Package FairCom.CtreeDb
Class CTFullTextIndex
Deals with the full text index concept. The full text index allows to search
through text fields any string.
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionDefault constructor for the CTFullTextIndex class.Copy constructor for the CTFullTextIndex class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a new field to Full Text Indexvoid
finalize()
Destroys an allocated CTFullTextIndex object This method should be called in order to avoid memory leaks.GetField
(int fieldNumber) Retrieve a Full Text index fieldint
Retrieve the Full Text index field count.int
GetFieldMode
(int FieldNumber) Retrieve a Full Text index field modeGetName()
Retrieve the Full Text index nameint
Retrieve the ordinal number of the current Full Text indexint
Retrieve the status of the index handle.void
Set Full Text index optionsMethods inherited from class CTBase
Abort, Begin, ClearSavePoint, Commit, GetAutoCommit, GetHandle, GetKeepLock, GetLockMode, GetOperation, GetTransactionMode, IsLockActive, IsTransActive, IsUnicodeLib, Lock, PrepareCommit, RestoreSavePoint, SetAutoCommit, SetHandle, SetKeepLock, SetOperation, SetSavePoint, SetTransactionMode, Unlock
-
Constructor Details
-
CTFullTextIndex
public CTFullTextIndex()Default constructor for the CTFullTextIndex class.- See Also:
-
CTFullTextIndex
Copy constructor for the CTFullTextIndex class.- Parameters:
FTI
- CTFullTextIndex object to be copied- See Also:
-
-
Method Details
-
finalize
public void finalize()Destroys an allocated CTFullTextIndex object This method should be called in order to avoid memory leaks. Release all resources associated with a database -
AddField
Add a new field to Full Text Index- Parameters:
field
- the field object to addmode
- the full text search field matching mode use theFTI_FIELD_MODE
class members to pass this value- Throws:
CTException
- in case of error- See Also:
-
GetFieldCount
Retrieve the Full Text index field count.- Returns:
- The number of field indexed
- Throws:
CTException
- in case of error- See Also:
-
GetField
Retrieve a Full Text index field- Parameters:
fieldNumber
- the field number to get- Returns:
- the
CTField
representing the field at the passed position in the index - Throws:
CTException
- in case of error
-
GetStatus
public int GetStatus()Retrieve the status of the index handle.- Returns:
- The status of the index handle is a bit map describing one or
more of the following: OLD Original value (no changes)
NEW Index added DELETED Original Index deleted OPTIONUPDATED
Options have been updated
The members of the
FTI_STATUS
for comparison
-
SetOption
Set Full Text index options- Parameters:
option
- the option to set use theFTI_OPTION
to pass this parameterstringValue
- value to set the option to for option taking string valueintValue
- value to set the option to for option taking integer value to pass this value the members of the following classes can be used:FTI_OPTION_UPDATE
- Throws:
CTException
- in case of error- See Also:
-
GetName
Retrieve the Full Text index name- Returns:
- The full text index name
- Throws:
CTException
- in case of error
-
GetNumber
Retrieve the ordinal number of the current Full Text index- Returns:
- The full text index ordinal number
- Throws:
CTException
- in case of error
-
GetFieldMode
Retrieve a Full Text index field mode- Parameters:
FieldNumber
- the field number- Returns:
- the Full Text Index field mode of the passed field
- Throws:
CTException
- in case of error- See Also:
-