FairCom.CtreeDb

Class CTFullTextIndex

java.lang.Object

FairCom.CtreeDb.CTBase

FairCom.CtreeDb.CTFullTextIndex

public class CTFullTextIndex
extends CTBase

Deals with the full text index concept. The full text index allows to search through text fields any string.

See Also:

CTTable, CTRecord, CTSegment, CTField, CTIndex, CTFullTextIndexDictionary

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

m_handle

Constructor Summary

Constructors

Constructor and Description
CTFullTextIndex() Default constructor for the CTFullTextIndex class.
CTFullTextIndex(CTFullTextIndex FTI) Copy constructor for the CTFullTextIndex class.

Method Summary

Modifier and Type	Method and Description
void	AddField(CTField field, int mode) Add a new field to Full Text Index
void	finalize() Destroys an allocated CTFullTextIndex object This method should be called in order to avoid memory leaks.
CTField	GetField(int fieldNumber) Retrieve a Full Text index field
int	GetFieldCount() Retrieve the Full Text index field count.
int	GetFieldMode(int FieldNumber) Retrieve a Full Text index field mode
java.lang.String	GetName() Retrieve the Full Text index name
int	GetNumber() Retrieve the ordinal number of the current Full Text index
int	GetStatus() Retrieve the status of the index handle.
void	SetOption(int option, java.lang.String stringValue, int intValue) Set Full Text index options

Methods inherited from class FairCom.CtreeDb.CTBase

Abort, Begin, ClearSavePoint, Commit, GetAutoCommit, GetHandle, GetKeepLock, GetLockMode, GetOperation, GetTransactionMode, IsLockActive, IsTransActive, IsUnicodeLib, Lock, PrepareCommit, RestoreSavePoint, SetAutoCommit, SetHandle, SetKeepLock, SetOperation, SetSavePoint, SetTransactionMode, Unlock

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CTFullTextIndex

public CTFullTextIndex()

Default constructor for the CTFullTextIndex class.

See Also:

CTFullTextIndex(CTFullTextIndex), finalize()

CTFullTextIndex

public CTFullTextIndex(CTFullTextIndex FTI)

Copy constructor for the CTFullTextIndex class.

Parameters:

FTI - CTFullTextIndex object to be copied

See Also:

CTFullTextIndex(), finalize()

Method Detail

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

Overrides:

finalize in class java.lang.Object

See Also:

CTFullTextIndex(FairCom.CtreeDb.CTFullTextIndex)

AddField

public void AddField(CTField field,
                     int mode)
              throws CTException

Add a new field to Full Text Index

Parameters:

field - the field object to add

mode - the full text search field matching mode use the FTI_FIELD_MODE class members to pass this value

Throws:

CTException - in case of error

See Also:

GetFieldCount(), GetField(int)

GetFieldCount

public int GetFieldCount()
                  throws CTException

Retrieve the Full Text index field count.

Returns:

The number of field indexed

Throws:

CTException - in case of error

See Also:

AddField(FairCom.CtreeDb.CTField, int), GetField(int)

GetField

public CTField GetField(int fieldNumber)
                 throws CTException

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

public void SetOption(int option,
                      java.lang.String stringValue,
                      int intValue)
               throws CTException

Set Full Text index options

Parameters:

option - the option to set use the FTI_OPTION to pass this parameter

stringValue - value to set the option to for option taking string value

intValue - 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:

FTI_OPTION, FTI_OPTION_TOKENIZER, FTI_OPTION_UPDATE

GetName

public java.lang.String GetName()
                         throws CTException

Retrieve the Full Text index name

Returns:

The full text index name

Throws:

CTException - in case of error

GetNumber

public int GetNumber()
              throws CTException

Retrieve the ordinal number of the current Full Text index

Returns:

The full text index ordinal number

Throws:

CTException - in case of error

GetFieldMode

public int GetFieldMode(int FieldNumber)
                 throws CTException

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:

GetField(int), AddField(FairCom.CtreeDb.CTField, int)