FairCom.CtreeDb

Class CTFullTextIndexDictionary

java.lang.Object

FairCom.CtreeDb.CTBase

FairCom.CtreeDb.CTFullTextIndexDictionary

public class CTFullTextIndexDictionary
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, CTFullTextIndex

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

m_handle

Constructor Summary

Constructors

Constructor and Description
CTFullTextIndexDictionary() Default constructor for the CTFullTextIndexDictionary class.
CTFullTextIndexDictionary(CTDatabase Handle) Creates a new Full Text Index Dictionary object related to a database
CTFullTextIndexDictionary(CTFullTextIndexDictionary FTID) Copy constructor for the CTFullTextIndexDictionary class.
CTFullTextIndexDictionary(CTSession Handle) Creates a new Full Text Index Dictionary object related to a session
CTFullTextIndexDictionary(CTTable Handle) Creates a new Full Text Index Dictionary object related to a table

Method Summary

Methods

Modifier and Type	Method and Description
void	finalize() Destroys an allocated CTFullTextIndexDictionary object This method should be called in order to avoid memory leaks.
void	SetOption(int option, java.lang.String sValue, int iValue) Set Full Text index Dictionary 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

CTFullTextIndexDictionary

public CTFullTextIndexDictionary()

Default constructor for the CTFullTextIndexDictionary class.

See Also:

CTFullTextIndexDictionary(FairCom.CtreeDb.CTFullTextIndexDictionary), CTFullTextIndexDictionary(FairCom.CtreeDb.CTSession), CTFullTextIndexDictionary(FairCom.CtreeDb.CTDatabase), CTFullTextIndexDictionary(FairCom.CtreeDb.CTTable), finalize()

CTFullTextIndexDictionary

public CTFullTextIndexDictionary(CTFullTextIndexDictionary FTID)

Copy constructor for the CTFullTextIndexDictionary class.

Parameters:

FTID - CTFullTextIndex object to be copied

See Also:

CTFullTextIndexDictionary(), CTFullTextIndexDictionary(FairCom.CtreeDb.CTSession), CTFullTextIndexDictionary(FairCom.CtreeDb.CTDatabase), CTFullTextIndexDictionary(FairCom.CtreeDb.CTTable), finalize()

CTFullTextIndexDictionary

public CTFullTextIndexDictionary(CTSession Handle)
                          throws CTException

Creates a new Full Text Index Dictionary object related to a session

Parameters:

Handle - the session object

Throws:

CTException - in case of error

See Also:

CTFullTextIndexDictionary(), CTFullTextIndexDictionary(FairCom.CtreeDb.CTFullTextIndexDictionary), CTFullTextIndexDictionary(FairCom.CtreeDb.CTDatabase), CTFullTextIndexDictionary(FairCom.CtreeDb.CTTable), finalize()

CTFullTextIndexDictionary

public CTFullTextIndexDictionary(CTDatabase Handle)
                          throws CTException

Creates a new Full Text Index Dictionary object related to a database

Parameters:

Handle - the database object

Throws:

CTException - in case of error

See Also:

CTFullTextIndexDictionary(), CTFullTextIndexDictionary(FairCom.CtreeDb.CTFullTextIndexDictionary), CTFullTextIndexDictionary(FairCom.CtreeDb.CTSession), CTFullTextIndexDictionary(FairCom.CtreeDb.CTTable), finalize()

CTFullTextIndexDictionary

public CTFullTextIndexDictionary(CTTable Handle)
                          throws CTException

Creates a new Full Text Index Dictionary object related to a table

Parameters:

Handle - the table object

Throws:

CTException - in case of error

See Also:

CTFullTextIndexDictionary(), CTFullTextIndexDictionary(FairCom.CtreeDb.CTFullTextIndexDictionary), CTFullTextIndexDictionary(FairCom.CtreeDb.CTSession), CTFullTextIndexDictionary(FairCom.CtreeDb.CTDatabase), finalize()

Method Detail

finalize

public void finalize()

Destroys an allocated CTFullTextIndexDictionary 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:

CTFullTextIndexDictionary(), CTFullTextIndexDictionary(FairCom.CtreeDb.CTFullTextIndexDictionary), CTFullTextIndexDictionary(FairCom.CtreeDb.CTSession), CTFullTextIndexDictionary(FairCom.CtreeDb.CTDatabase), CTFullTextIndexDictionary(FairCom.CtreeDb.CTTable)

SetOption

public void SetOption(int option,
             java.lang.String sValue,
             int iValue)
               throws CTException

Set Full Text index Dictionary options

Parameters:

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

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

iValue - value to set the option to for option taking long value

Throws:

CTException - in case of error