Product Documentation

Full-Text Search

Previous Topic

Next Topic

c-treeDB C++, Java, and .NET FTS API

This section provides reference information about the following three APIs, that are all based on the c-treeDB API:

  1. c-treeDB C++
  2. c-treeDB Java (see the JTDB Javadocs)
  3. c-treeDB .NET

Each of these APIs is very similar in function. The tables below show the function name for each API.

Note: The Full-Text Index must be committed before it can be used. An FTI cannot be created and dropped in the same transaction.

The remainder of this chapter provides function details for the c-treeDB C++ API. The details are the same for c-treeDB Java and c-treeDB .NET. Only the API name will vary, as detailed in the tables below:

Class: CTTable

The following methods are available in the CTTable class:

 

c-treeDB C++ Methods

c-treeDB .NET Methods

c-treeDB Java Methods

Add a new index to the table

AddFullTextIndex

 

AddFullTextIndex

 

AddFullTextIndex

(java.lang.String name)

Remove a full text index from a table

DelFullTextIndex

by index number

by index name

DelFullTextIndex

by index number

by index name

DelFullTextIndex

by index number

by index name

Retrieve a Full Text index object

GetFullTextIndex

by index number

by index name

GetFullTextIndex

by index number

by index name

GetFullTextIndex

by index number

by index name

Retrieve the number of full text indexes of this table

GetFullTextIndexCount

GetFullTextIndexCount

GetFullTextIndexCount

 

Set Full Text index options

SetFullTextIndexOption

by index object

by index number

by index name

SetFullTextIndexOption

by index object

by index number

by index name

SetFullTextIndexOption

by index object

by index number

by index name

Class: CTRecord

The following methods are available in the CTRecord class:

 

c-treeDB C++ Methods

c-treeDB .NET Methods

c-treeDB Java Methods

Set the new record default Full Text index number

SetDefaultFullTextIndex

SetDefaultFullTextIndex

SetDefaultFullTextIndex

Set the full text search criteria

FullTextSearchOn

FullTextSearchOn

FullTextSearchOn

Indicate if Full Text Search is active on the record

IsFullTextSearchOn

IsFullTextSearchOn

IsFullTextSearchOn

Turn off Full Text Search

FullTextSearchOff

FullTextSearchOff

FullTextSearchOff

Get detail about Full Text Search error

GetFullTextSearchErrorDetails

GetFullTextSearchErrorDetails

GetFullTextSearchErrorDetails

Class: CTFullTextIndex

The following is available in the CTFullTextIndex class:

 

c-treeDB C++ Methods

c-treeDB .NET Methods

c-treeDB Java Methods

Constructors

CTFullTextIndex()

()

(CTFullTextIndex)

CTFullTextIndex

()

(CTFullTextIndex)

CTFullTextIndex

()

(CTFullTextIndex)

Add a new field to Full Text Index

AddField

AddField

AddField

Retrieve a Full Text index field

GetField

GetField

GetField

Retrieve the Full Text index field count.

GetFieldCount

GetFieldCount

GetFieldCount

Retrieve a Full Text index field mode

GetFieldMode

GetFieldMode

GetFieldMode

Retrieve the status of the index handle.

GetStatus

GetStatus

GetStatus

Set Full Text index options

SetOption

SetOption

SetOption

Retrieve the Full Text index name

GetName

GetName

GetName

Retrieve the ordinal number of the current Full Text index

GetNumber

GetNumber

GetNumber

Class: CTFullTextIndexDictionary

The following is available in the c-treeDB CTFullTextIndexDictionary class:

 

c-treeDB C++ Methods

c-treeDB .NET Methods

c-treeDB Java Methods

Constuctors

CTFullTextIndexDictionary

()

(CTDatabase)

(CTFullTextIndexDictionary)

(CTSession)

(CTTable)

 

CTFullTextIndexDictionary

()

(CTDatabase)

(CTFullTextIndexDictionary)

(CTSession)

(CTTable)

 

CTFullTextIndexDictionary

()

(CTDatabase)

(CTFullTextIndexDictionary)

(CTSession)

(CTTable)

 

Set Full Text index Dictionary options

SetOption

SetOption

SetOption

In This Chapter

Class: CTTable

Class: CTRecord

Class: CTFullTextIndex::CTFullTextIndex()

Class: CTFullTextIndexDictionary

TOCIndex