Package FairCom.CtreeDb

Class CTTable

Object

CTBase

CTTable

public class CTTable
extends CTBase

Deals with the table concept. Objects of the CTTable class are used to manage tables. One table may belong to several databases, and a database may have multiple tables. The table may have any number of fields. It uses CTBase as the base class, and implements the constructor/destructor allocating/freeing memory to the table operations.

See Also:

• CTBase
• CTSession
• CTDatabase
• CTRecord

Field Summary

Fields inherited from class CTBase

m_handle

Constructor Summary

Constructors

Constructor	Description
CTTable(CTDatabase Handle)	Constructor for the CTTable class based on a given CTDatabase object.
CTTable(CTHANDLE Handle)	Constructor for the CTTable class based on a given CTHANDLE.
CTTable(CTSession Handle)	Constructor for the CTTable class based on a given CTSession object.

Method Summary

Modifier and Type	Method	Description
CTField	AddField(String Name, int Type, int Length)	Adds a new field to the current table.
CTFullTextIndex	AddFullTextIndex(String name)	Add a new index to the table
CTIndex	AddIndex(String Name, int KeyType, boolean AllowDuplicates, boolean NullFlag)	Adds a new index to the current table.
void	AddMRTTable(CTDatabase database, String Name, String ParentName, int Info)	Adds an existing MRTTable definition to the database dictionary.
CTSegment	AddSegment(int IndexNbr, int FieldNbr, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(int IndexNbr, CTField Field, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(int IndexNbr, String FieldName, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(CTIndex Index, int FieldNumber, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(CTIndex Index, int offset, int length, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(CTIndex Index, CTField Field, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(CTIndex Index, String FieldName, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(String IndexName, int FieldNumber, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(String IndexName, CTField Field, int SegMode)	Adds a new segment to an index.
CTSegment	AddSegment(String IndexName, String FieldName, int SegMode)	Adds a new segment to an index.
void	Alter(int Action)	Perform alter table functions.
void	Attach(int datno)	Attaches a c-tree Plus ISAM datno object to a CTTable object.
void	ClearAllFieldDefaultValue()	Clears the default value associated with all fields in a table.
void	Clone(CTTable target, String targetName)	Creates a new table based on the current one.
void	Close()	Closes the current table.
void	Compact()	Builds data and index files.
void	Create(String Name, int CreateMode)	Creates a new table.
void	CreateMRTTable(String Name, String ParentName, int CreateMode, String Filter)	Creates a new MRTTable based on a host table..
CTResultSet	CreateResultSet(String Name)	Creates a CTResultSet object for the current table.
void	DeleteField(int FieldNumber)	Deletes a field from the current table.
void	DeleteField(String FieldName)	Deletes a field from the table.
void	DelFullTextIndex(int indexNumber)	Delete a Full Text index from a table
void	DelFullTextIndex(String indexName)	Delete a full text index from a table
void	DelIndex(int IndexNumber)	Deletes an index from the current table.
void	DelIndex(String IndexName)	Deletes an index from a table.
void	DelSegment(int IndexNumber, int SegNumber)	Deletes an existing segment.
void	DelSegment(String IndexName, int SegNumber)	Deletes an existing segment.
void	Detach()	Detaches a c-treeDB table object from c-tree data and index files.
void	FilterRecord(String cndexpr)	Sets or clears record filter condition.
void	finalize()	Destroys an allocated CTTable object.
int	GetBinaryFlag(int FieldNumber)	Retrieves the field BINARY_FLAG.
int	GetBinaryFlag(String FieldName)	Retrieves the field BINARY_FLAG.
String	GetCndxIndex(int Indexnbr)	Retrieves the index conditional expression by index number.
String	GetCndxIndex(String indexname)	Retrieves the index conditional expression by index name.
int	GetCreateMode()	Retrieves the table CREATE_MODE.
int	GetDataDefaultExtentSize()	Retrieves the c-tree data file default extent size.
String	GetDataExtension()	Gets the data file name extension.
int	GetDatno()	Retrieves the table data file number.
char	GetDlmChar()	Retrieves the table field delimiter character.
CTField	GetField(int FieldNumber)	Retrieves a field by its number.
CTField	GetField(String FieldName)	Retrieves a field by its name.
int	GetFieldCount()	Retrieves the number of fields in the table.
int	GetFieldNumber(String FieldName)	Retrieves the field number from the current table, given its field name.
String	GetFilter()	Retrieves the current filter expression for the table.
CTFullTextIndex	GetFullTextIndex(int indexNumber)	Retrieve a Full Text index object
CTFullTextIndex	GetFullTextIndex(String name)	Retrieve the Full Text index given its name
int	GetFullTextIndexCount()	Retrieve the number of full text indices of this table
String	GetGroupid()	Retrieves the table group id.
String	GetIdentityField()	Retrieves the name of the Identity field.
long	GetIdentityFieldIncrement()	Retrieves the increment value of the Identity field.
long	GetIdentityFieldSeed()	Retrieves the seed value of the Identity field.
int	GetIdxno(int Index)	Retrieves the index file number by the index number.
int	GetIdxno(String IndexName)	Retrieves the index file number by the index name.
CTIndex	GetIndex(int IndexNumber)	Retrieves an index handle by its number in the current table.
CTIndex	GetIndex(String name)	Retrieves the index by its name.
CTIndex	GetIndexByUID(int uid)	Retrieves an index object given its UID - internal Unique Identification.
int	GetIndexCount()	Retrieves the number of indices in the current table.
int	GetIndexDefaultExtentSize()	Retrieves the c-tree index file default extent size.
String	GetIndexExtension()	Gets the index file name extension.
String	GetIndexFilename(int IndexNumber)	Retrieves the index file name.
String	GetIndexFilename(String IndexName)	Retrieves the index file name.
long	GetLastIdentity()	Retrieves the next identity value.
String	GetName()	Gets the table name, without the name extension.
int	GetOpenMode()	Retrieves the table OPEN_MODE.
String	GetOwner()	Retrieves the current table owner.
char	GetPadChar()	Retrieves the table pad character.
int	GetPartitionIndexNbr()	Retrieve the number of the partition index
String	GetPassword()	Retrieves the table password.
String	GetPath()	Gets the table path.
int	GetPermission()	Retrieves the table permission mask.
CTResultSet	GetResultSetByName(String Name)	Retrieves the CTResultSet for the current table by its name.
CTSegment	GetSegment(CTIndex Index, int SegNumber)	Retrieves an index segment object by its number.
int	GetStatus()	Retrieves current TABLE_STATUS.
long	GetVTableNumber()	Retrieves the number assigned to a virtual table.
boolean	HasDelField()	Indicates if a table has the $DELFLD$ internal field.
boolean	HasLocks()	Check if there is any lock acquired on the table in the current session.
boolean	HasNullFieldSupport()	Indicates if a table has null field support.
boolean	HasRecbyt()	Indicates if a table was created with recbyt index.
boolean	HasRowid()	Indicates if a table was created with rowid index.
CTField	InsertField(int BeforeField, String Name, int Type, int Length)	Inserts a new field into the current table, in the specified position.
CTField	InsertField(String BeforeField, String Name, int Type, int Length)	Inserts a new field into the current table, in the specified position.
CTSegment	InsertSegment(int IndexNbr, int BeforeSegment, int FieldNumber, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(int IndexNbr, int BeforeSegment, CTField Field, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(int IndexNbr, int BeforeSegment, String FieldName, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(CTIndex Index, int BeforeSegment, int FieldNumber, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(CTIndex Index, int BeforeSegment, int offset, int length, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(CTIndex Index, int BeforeSegment, CTField Field, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(CTIndex Index, int BeforeSegment, String FieldName, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(String IndexName, int BeforeSegment, int FieldNumber, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(String IndexName, int BeforeSegment, CTField Field, int SegMode)	Inserts a new segment to an index in a given position.
CTSegment	InsertSegment(String IndexName, int BeforeSegment, String FieldName, int SegMode)	Inserts a new segment to an index in a given position.
boolean	IsActive()	Checks if a table is active.
boolean	IsFilteredRecord()	Checks if the current table has a record filter active.
boolean	IsVTable()	Check if a table is a virtual table or a regular table.
void	MoveField(int FieldNumber, int newNumber)	Moves the field to a new position in the current table
void	MoveField(String FieldName, int newNumber)	Moves the field to a new position in the current table.
void	MoveSegment(int indexNumber, int segNumber, int newIndex)	Moves a segment to another position.
void	MoveSegment(CTIndex hIndex, int segNumber, int newIndex)	Moves a segment to another position.
void	MoveSegment(String indexName, int segNumber, int newIndex)	Moves a segment to another position.
long	NumberOfKeyEntries(int index)	Retrieves the number of key entries in a index file.
long	NumberOfKeyEntries(String indexName)	Retrieves the number of key entries in an index file.
void	Open(String Name, int OpenMode)	Opens an existing table for the current object.
int	PartAdminByName(String PartName, int PartMode)	Performs a partition operation on the partition specified by name.
int	PartAdminByNumber(int Prawno, int PartMode)	Performs a partition operation on the partition specified by raw partition number.
void	Rebuild(int Mode)	Builds data and index files.
void	Remove()	Deletes the current table.
void	RemoveVTableResource(CTTable Parent, int Number)	Removes a virtual table resource.
void	ResetAll()	Reset all active record buffers associated with table.
void	SetBinaryFlag(int FieldNumber, int Flag)	Sets the field BINARY_FLAG.
void	SetBinaryFlag(String FieldName, int Flag)	Sets the field BINARY_FLAG.
void	SetDataDefaultExtentSize(int size)	Sets the c-tree data file default extent size
void	SetDataExtension(String Ext)	Sets the table data extension.
void	SetFullTextIndexOption(int indexNbr, int option, String svalue, int ivalue)	Set Full Text index options
void	SetFullTextIndexOption(CTFullTextIndex pIndex, int option, String svalue, int ivalue)	Set Full Text index options
void	SetFullTextIndexOption(String indexName, int option, String svalue, int ivalue)	Set Full Text index options
void	SetGroupid(String Groupid)	Sets the table group id.
void	SetIdentityField(String FieldName, long Seed, long Increment)	Sets the identity field.
void	SetIndexDefaultExtentSize(int size)	Sets the c-tree index file default extent size
void	SetIndexExtension(String Ext)	Sets the table index extension.
void	SetIndexFilename(int IndexNumber, String Path, String Filename)	Sets the index file name.
void	SetIndexFilename(String IndexName, String Path, String Filename)	Sets the index file name.
void	SetMRTTableFilter(String Condition)	Sets filter information in the virtual table handle.
void	SetOwner(String owner)	Sets the table owner.
void	SetPadChar(char Padchar, char Dlmchar)	Sets the table pad and field delimiter characters in the table handle.
void	SetPassword(String Password)	Sets the table password.
void	SetPath(String Path)	Sets the table path.
void	SetPermission(int Permmask)	Sets the table permission mask.
void	UnlockTable()	Releases all record locks associated with the current table.
void	UpdateCndxIndex(int indexnbr, String cndexpr)	Add, modify or delete conditional index by number.
void	UpdateCndxIndex(String Indexname, String Cndexpr)	Add, modify or delete conditional index by name.
void	UpdateCreateMode(int mode)	Updates the table create mode.
void	UpdatePadChar(char Padchar, char Dmlchar, boolean Rebuild)	Updates the table pad and delimiter character resource.

Methods 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

Methods inherited from class Object

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

Constructor Details

CTTable

public CTTable(CTHANDLE Handle)
        throws CTException

Constructor for the CTTable class based on a given CTHANDLE.

Parameters:

Handle - Table handle for which the CTTable is created.

Throws:

CTException - in case of error

See Also:

• CTTable(FairCom.CtreeDb.CTDatabase)
• CTTable(FairCom.CtreeDb.CTSession)
• finalize()

CTTable

public CTTable(CTDatabase Handle)
        throws CTException

Constructor for the CTTable class based on a given CTDatabase object.

Parameters:

Handle - Existing CTDatabase object for which the CTTable is created.

Throws:

CTException - in case of error

See Also:

• CTTable(FairCom.CtreeDb.CTHANDLE)
• CTTable(FairCom.CtreeDb.CTSession)
• finalize()

CTTable

public CTTable(CTSession Handle)
        throws CTException

Constructor for the CTTable class based on a given CTSession object.

Parameters:

Handle - Existing CTSession object for which the CTTable is created.

Throws:

CTException - in case of error

See Also:

• CTTable(FairCom.CtreeDb.CTHANDLE)
• CTTable(FairCom.CtreeDb.CTDatabase)
• finalize()

Method Details

finalize

public void finalize()

Destroys an allocated CTTable object. This method should be called in order to avoid memory leaks. Releases all resources associated with a table.

Overrides:

finalize in class Object

See Also:

• CTTable(FairCom.CtreeDb.CTHANDLE)
• CTTable(FairCom.CtreeDb.CTDatabase)
• CTTable(FairCom.CtreeDb.CTSession)

Open

public void Open(String Name,
 int OpenMode)
          throws CTException

Opens an existing table for the current object.

Parameters:

Name - Table name to be opened.

OpenMode - OPEN_MODE to be used.

Throws:

CTException - in case of error

See Also:

• GetOpenMode()
• Create(java.lang.String, int)
• Close()
• IsActive()

Close

public void Close()
           throws CTException

Closes the current table.

Throws:

CTException - in case of error

See Also:

• Open(java.lang.String, int)
• IsActive()

IsActive

public boolean IsActive()

Checks if a table is active. A table is active if it is open.

Returns:

true if the table is active, false otherwise.

See Also:

• Open(java.lang.String, int)
• Close()
• GetOpenMode()

GetName

public String GetName()
               throws CTException

Gets the table name, without the name extension.

Returns:

Current table name.

Throws:

CTException - in case of error

See Also:

• GetPath()
• GetOpenMode()
• GetPassword()
• GetPermission()

GetPath

public String GetPath()

Gets the table path.

Returns:

Current table path.

See Also:

• SetPath(java.lang.String)
• GetOpenMode()
• GetName()

GetDataExtension

public String GetDataExtension()
                        throws CTException

Gets the data file name extension. If not changed by SetDataExtension(java.lang.String), the data extension is "dat"

Returns:

Current data file name extension.

Throws:

CTException - in case of error

See Also:

• SetDataExtension(java.lang.String)
• GetName()
• GetIndexExtension()

GetIndexExtension

public String GetIndexExtension()
                         throws CTException

Gets the index file name extension. If not changed by SetIndexExtension(java.lang.String), the index extension is "idx"

Returns:

Current index file name extension.

Throws:

CTException - in case of error

See Also:

• SetIndexExtension(java.lang.String)
• GetName()
• GetDataExtension()

GetOpenMode

public int GetOpenMode()

Retrieves the table OPEN_MODE.

Returns:

Current OPEN_MODE value.

See Also:

• Open(java.lang.String, int)
• GetOpenMode()
• GetCreateMode()

GetCreateMode

public int GetCreateMode()

Retrieves the table CREATE_MODE.

Returns:

Current CREATE_MODE value.

See Also:

• UpdateCreateMode(int)
• Create(java.lang.String, int)
• GetOpenMode()

GetDataDefaultExtentSize

public int GetDataDefaultExtentSize()

Retrieves the c-tree data file default extent size.

Returns:

Default data file extent size. The default value, 8192 bytes, may be changed by calling SetDataDefaultExtentSize(int).

See Also:

• SetIndexDefaultExtentSize(int)
• GetDataDefaultExtentSize()

GetIndexDefaultExtentSize

public int GetIndexDefaultExtentSize()

Retrieves the c-tree index file default extent size.

Returns:

Default index file extent size. The default value, 8192 bytes, may be changed by calling SetIndexDefaultExtentSize(int).

See Also:

• SetIndexDefaultExtentSize(int)
• GetDataDefaultExtentSize()

GetPassword

public String GetPassword()

Retrieves the table password.

Returns:

Current table password.

See Also:

• SetPassword(java.lang.String)
• GetName()
• GetPath()
• GetGroupid()
• GetPermission()

GetGroupid

public String GetGroupid()

Retrieves the table group id.

Returns:

Current table group id.

See Also:

• SetGroupid(java.lang.String)
• GetName()
• GetPath()
• GetPassword()
• GetPermission()

GetPermission

public int GetPermission()

Retrieves the table permission mask.

Returns:

Current table permission mask.

See Also:

• SetPermission(int)
• GetName()
• GetPath()
• GetGroupid()
• GetPassword()

SetPath

public void SetPath(String Path)
             throws CTException

Sets the table path.

Parameters:

Path - New table path value.

Throws:

CTException - in case of error

See Also:

• GetPath()
• SetDataExtension(java.lang.String)
• SetIndexExtension(java.lang.String)

SetDataExtension

public void SetDataExtension(String Ext)
                      throws CTException

Sets the table data extension.

Parameters:

Ext - New table data extension.

Throws:

CTException - in case of error

See Also:

• GetDataExtension()
• SetIndexExtension(java.lang.String)
• GetPath()

SetIndexExtension

public void SetIndexExtension(String Ext)
                       throws CTException

Sets the table index extension.

Parameters:

Ext - New index data extension.

Throws:

CTException - in case of error

See Also:

• GetIndexExtension()
• SetPath(java.lang.String)
• SetDataExtension(java.lang.String)

SetDataDefaultExtentSize

public void SetDataDefaultExtentSize(int size)
                              throws CTException

Sets the c-tree data file default extent size

Each time the data file needs to be extended, it will use this value to extent the file. If not changed by SetDataDefaultExtentSize(), this value is 8192 bytes

Parameters:

size - New default data extent size.

Throws:

CTException - in case of error

See Also:

• GetDataDefaultExtentSize()
• SetIndexDefaultExtentSize(int)

SetIndexDefaultExtentSize

public void SetIndexDefaultExtentSize(int size)
                               throws CTException

Sets the c-tree index file default extent size

Each time the index file needs to be extended, it will use this value to extent the file. If not changed by SetDataDefaultExtentSize(), this value is 8192 bytes.

Parameters:

size - New default index extent size.

Throws:

CTException - in case of error

See Also:

• GetIndexDefaultExtentSize()
• SetDataDefaultExtentSize(int)

SetPassword

public void SetPassword(String Password)
                 throws CTException

Sets the table password.

Parameters:

Password - New table password.

Throws:

CTException - in case of error

See Also:

• GetPassword()
• SetGroupid(java.lang.String)
• SetPermission(int)

SetGroupid

public void SetGroupid(String Groupid)
                throws CTException

Sets the table group id.

Parameters:

Groupid - New table group id.

Throws:

CTException - in case of error

See Also:

• GetGroupid()
• SetPassword(java.lang.String)
• SetPermission(int)

SetPermission

public void SetPermission(int Permmask)
                   throws CTException

Sets the table permission mask.

Parameters:

Permmask - New table permission mask.

Throws:

CTException - in case of error

See Also:

• GetPermission()
• SetPassword(java.lang.String)
• SetGroupid(java.lang.String)

Create

public void Create(String Name,
 int CreateMode)
            throws CTException

Creates a new table. Before the table creation, it must be defined with AddField(java.lang.String, int, int), and optionally with AddIndex(java.lang.String, int, boolean, boolean) and AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int).

Parameters:

Name - New table name.

CreateMode - CREATE_MODE to be used.

Throws:

CTException - in case of error

See Also:

• AddField(java.lang.String, int, int)
• GetCreateMode()
• Open(java.lang.String, int)

GetFieldCount

public int GetFieldCount()

Retrieves the number of fields in the table.

Returns:

Current number of fields.

See Also:

• AddField(java.lang.String, int, int)
• DeleteField(int)
• InsertField(int, java.lang.String, int, int)
• GetFieldNumber(java.lang.String)
• GetIndexCount()

AddField

public CTField AddField(String Name,
 int Type,
 int Length)
                 throws CTException

Adds a new field to the current table.

Parameters:

Name - New field name.

Type - New FIELD_TYPE.

Length - New field length, the maximum length of [VAR]CHAR or [VAR]BINARY field in bytes (64K max). Set to 0 for "unlimited" (2GB) LVARCHAR.

Returns:

The new CTField object on success or null on failure.

Throws:

CTException - in case of error

See Also:

• InsertField(int, java.lang.String, int, int)
• DeleteField(int)
• GetField(int)
• AddIndex(java.lang.String, int, boolean, boolean)

InsertField

public CTField InsertField(int BeforeField,
 String Name,
 int Type,
 int Length)
                    throws CTException

Inserts a new field into the current table, in the specified position.

Parameters:

BeforeField - Insert the new field before this field number.

Name - New field name.

Type - New FIELD_TYPE.

Length - New field length.

Returns:

The new CTField object on success or null on failure.

Throws:

CTException - in case of error

See Also:

• InsertField(java.lang.String, java.lang.String, int, int)
• AddField(java.lang.String, int, int)
• DeleteField(int)
• GetField(int)
• GetFieldNumber(java.lang.String)

InsertField

public CTField InsertField(String BeforeField,
 String Name,
 int Type,
 int Length)
                    throws CTException

Inserts a new field into the current table, in the specified position.

Parameters:

BeforeField - Insert the new field before this field name.

Name - New field name.

Type - New FIELD_TYPE.

Length - New field length.

Returns:

The new CTField object on success or null on failure.

Throws:

CTException - in case of error

See Also:

• InsertField(int, java.lang.String, int, int)
• AddField(java.lang.String, int, int)
• DeleteField(int)
• GetField(int)
• GetFieldNumber(java.lang.String)

DeleteField

public void DeleteField(int FieldNumber)
                 throws CTException

Deletes a field from the current table.

Parameters:

FieldNumber - Field number to be deleted.

Throws:

CTException - in case of error

See Also:

• DeleteField(java.lang.String)
• AddField(java.lang.String, int, int)
• InsertField(int, java.lang.String, int, int)
• GetField(int)
• GetFieldNumber(java.lang.String)

DeleteField

public void DeleteField(String FieldName)
                 throws CTException

Deletes a field from the table.

Parameters:

FieldName - Field name to be deleted.

Throws:

CTException - in case of error

See Also:

• DeleteField(int)
• AddField(java.lang.String, int, int)
• InsertField(int, java.lang.String, int, int)
• GetField(int)
• GetFieldNumber(java.lang.String)

MoveField

public void MoveField(int FieldNumber,
 int newNumber)
               throws CTException

Moves the field to a new position in the current table

Parameters:

FieldNumber - Current field number.

newNumber - New field number.

Throws:

CTException - in case of error

See Also:

• MoveField(java.lang.String, int)
• AddField(java.lang.String, int, int)
• InsertField(int, java.lang.String, int, int)
• GetField(int)
• DeleteField(int)

MoveField

public void MoveField(String FieldName,
 int newNumber)
               throws CTException

Moves the field to a new position in the current table.

Parameters:

FieldName - Field name to be moved.

newNumber - New field number.

Throws:

CTException - in case of error

See Also:

• MoveField(int, int)
• AddField(java.lang.String, int, int)
• InsertField(int, java.lang.String, int, int)
• GetField(int)
• DeleteField(int)

GetField

public CTField GetField(int FieldNumber)
                 throws CTException

Retrieves a field by its number.

Parameters:

FieldNumber - Field number to be retrieved.

Returns:

CTField object found.

Throws:

CTException - in case of error

See Also:

• GetField(java.lang.String)
• AddField(java.lang.String, int, int)
• InsertField(int, java.lang.String, int, int)
• GetFieldNumber(java.lang.String)
• DeleteField(int)

GetField

public CTField GetField(String FieldName)
                 throws CTException

Retrieves a field by its name.

Parameters:

FieldName - Field name to be retrieved.

Returns:

CTField object found.

Throws:

CTException - in case of error

See Also:

• GetField(int)
• AddField(java.lang.String, int, int)
• InsertField(int, java.lang.String, int, int)
• GetFieldNumber(java.lang.String)
• DeleteField(int)

GetFieldNumber

public int GetFieldNumber(String FieldName)
                   throws CTException

Retrieves the field number from the current table, given its field name.

Parameters:

FieldName - Field name to be retrieved.

Returns:

Field number.

Throws:

CTException - in case of error

See Also:

• AddField(java.lang.String, int, int)
• InsertField(int, java.lang.String, int, int)
• GetField(int)
• DeleteField(int)

GetIndexCount

public int GetIndexCount()

Retrieves the number of indices in the current table.

Returns:

Current number of indices.

See Also:

• AddIndex(java.lang.String, int, boolean, boolean)
• DelIndex(int)
• GetFieldCount()

AddIndex

public CTIndex AddIndex(String Name,
 int KeyType,
 boolean AllowDuplicates,
 boolean NullFlag)
                 throws CTException

Adds a new index to the current table.

Parameters:

Name - New index name.

KeyType - New index KEY_TYPE value.

AllowDuplicates - Boolean indicating if index allows duplicate keys.

NullFlag - Boolean indicating if index allows null keys.

Returns:

New CTIndex object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• Alter(int)
• GetIndexCount()
• DelIndex(int)
• GetIndex(int)

AddMRTTable

public void AddMRTTable(CTDatabase database,
 String Name,
 String ParentName,
 int Info)
                 throws CTException

Adds an existing MRTTable definition to the database dictionary.

Parameters:

database - The database handle

Name - The table name

ParentName - The host table name

Info - The MRTTable definition number

Throws:

CTException - in case of error

GetVTableNumber

public long GetVTableNumber()

Retrieves the number assigned to a virtual table.

Returns:

The number assigned to a virtual table.

IsVTable

public boolean IsVTable()

Check if a table is a virtual table or a regular table.

Returns:

YES if the table is a Virtual Table, NO otherwise.

RemoveVTableResource

public void RemoveVTableResource(CTTable Parent,
 int Number)
                          throws CTException

Removes a virtual table resource.

Parameters:

Parent - Host table to which the virtual table is assigned.

Number - Number of the virtual table.

Throws:

CTException - in case of error

SetMRTTableFilter

public void SetMRTTableFilter(String Condition)
                       throws CTException

Sets filter information in the virtual table handle.

Parameters:

Condition - Filter condition.

Throws:

CTException - in case of error

DelIndex

public void DelIndex(int IndexNumber)
              throws CTException

Deletes an index from the current table.

Parameters:

IndexNumber - The number of the index to be deleted.

Throws:

CTException - in case of error

See Also:

• DelIndex(java.lang.String)
• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• Alter(int)
• GetIndexCount()
• AddIndex(java.lang.String, int, boolean, boolean)
• GetIndex(int)

DelIndex

public void DelIndex(String IndexName)
              throws CTException

Deletes an index from a table.

Parameters:

IndexName - Index name to be deleted.

Throws:

CTException - in case of error

See Also:

• DelIndex(int)
• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• Alter(int)
• GetIndexCount()
• AddIndex(java.lang.String, int, boolean, boolean)
• GetIndex(int)

GetIndex

public CTIndex GetIndex(int IndexNumber)
                 throws CTException

Retrieves an index handle by its number in the current table.

Parameters:

IndexNumber - Index number in the table.

Returns:

Found CTIndex object.

Throws:

CTException - in case of error

See Also:

• GetIndex(java.lang.String)
• DelIndex(int)
• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• Alter(int)
• GetIndexCount()
• AddIndex(java.lang.String, int, boolean, boolean)

GetIndex

public CTIndex GetIndex(String name)
                 throws CTException

Retrieves the index by its name.

Parameters:

name - Index name.

Returns:

Found CTIndex object.

Throws:

CTException - in case of error

See Also:

• GetIndex(int)
• DelIndex(int)
• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• Alter(int)
• GetIndexCount()
• AddIndex(java.lang.String, int, boolean, boolean)

AddSegment

public CTSegment AddSegment(CTIndex Index,
 CTField Field,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

Index - CTIndex to be modified.

Field - CTField to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(CTIndex Index,
 String FieldName,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

Index - CTIndex to be modified.

FieldName - Field name to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(CTIndex Index,
 int FieldNumber,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

Index - CTIndex to be modified.

FieldNumber - Field number to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(CTIndex Index,
 int offset,
 int length,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

Index - CTIndex to be modified.

offset - Absolute byte offset to be set in the new segment.

length - Segment length in bytes.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(int IndexNbr,
 int FieldNbr,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

IndexNbr - Index number to be modified.

FieldNbr - Field number to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(int IndexNbr,
 String FieldName,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

IndexNbr - Index number to be modified.

FieldName - Field name to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(int IndexNbr,
 CTField Field,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

IndexNbr - Index number to be modified.

Field - CTField to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(String IndexName,
 String FieldName,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

IndexName - Index name to be modified.

FieldName - Field name to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(String IndexName,
 int FieldNumber,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

IndexName - Index name to be modified.

FieldNumber - Field number to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

AddSegment

public CTSegment AddSegment(String IndexName,
 CTField Field,
 int SegMode)
                     throws CTException

Adds a new segment to an index.

Parameters:

IndexName - Index name to be modified.

Field - CTField to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Added CTSegment object.

Throws:

CTException - in case of error

See Also:

• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(CTIndex Index,
 int BeforeSegment,
 CTField Field,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

Index - CTIndex to be modified.

BeforeSegment - Insert the segment before this existing segment.

Field - CTField to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(CTIndex Index,
 int BeforeSegment,
 String FieldName,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

Index - CTIndex to be modified.

BeforeSegment - Insert the segment before this existing segment.

FieldName - Field name to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(CTIndex Index,
 int BeforeSegment,
 int FieldNumber,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

Index - CTIndex to be modified.

BeforeSegment - Insert the segment before this existing segment.

FieldNumber - Field number to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(CTIndex Index,
 int BeforeSegment,
 int offset,
 int length,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

Index - CTIndex to be modified.

BeforeSegment - Insert the segment before this existing segment.

offset - Segment absolute offset.

length - Segment length in bytes.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(int IndexNbr,
 int BeforeSegment,
 int FieldNumber,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

IndexNbr - Index number to be modified.

BeforeSegment - Insert the segment before this existing segment.

FieldNumber - Field number to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(int IndexNbr,
 int BeforeSegment,
 String FieldName,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

IndexNbr - Index number to be modified.

BeforeSegment - Insert the segment before this existing segment.

FieldName - Field name to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(String IndexName,
 int BeforeSegment,
 String FieldName,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

IndexName - Index name to be modified.

BeforeSegment - Insert the segment before this existing segment.

FieldName - Field name to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(String IndexName,
 int BeforeSegment,
 int FieldNumber,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

IndexName - Index name to be modified.

BeforeSegment - Insert the segment before this existing segment.

FieldNumber - Field number to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(String IndexName,
 int BeforeSegment,
 CTField Field,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

IndexName - Index name to be modified.

BeforeSegment - Insert the segment before this existing segment.

Field - CTField to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

InsertSegment

public CTSegment InsertSegment(int IndexNbr,
 int BeforeSegment,
 CTField Field,
 int SegMode)
                        throws CTException

Inserts a new segment to an index in a given position.

Parameters:

IndexNbr - Index number to be modified.

BeforeSegment - Insert the segment before this existing segment.

Field - CTField to be set in the new segment.

SegMode - SEG_MODE to be used in the new segment.

Returns:

Inserted CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

DelSegment

public void DelSegment(int IndexNumber,
 int SegNumber)
                throws CTException

Deletes an existing segment.

Parameters:

IndexNumber - Index number to be modified.

SegNumber - Segment number to be deleted.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

DelSegment

public void DelSegment(String IndexName,
 int SegNumber)
                throws CTException

Deletes an existing segment.

Parameters:

IndexName - Index name to be modified.

SegNumber - Segment number to be deleted.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• GetSegment(FairCom.CtreeDb.CTIndex, int)
• Alter(int)

GetSegment

public CTSegment GetSegment(CTIndex Index,
 int SegNumber)
                     throws CTException

Retrieves an index segment object by its number.

Parameters:

Index - CTIndex to be checked.

SegNumber - Segment number.

Returns:

Found CTSegment object.

Throws:

CTException - in case of error

See Also:

• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• InsertSegment(FairCom.CtreeDb.CTIndex, int, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)
• Alter(int)

Alter

public void Alter(int Action)
           throws CTException

Perform alter table functions.

Parameters:

Action - ALTER_TABLE action to be taken.

Throws:

CTException - in case of error

See Also:

• AddIndex(java.lang.String, int, boolean, boolean)
• DelIndex(int)
• AddField(java.lang.String, int, int)
• DeleteField(int)
• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)

ResetAll

public void ResetAll()
              throws CTException

Reset all active record buffers associated with table.

Throws:

CTException - in case of error

HasNullFieldSupport

public boolean HasNullFieldSupport()

Indicates if a table has null field support.

Returns:

true if the table has null field support, otherwise false.

See Also:

• HasRecbyt()
• HasRowid()

GetIndexByUID

public CTIndex GetIndexByUID(int uid)
                      throws CTException

Retrieves an index object given its UID - internal Unique Identification.

Parameters:

uid - Unique Identification in the database.

Returns:

Found CTIndex object.

Throws:

CTException - in case of error

See Also:

• GetIndex(int)

HasRecbyt

public boolean HasRecbyt()

Indicates if a table was created with recbyt index.

Returns:

true if table has recbyt index, false otherwise.

See Also:

• HasNullFieldSupport()
• HasRowid()

HasRowid

public boolean HasRowid()

Indicates if a table was created with rowid index.

Returns:

true if table has rowid index, false otherwise.

See Also:

• HasNullFieldSupport()
• HasRecbyt()

UnlockTable

public void UnlockTable()
                 throws CTException

Releases all record locks associated with the current table.

Throws:

CTException - in case of error

UpdateCndxIndex

public void UpdateCndxIndex(int indexnbr,
 String cndexpr)
                     throws CTException

Add, modify or delete conditional index by number.

Parameters:

indexnbr - Index number to be modified.

cndexpr - New conditional expression.

Throws:

CTException - in case of error

See Also:

• UpdateCndxIndex(java.lang.String, java.lang.String)
• GetCndxIndex(int)
• GetIndex(int)
• GetIndexByUID(int)

UpdateCndxIndex

public void UpdateCndxIndex(String Indexname,
 String Cndexpr)
                     throws CTException

Add, modify or delete conditional index by name.

Parameters:

Indexname - Index name to be modified.

Cndexpr - index conditional expression.

Throws:

CTException - in case of error

See Also:

• UpdateCndxIndex(int, java.lang.String)
• GetCndxIndex(int)
• GetIndex(int)
• GetIndexByUID(int)

GetCndxIndex

public String GetCndxIndex(int Indexnbr)
                    throws CTException

Retrieves the index conditional expression by index number.

Parameters:

Indexnbr - Index number to be checked.

Returns:

Conditional index expression.

Throws:

CTException - in case of error

See Also:

• UpdateCndxIndex(int, java.lang.String)
• GetIndex(int)
• GetIndexByUID(int)

GetCndxIndex

public String GetCndxIndex(String indexname)
                    throws CTException

Retrieves the index conditional expression by index name.

Parameters:

indexname - Index name to be checked.

Returns:

Conditional index expression.

Throws:

CTException - in case of error

See Also:

• UpdateCndxIndex(int, java.lang.String)
• GetIndex(int)
• GetIndexByUID(int)

FilterRecord

public void FilterRecord(String cndexpr)
                  throws CTException

Sets or clears record filter condition. If a filter is set, all record reads will evaluate the conditional expression against the record data. If the result is false the record is skipped. The filter condition remains in place until the table is closed or replaced by another conditional expression. Pass an empty String to switch off the current filter state.

Parameters:

cndexpr - Conditional expression used to filter the records. Pass an empty String to switch off the filter state.

Throws:

CTException - in case of error

See Also:

• IsFilteredRecord()
• GetFilter()

IsFilteredRecord

public boolean IsFilteredRecord()
                         throws CTException

Checks if the current table has a record filter active.

Returns:

Returns true if a filter is active, false otherwise.

Throws:

CTException - in case of error

See Also:

• FilterRecord(java.lang.String)
• GetFilter()

GetFilter

public String GetFilter()
                 throws CTException

Retrieves the current filter expression for the table.

Returns:

Record filter expression.

Throws:

CTException - in case of error

See Also:

• FilterRecord(java.lang.String)
• IsFilteredRecord()

UpdateCreateMode

public void UpdateCreateMode(int mode)
                      throws CTException

Updates the table create mode.

Parameters:

mode - New table CREATE_MODE value.

Throws:

CTException - in case of error

See Also:

• Create(java.lang.String, int)
• GetCreateMode()

GetPadChar

public char GetPadChar()
                throws CTException

Retrieves the table pad character. This character is used to pad fixed String fields (CT_FSTRING) to allow proper target key formation.

Returns:

Current pad character.

Throws:

CTException - in case of error

See Also:

• SetPadChar(char, char)
• UpdatePadChar(char, char, boolean)
• GetDlmChar()

GetDlmChar

public char GetDlmChar()
                throws CTException

Retrieves the table field delimiter character. This character is used to pad fixed String fields (CT_FSTRING) to allow proper target key formation.

Returns:

Field delimiter character.

Throws:

CTException - in case of error

See Also:

• GetPadChar()
• SetPadChar(char, char)

SetPadChar

public void SetPadChar(char Padchar,
 char Dlmchar)
                throws CTException

Sets the table pad and field delimiter characters in the table handle. These characters are used to pad fixed String fields (CT_FSTRING) to allow proper target key formation.

Parameters:

Padchar - New pad character.

Dlmchar - New field delimiter character.

Throws:

CTException - in case of error

See Also:

• GetPadChar()
• GetDlmChar()
• UpdatePadChar(char, char, boolean)

UpdatePadChar

public void UpdatePadChar(char Padchar,
 char Dmlchar,
 boolean Rebuild)
                   throws CTException

Updates the table pad and delimiter character resource. The table must be opened exclusive to allow update of the resource.

Parameters:

Padchar - New pad character.

Dmlchar - New field delimiter character.

Rebuild - Indicate if the table should be rebuilt. If rebuild is set to true, every record is read and the fixed String fields (CT_FSTRING) are padded according to new padding strategy.

Throws:

CTException - in case of error

See Also:

• GetPadChar()
• GetDlmChar()
• SetPadChar(char, char)

HasDelField

public boolean HasDelField()

Indicates if a table has the $DELFLD$ internal field.

Returns:

True if the table has $DELFLD$ field or false if the table has no $DELFLD$ field or if the handle is invalid (not allocated, the table is not opened, is not a table handle, etc).

See Also:

• HasRecbyt()
• HasRowid()

SetIndexFilename

public void SetIndexFilename(int IndexNumber,
 String Path,
 String Filename)
                      throws CTException

Sets the index file name.

Parameters:

IndexNumber - Index number to be modified.

Path - Index path. If NULL use the table path.

Filename - Index file name. If NULL use the table name.

Throws:

CTException - in case of error

See Also:

• SetIndexFilename(java.lang.String, java.lang.String, java.lang.String)
• SetIndexExtension(java.lang.String)
• GetIndexFilename(int)

SetIndexFilename

public void SetIndexFilename(String IndexName,
 String Path,
 String Filename)
                      throws CTException

Sets the index file name.

Parameters:

IndexName - Index name to be modified.

Path - Index path. If NULL use the table path.

Filename - index file name. If NULL use the table name.

Throws:

CTException - in case of error

See Also:

• SetIndexFilename(int, java.lang.String, java.lang.String)
• SetIndexExtension(java.lang.String)
• GetIndexFilename(int)

GetIndexFilename

public String GetIndexFilename(int IndexNumber)
                        throws CTException

Retrieves the index file name.

Parameters:

IndexNumber - Index number to be checked.

Returns:

Current index file name. If Index name is null the returned String will be cleared.

Throws:

CTException - in case of error

See Also:

• GetIndexFilename(java.lang.String)
• SetIndexFilename(int, java.lang.String, java.lang.String)
• SetIndexExtension(java.lang.String)

GetIndexFilename

public String GetIndexFilename(String IndexName)
                        throws CTException

Retrieves the index file name.

Parameters:

IndexName - Index name to be checked.

Returns:

Current index file name. If Index name is NULL the returned String will be cleared.

Throws:

CTException - in case of error

See Also:

• GetIndexFilename(int)
• SetIndexFilename(int, java.lang.String, java.lang.String)
• SetIndexExtension(java.lang.String)

GetDatno

public int GetDatno()
             throws CTException

Retrieves the table data file number.

Returns:

Table data file number.

Throws:

CTException - in case of error

See Also:

• GetIdxno(int)

GetIdxno

public int GetIdxno(int Index)
             throws CTException

Retrieves the index file number by the index number.

Parameters:

Index - Index number. The first index number is zero.

Returns:

Index file number.

Throws:

CTException - in case of error

See Also:

• GetIdxno(java.lang.String)
• GetDatno()

GetIdxno

public int GetIdxno(String IndexName)
             throws CTException

Retrieves the index file number by the index name.

Parameters:

IndexName - Index name.

Returns:

Index file number.

Throws:

CTException - in case of error

See Also:

• GetIdxno(int)
• GetDatno()

Remove

public void Remove()
            throws CTException

Deletes the current table. If the table was open under a database, the table is first dropped from the database and then deleted from disc.

Throws:

CTException - in case of error

See Also:

• Create(java.lang.String, int)

ClearAllFieldDefaultValue

public void ClearAllFieldDefaultValue()
                               throws CTException

Clears the default value associated with all fields in a table. The default date and time types for each field are also reset to the default values of CTDATE_MDCY and CTIME_HMS respectively.

Throws:

CTException - in case of error

GetStatus

public int GetStatus()

Retrieves current TABLE_STATUS. The table status indicate which rebuild action will be taken by an alter table operation.

For example, to check if a table needs to rebuild all indexes or perform a full rebuild, the following code can be used:

int status = hTable.GetStatus(); if ((status & TABLE_STATUS.REBUILD_ALL)!=0) || ((status & TABLE_STATUS.REBUILD_FULL)!=0) hTable.Alter(ALTER_FULL); else if (status) hTable.Alter(ALTER_NORMAL);

Returns:

Current TABLE_STATUS value.

See Also:

• Alter(int)
• AddIndex(java.lang.String, int, boolean, boolean)
• AddField(java.lang.String, int, int)

GetOwner

public String GetOwner()

Retrieves the current table owner. If the table owner was not previously set by SetOwner(java.lang.String), GetOwner returns an empty string.

Returns:

Table owner or empty string if no table owner is set.

See Also:

• Alter(int)
• GetPermission()
• GetGroupid()

SetOwner

public void SetOwner(String owner)
              throws CTException

Sets the table owner. You should set the table owner before the table is created to allow the proper c-tree security setting to table place.

Parameters:

owner - New table owner. If owner is an empty string the table owner will be cleared.

Throws:

CTException - in case of error

See Also:

• Alter(int)
• GetPermission()
• GetGroupid()

Rebuild

public void Rebuild(int Mode)
             throws CTException

Builds data and index files. You must open the table before Rebuild() is executed. If the table is corrupt, open the table with CTOPEN_CORRUPT mode and then call Rebuild() to rebuild the data and index files. If there are missing index files, open the table with CTOPEN_DATAONLY mode and Rebuild() will reconstruct the missing index files.

The following steps are performed during the table rebuild process:

1. If a transaction is active, and the table being rebuild was created with CTCREATE_TRNLOG or CTCREATE_PREIMG, the transaction is committed before the table is rebuilt, and the transaction is restarted after the table rebuild process is terminated.

2. The update corrupt flag 'updflg' of the header of the data file is cleared.

3. The internal delete stack chain of fixed-length data files or the internal delete management index of variable length data files are rebuilt.

4. The existing index files are removed and new index files are rebuilt over the existing files, optimized for both size and speed.

Parameters:

Mode - REBUILD_MODE to be used in this execution.

Throws:

CTException - in case of error

See Also:

• Create(java.lang.String, int)
• Open(java.lang.String, int)

Compact

public void Compact()
             throws CTException

Builds data and index files. You must open the table before Compact() is executed.

Throws:

CTException - in case of error

See Also:

• Rebuild(int)

Attach

public void Attach(int datno)
            throws CTException

Attaches a c-tree Plus ISAM datno object to a CTTable object. This method is useful if you have opened a data and index file using one of c-tree's ISAM open functions and need to attach it to a CTTable object to use some of the advanced c-treeDB C++ features such as alter table or the CTRecord object.

Parameters:

datno - New data file number.

Throws:

CTException - in case of error

See Also:

• Detach()
• GetDatno()

Detach

public void Detach()
            throws CTException

Detaches a c-treeDB table object from c-tree data and index files. The c-tree ISAM or low-level data and index file is not closed but the c-treeDB table object resources are released and the object re-initialized.

Throws:

CTException - in case of error

See Also:

• Attach(int)
• GetDatno()

MoveSegment

public void MoveSegment(CTIndex hIndex,
 int segNumber,
 int newIndex)
                 throws CTException

Moves a segment to another position.

Parameters:

hIndex - CTIndex object representing whose segment is being moved.

segNumber - Current segment number.

newIndex - New segment number.

Throws:

CTException - in case of error

See Also:

• MoveSegment(java.lang.String, int, int)
• MoveSegment(int, int, int)
• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)

MoveSegment

public void MoveSegment(int indexNumber,
 int segNumber,
 int newIndex)
                 throws CTException

Moves a segment to another position.

Parameters:

indexNumber - Index number whose segment is being moved.

segNumber - Current segment number.

newIndex - New segment number.

Throws:

CTException - in case of error

See Also:

• MoveSegment(FairCom.CtreeDb.CTIndex, int, int)
• MoveSegment(java.lang.String, int, int)
• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)

MoveSegment

public void MoveSegment(String indexName,
 int segNumber,
 int newIndex)
                 throws CTException

Moves a segment to another position.

Parameters:

indexName - Index name whose segment is being moved.

segNumber - Current segment number.

newIndex - New segment number.

Throws:

CTException - in case of error

See Also:

• MoveSegment(FairCom.CtreeDb.CTIndex, int, int)
• MoveSegment(int, int, int)
• AddSegment(FairCom.CtreeDb.CTIndex, FairCom.CtreeDb.CTField, int)
• DelSegment(int, int)

PartAdminByName

public int PartAdminByName(String PartName,
 int PartMode)
                    throws CTException

Performs a partition operation on the partition specified by name.

Parameters:

PartName - Partition name.

PartMode - CTPART_MODE_E indicating the operation to be performed.

Returns:

If CTPART_MODE_E.STATUS is passed returns the partition status otherwhise 0 (CTDBRET.OK).

Throws:

CTException - in case of error

See Also:

• PartAdminByNumber(int, int)

PartAdminByNumber

public int PartAdminByNumber(int Prawno,
 int PartMode)
                      throws CTException

Performs a partition operation on the partition specified by raw partition number.

Parameters:

Prawno - Raw number of the partition.

PartMode - CTPART_MODE_E indicating the operation to be performed.

Returns:

If CTPART_MODE_E.STATUS is passed returns the partition status otherwise 0 (CTDBRET.OK).

Throws:

CTException - in case of error

See Also:

• PartAdminByName(java.lang.String, int)

SetIdentityField

public void SetIdentityField(String FieldName,
 long Seed,
 long Increment)
                      throws CTException

Sets the identity field.

Parameters:

FieldName - Field name to be changed to identity.

Seed - Identity seed value.

Increment - Identity increment value.

Throws:

CTException - in case of error

See Also:

• GetLastIdentity()
• GetIdentityField()
• GetIdentityFieldIncrement()
• GetIdentityFieldSeed()

NumberOfKeyEntries

public long NumberOfKeyEntries(int index)
                        throws CTException

Retrieves the number of key entries in a index file.

Parameters:

index - Index number to be checked. The first index number is zero.

Returns:

Number of index entries.

Throws:

CTException - in case of error

See Also:

• NumberOfKeyEntries(java.lang.String)
• GetIndex(int)

NumberOfKeyEntries

public long NumberOfKeyEntries(String indexName)
                        throws CTException

Retrieves the number of key entries in an index file.

Parameters:

indexName - Index name to be checked. The first index number is zero.

Returns:

Number of index entries.

Throws:

CTException - in case of error

See Also:

• NumberOfKeyEntries(int)
• GetIndex(int)

GetIdentityField

public String GetIdentityField()

Retrieves the name of the Identity field.

Returns:

Identity field name or null. If null, use ctdb.GetError() to determine if there was an error or simply there was no identity field defined.

See Also:

• GetLastIdentity()
• SetIdentityField(java.lang.String, long, long)
• GetIdentityFieldIncrement()
• GetIdentityFieldSeed()

GetIdentityFieldSeed

public long GetIdentityFieldSeed()
                          throws CTException

Retrieves the seed value of the Identity field.

Returns:

Identity field seed.

Throws:

CTException - in case of error

See Also:

• GetLastIdentity()
• SetIdentityField(java.lang.String, long, long)
• GetIdentityFieldIncrement()
• GetIdentityField()

GetIdentityFieldIncrement

public long GetIdentityFieldIncrement()
                               throws CTException

Retrieves the increment value of the Identity field.

Returns:

Identity field increment.

Throws:

CTException - in case of error

See Also:

• GetLastIdentity()
• SetIdentityField(java.lang.String, long, long)
• GetIdentityFieldSeed()
• GetIdentityField()

GetLastIdentity

public long GetLastIdentity()
                     throws CTException

Retrieves the next identity value.

Returns:

Last identity value.

Throws:

CTException - in case of error

See Also:

• GetIdentityFieldIncrement()
• SetIdentityField(java.lang.String, long, long)
• GetIdentityFieldSeed()
• GetIdentityField()

GetBinaryFlag

public int GetBinaryFlag(int FieldNumber)
                  throws CTException

Retrieves the field BINARY_FLAG. The field binary flag indicates how c-treeDB will handle CT_ARRAY, CT_F2STRING and CT_2STRING fields.

Parameters:

FieldNumber - Field number to be checked.

Returns:

Current BINARY_FLAG value.

Throws:

CTException - in case of error

See Also:

• GetBinaryFlag(java.lang.String)
• SetBinaryFlag(int, int)

GetBinaryFlag

public int GetBinaryFlag(String FieldName)
                  throws CTException

Retrieves the field BINARY_FLAG. The field binary flag indicate how c-treeDB will handle CT_ARRAY, CT_F2STRING and CT_2STRING fields.

Parameters:

FieldName - Field name to be checked.

Returns:

Current BINARY_FLAG value

Throws:

CTException - in case of error

See Also:

• GetBinaryFlag(java.lang.String)
• SetBinaryFlag(int, int)

SetBinaryFlag

public void SetBinaryFlag(int FieldNumber,
 int Flag)
                   throws CTException

Sets the field BINARY_FLAG. The field binary flag indicates how c-treeDB will handle CT_ARRAY, CT_F2STRING and CT_2STRING fields.

Parameters:

FieldNumber - Field number to be modified.

Flag - New BINARY_FLAG value.

Throws:

CTException - in case of error

See Also:

• SetBinaryFlag(java.lang.String, int)
• GetBinaryFlag(int)

SetBinaryFlag

public void SetBinaryFlag(String FieldName,
 int Flag)
                   throws CTException

Sets the field BINARY_FLAG. The field binary flag indicates how c-treeDB will handle CT_ARRAY, CT_F2STRING and CT_2STRING fields.

Parameters:

FieldName - Field name to be modified.

Flag - New BINARY_FLAG value.

Throws:

CTException - in case of error

See Also:

• SetBinaryFlag(java.lang.String, int)
• GetBinaryFlag(int)

Clone

public void Clone(CTTable target,
 String targetName)
           throws CTException

Creates a new table based on the current one.

Parameters:

target - Target CTTable object.

targetName - Target table name without file extension.

Throws:

CTException - in case of error

See Also:

• Create(java.lang.String, int)

CreateResultSet

public CTResultSet CreateResultSet(String Name)
                            throws CTException

Creates a CTResultSet object for the current table.

Parameters:

Name - Result Set name to be created.

Returns:

New CTResultSet object.

Throws:

CTException - in case of error

See Also:

• GetResultSetByName(java.lang.String)

CreateMRTTable

public void CreateMRTTable(String Name,
 String ParentName,
 int CreateMode,
 String Filter)
                    throws CTException

Creates a new MRTTable based on a host table..

Parameters:

Name - The table name

ParentName - The host table name

CreateMode - The create mode for the table

Filter - The filter to apply to the host table to identify the record belonging to this MRTTable

Throws:

CTException - in case of error

GetResultSetByName

public CTResultSet GetResultSetByName(String Name)
                               throws CTException

Retrieves the CTResultSet for the current table by its name.

Parameters:

Name - Result Set name to be retrieved.

Returns:

Found CTResultSet object.

Throws:

CTException - in case of error

See Also:

• CreateResultSet(java.lang.String)

AddFullTextIndex

public CTFullTextIndex AddFullTextIndex(String name)
                                 throws CTException

Add a new index to the table

Parameters:

name - full text index name

Returns:

a new CTFullTextIndex object representing the new full text index

Throws:

CTException - in case of error

See Also:

• DelFullTextIndex(java.lang.String)
• DelFullTextIndex(int)

DelFullTextIndex

public void DelFullTextIndex(int indexNumber)
                      throws CTException

Delete a Full Text index from a table

Parameters:

indexNumber - the number of the index to delete

Throws:

CTException - in case of error

See Also:

• AddField(java.lang.String, int, int)

DelFullTextIndex

public void DelFullTextIndex(String indexName)
                      throws CTException

Delete a full text index from a table

Parameters:

indexName - the name of the index to delete

Throws:

CTException - in case of error

See Also:

• AddFullTextIndex(java.lang.String)

GetFullTextIndex

public CTFullTextIndex GetFullTextIndex(int indexNumber)
                                 throws CTException

Retrieve a Full Text index object

Parameters:

indexNumber - the number of the FTI to retrieve

Returns:

a CTFullTextIndex object representing the passed full text index

Throws:

CTException - in case of error

See Also:

• GetFullTextIndex(java.lang.String)
• *

GetFullTextIndex

public CTFullTextIndex GetFullTextIndex(String name)
                                 throws CTException

Retrieve the Full Text index given its name

Parameters:

name - The name of the FTI to retrieve

Returns:

a CTFullTextIndex object representing the passed full text index

Throws:

CTException - in case of error

See Also:

• AddFullTextIndex(java.lang.String)
• GetFullTextIndex(int)

GetFullTextIndexCount

public int GetFullTextIndexCount()

Retrieve the number of full text indices of this table

Returns:

The number of full text index in the current table

See Also:

• AddFullTextIndex(java.lang.String)

SetFullTextIndexOption

public void SetFullTextIndexOption(CTFullTextIndex pIndex,
 int option,
 String svalue,
 int ivalue)
                            throws CTException

Set Full Text index options

Parameters:

pIndex - Full Text index object

option - option to set. Use 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

See Also:

• CTFullTextIndex.SetOption(int, java.lang.String, int)
• FTI_OPTION
• FTI_OPTION_TOKENIZER
• FTI_OPTION_UPDATE

SetFullTextIndexOption

public void SetFullTextIndexOption(int indexNbr,
 int option,
 String svalue,
 int ivalue)
                            throws CTException

Set Full Text index options

Parameters:

indexNbr - Full Text index number

option - option to set. Use 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

See Also:

• CTFullTextIndex.SetOption(int, java.lang.String, int)
• FTI_OPTION
• FTI_OPTION_TOKENIZER
• FTI_OPTION_UPDATE

SetFullTextIndexOption

public void SetFullTextIndexOption(String indexName,
 int option,
 String svalue,
 int ivalue)
                            throws CTException

Set Full Text index options

Parameters:

indexName - Full Text index name

option - option to set. Use 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

See Also:

• CTFullTextIndex.SetOption(int, java.lang.String, int)
• FTI_OPTION
• FTI_OPTION_TOKENIZER
• FTI_OPTION_UPDATE

GetPartitionIndexNbr

public int GetPartitionIndexNbr()

Retrieve the number of the partition index

Returns:

The partition index number. -1 in case is there is not partition number

HasLocks

public boolean HasLocks()

Check if there is any lock acquired on the table in the current session.

Returns:

true if locks are present, false otherwise.

See Also:

• CTBase.Lock(int)
• CTBase.Unlock()
• UnlockTable()