FairCom.CtreeDb

Class CTIndex

java.lang.Object

FairCom.CtreeDb.CTBase

FairCom.CtreeDb.CTIndex

public class CTIndex
extends CTBase

Deals with the index concept. The index is part of the table, and represent one field, or parts of one field, or parts of several fields. One single index may be composed of several segments.

See Also:

CTTable, CTRecord, CTSegment, CTField

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

m_handle

Constructor Summary

Constructors

Constructor and Description
CTIndex() Default constructor for the CTIndex class.
CTIndex(CTIndex Index) Copy constructor for the CTIndex class.

Method Summary

Methods

Modifier and Type	Method and Description
CTSegment	AddJSONSegment(CTField Field, java.lang.String Key, int Type, int Size) Adds a new JSON segment to index
CTSegment	AddSegment(CTField Field, int SegMode) Adds a new segment to index
CTSegment	AddSegment(int offset, int length, int SegMode) Adds a new segment to index
void	DelSegment(int SegmentNumber) Deletes a index segment
void	finalize() Destroys an allocated CTIndex object This method should be called in order to avoid memory leaks.
boolean	GetDuplicateFlag() Retrieves the "allow duplicated" flag for this index
char	GetEmptyChar() Retrieves the current "empty char" value
java.lang.String	GetFilename() Retrieves the index file name
int	GetIdxno() Retrieves the index file number
int	GetKeyLength() Retrieves the key length of the current index
int	GetKeyType() Retrieves the key type of the current index
java.lang.String	GetName() Retrieves the index name
boolean	GetNullFlag() Retrieves the null flag
int	GetNumber() Retrieves index position in table indices list
CTSegment	GetSegment(int SegmentNumber) Retrieves the index segment by its position number
int	GetSegmentCount() Retrieves the segment count.
int	GetStatus() Retrieves the status of the index handle.
boolean	GetTemporaryFlag() Retrives the temporary index flag
long	GetUID() Retrieves the unique index identification from the database
CTSegment	InsertSegment(int BeforeSegment, CTField Field, int SegMode) Inserts a new index segment before the segment number.
CTSegment	InsertSegment(int BeforeSegment, int offset, int length, int SegMode) Inserts a new index segment before the segment number.
void	MoveSegment(int SegmentNumber, int NewIndex) Moves a key segment to a location indicated by newIndex.
void	SetCndxExpression(java.lang.String Expression) Sets the conditional expression for the current index
void	SetDuplicateFlag(boolean DupFlag) Sets the "allow duplicate key" flag for the current index
void	SetEmptyChar(char EmptyChar) Sets the index "empty char" property for the current index
void	SetFilename(java.lang.String Path, java.lang.String Name) Sets the index path and filename.
void	SetKeyType(int keytype) Sets the Index KEY_TYPE
void	SetName(java.lang.String IndexName) Sets the index name, before the table is created.
void	SetNullFlag(boolean NullFlag) Sets the "allow null key" flag for the current index
void	SetTemporaryFlag(boolean TempFlag) Sets the temporary flag for the current index

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

CTIndex

public CTIndex()

Default constructor for the CTIndex class.

See Also:

CTIndex(CTIndex), finalize()

CTIndex

public CTIndex(CTIndex Index)

Copy constructor for the CTIndex class.

Parameters:

Index - CTIndex object to be copied

See Also:

CTIndex(), finalize()

Method Detail

finalize

public void finalize()

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

CTIndex(FairCom.CtreeDb.CTIndex)

GetKeyLength

public int GetKeyLength()

Retrieves the key length of the current index

Returns:

Key length

See Also:

GetKeyType(), GetSegmentCount()

GetKeyType

public int GetKeyType()
               throws CTException

Retrieves the key type of the current index

Returns:

Current KEY_TYPE value

Throws:

CTException - in case of error

See Also:

GetKeyLength(), GetSegmentCount()

GetEmptyChar

public char GetEmptyChar()

Retrieves the current "empty char" value

Returns:

Current empry char value

See Also:

SetEmptyChar(char), GetDuplicateFlag(), GetNullFlag(), GetTemporaryFlag()

GetDuplicateFlag

public boolean GetDuplicateFlag()

Retrieves the "allow duplicated" flag for this index

Returns:

true if index allows duplicate keys, otherwise false.

See Also:

SetDuplicateFlag(boolean), GetEmptyChar(), GetNullFlag(), GetTemporaryFlag()

GetNullFlag

public boolean GetNullFlag()

Retrieves the null flag

Returns:

true if the null flag is set, otherwise false.

See Also:

SetNullFlag(boolean), GetEmptyChar(), GetDuplicateFlag(), GetTemporaryFlag()

GetTemporaryFlag

public boolean GetTemporaryFlag()

Retrives the temporary index flag

Returns:

true if the index is temporary, otherwise false.

See Also:

SetTemporaryFlag(boolean), GetEmptyChar(), GetDuplicateFlag(), GetNullFlag()

SetEmptyChar

public void SetEmptyChar(char EmptyChar)
                  throws CTException

Sets the index "empty char" property for the current index

Parameters:

EmptyChar - New "empty character" to be set

Throws:

CTException - in case of error

See Also:

GetEmptyChar(), SetDuplicateFlag(boolean), SetTemporaryFlag(boolean), SetNullFlag(boolean)

SetDuplicateFlag

public void SetDuplicateFlag(boolean DupFlag)
                      throws CTException

Sets the "allow duplicate key" flag for the current index

Parameters:

DupFlag - true if the current index will allow duplicated, otherwise false

Throws:

CTException - in case of error

See Also:

GetDuplicateFlag(), SetEmptyChar(char), SetTemporaryFlag(boolean), SetNullFlag(boolean)

SetNullFlag

public void SetNullFlag(boolean NullFlag)
                 throws CTException

Sets the "allow null key" flag for the current index

Parameters:

NullFlag - true if the current index will allow null key, otherwise false

Throws:

CTException - in case of error

See Also:

GetNullFlag(), SetEmptyChar(char), SetTemporaryFlag(boolean), SetDuplicateFlag(boolean)

SetTemporaryFlag

public void SetTemporaryFlag(boolean TempFlag)
                      throws CTException

Sets the temporary flag for the current index

Parameters:

TempFlag - true if the current index is temporary, otherwise false

Throws:

CTException - in case of error

See Also:

GetTemporaryFlag(), SetEmptyChar(char), SetNullFlag(boolean), SetDuplicateFlag(boolean)

GetSegmentCount

public int GetSegmentCount()

Retrieves the segment count.

Returns:

Current index segment count

See Also:

GetKeyType(), GetKeyLength(), AddSegment(FairCom.CtreeDb.CTField, int), DelSegment(int), GetSegment(int)

AddSegment

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

Adds a new segment to index

Parameters:

Field - CTField object to be added as a key

SegMode - New SEG_MODE

Returns:

New CTSegment

Throws:

CTException - in case of error

See Also:

GetSegmentCount(), AddSegment(int, int, int), InsertSegment(int, FairCom.CtreeDb.CTField, int), DelSegment(int), GetSegment(int)

AddSegment

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

Adds a new segment to index

Parameters:

offset - Segment offset

length - Segment length in bytes

SegMode - New SEG_MODE

Returns:

New CTSegment

Throws:

CTException - in case of error

See Also:

GetSegmentCount(), AddSegment(CTField, int), InsertSegment(int, FairCom.CtreeDb.CTField, int), DelSegment(int), GetSegment(int)

AddJSONSegment

public CTSegment AddJSONSegment(CTField Field,
                       java.lang.String Key,
                       int Type,
                       int Size)
                         throws CTException

Adds a new JSON segment to index

Parameters:

Field - CTField object to be added as a key

Key - JSON key name that is being indexed

Type - c-tree data type of key value

Size - Key segment length

Returns:

New CTSegment

Throws:

CTException - in case of error

See Also:

GetSegmentCount(), AddSegment(int, int, int), InsertSegment(int, FairCom.CtreeDb.CTField, int), DelSegment(int), GetSegment(int)

InsertSegment

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

Inserts a new index segment before the segment number.

Parameters:

BeforeSegment - Insert the new segment before this index segment position

Field - CTField object to be added as a key

SegMode - New SEG_MODE

Returns:

New CTSegment

Throws:

CTException - in case of error

See Also:

GetSegmentCount(), AddSegment(FairCom.CtreeDb.CTField, int), DelSegment(int), GetSegment(int)

InsertSegment

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

Inserts a new index segment before the segment number.

Parameters:

BeforeSegment - Insert the new segment before this index segment position

offset - Segment offset

length - Segment length in bytes

SegMode - New SEG_MODE

Returns:

New CTSegment

Throws:

CTException - in case of error

See Also:

GetSegmentCount(), AddSegment(FairCom.CtreeDb.CTField, int), DelSegment(int), GetSegment(int)

DelSegment

public void DelSegment(int SegmentNumber)
                throws CTException

Deletes a index segment

Parameters:

SegmentNumber - Segment number to be deleted

Throws:

CTException - in case of error

See Also:

GetSegmentCount(), AddSegment(FairCom.CtreeDb.CTField, int), InsertSegment(int, FairCom.CtreeDb.CTField, int), GetSegment(int)

GetSegment

public CTSegment GetSegment(int SegmentNumber)
                     throws CTException

Retrieves the index segment by its position number

Parameters:

SegmentNumber - Segment number to be retrieved

Returns:

CTSegment object

Throws:

CTException - in case of error

See Also:

GetSegmentCount(), AddSegment(FairCom.CtreeDb.CTField, int), InsertSegment(int, FairCom.CtreeDb.CTField, int), DelSegment(int)

GetNumber

public int GetNumber()
              throws CTException

Retrieves index position in table indices list

Returns:

Index position in the CTTable owner

Throws:

CTException - in case of error

See Also:

GetIdxno(), GetName(), GetUID(), GetFilename()

GetName

public java.lang.String GetName()

Retrieves the index name

Returns:

Current index name

See Also:

SetName(java.lang.String), GetIdxno(), GetNumber(), GetUID(), GetFilename()

GetUID

public long GetUID()
            throws CTException

Retrieves the unique index identification from the database

Returns:

Current index UID (unique identification in the database)

Throws:

CTException - in case of error

See Also:

GetIdxno(), GetNumber(), GetName(), GetFilename()

SetName

public void SetName(java.lang.String IndexName)
             throws CTException

Sets the index name, before the table is created. Once the table is created, the index name can not be changed.

Parameters:

IndexName - New index name.

Throws:

CTException - in case of error

See Also:

GetName(), SetFilename(java.lang.String, java.lang.String), SetKeyType(int)

SetKeyType

public void SetKeyType(int keytype)
                throws CTException

Sets the Index KEY_TYPE

Parameters:

keytype - KEY_TYPE value

Throws:

CTException - in case of error

See Also:

GetKeyType(), SetFilename(java.lang.String, java.lang.String), SetName(java.lang.String)

SetFilename

public void SetFilename(java.lang.String Path,
               java.lang.String Name)
                 throws CTException

Sets the index path and filename.

Parameters:

Path - Specify the directory were the index file is located. If Null the directory is located in same directory of table.

Name - Specify the name of index file. If Null the index file will have the name of the table.

Throws:

CTException - in case of error

See Also:

GetFilename(), SetKeyType(int), SetName(java.lang.String)

GetFilename

public java.lang.String GetFilename()

Retrieves the index file name

Returns:

Index file name. If index file name is Null, the returned CTString object is cleared.

See Also:

SetFilename(java.lang.String, java.lang.String), GetKeyType(), GetName()

GetIdxno

public int GetIdxno()
             throws CTException

Retrieves the index file number

Returns:

Index file number

Throws:

CTException - in case of error

See Also:

GetNumber(), GetName(), GetUID(), GetFilename()

GetStatus

public int GetStatus()

Retrieves the status of the index handle. The status of the index handle is a bit map describing the INDEX_STATUS value

Returns:

Current INDEX_STATUS value

See Also:

GetNumber(), GetName(), GetUID(), GetFilename()

MoveSegment

public void MoveSegment(int SegmentNumber,
               int NewIndex)
                 throws CTException

Moves a key segment to a location indicated by newIndex.

Parameters:

SegmentNumber - Current segment number to be moved.

NewIndex - Index of the new location of the segment.

Throws:

CTException - in case of error

See Also:

GetSegmentCount(), AddSegment(FairCom.CtreeDb.CTField, int), DelSegment(int), GetSegment(int)

SetCndxExpression

public void SetCndxExpression(java.lang.String Expression)
                       throws CTException

Sets the conditional expression for the current index

Parameters:

Expression - Conditional expression string

Throws:

CTException - in case of error

See Also:

SetTemporaryFlag(boolean), SetName(java.lang.String), SetKeyType(int), SetFilename(java.lang.String, java.lang.String)