FairCom.CtreeDb

Class CTSegment

java.lang.Object

FairCom.CtreeDb.CTBase

FairCom.CtreeDb.CTSegment

public class CTSegment
extends CTBase

Index segment management class. The segment is part of the index; one single index may be composed of several segments. It uses CTBase as the base class, and implements the constructor/destructor allocating/freeing memory to the segment operations.

See Also:

CTBase, CTIndex, CTField

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

m_handle

Constructor Summary

Constructors

Constructor and Description
CTSegment() Default constructor for CTSegment class
CTSegment(CTSegment Seg) Copy constructor for the CTSegment class.

Method Summary

Methods

Modifier and Type	Method and Description
void	finalize() Destroys an allocated CTSegment object
CTField	GetField() Retrieves the segment CTField object
java.lang.String	GetFieldName() Retrieves the segment field name
int	GetMode() Retrieves the SEG_MODE
int	GetNumber() Retrieves the segment index position in index segments list
CTField	GetPartialField() Retrieves the segment CTField object
java.lang.String	GetPartialFieldName() Retrieve the segment field name
int	GetStatus() Retrieves the SEGMENT_STATUS
void	MoveSegment(int newIndex) Moves a key segment to a location indicated by newIndex.
void	SetField(CTField field) Changes the underlying segment CTField
void	SetJSONField(CTField field, java.lang.String Key, int Type, int Size) Changes the underlying segment CTField
void	SetMode(int SegMode) Sets the SEG_MODE

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

CTSegment

public CTSegment()

Default constructor for CTSegment class

See Also:

CTSegment(FairCom.CtreeDb.CTSegment), finalize()

CTSegment

public CTSegment(CTSegment Seg)

Copy constructor for the CTSegment class.

Parameters:

Seg - CTSegment object to be copied

See Also:

CTSegment(), finalize()

Method Detail

finalize

public void finalize()

Destroys an allocated CTSegment object

Overrides:

finalize in class java.lang.Object

See Also:

CTSegment(FairCom.CtreeDb.CTSegment)

GetField

public CTField GetField()
                 throws CTException

Retrieves the segment CTField object

Returns:

CTField object representing the field used by the current segment

Throws:

CTException - in case of error

See Also:

GetPartialField(), GetFieldName(), GetMode(), GetNumber(), GetStatus()

GetPartialField

public CTField GetPartialField()
                        throws CTException

Retrieves the segment CTField object

Returns:

CTField object representing the field used by the current segment

Throws:

CTException - in case of error

See Also:

GetField(), GetFieldName(), GetMode(), GetNumber(), GetStatus()

GetFieldName

public java.lang.String GetFieldName()
                              throws CTException

Retrieves the segment field name

Returns:

Current field name

Throws:

CTException - in case of error

See Also:

GetField(), GetPartialFieldName(), GetMode(), GetNumber(), GetStatus()

GetPartialFieldName

public java.lang.String GetPartialFieldName()
                                     throws CTException

Retrieve the segment field name

Returns:

Current field name

Throws:

CTException - in case of error

See Also:

GetField(), GetPartialField(), GetMode(), GetNumber(), GetStatus()

GetMode

public int GetMode()
            throws CTException

Retrieves the SEG_MODE

Returns:

Current SEG_MODE value

Throws:

CTException - in case of error

See Also:

SetMode(int), GetField(), GetPartialField(), GetFieldName(), GetNumber(), GetStatus()

SetMode

public void SetMode(int SegMode)
             throws CTException

Sets the SEG_MODE

Parameters:

SegMode - New SEG_MODE value

Throws:

CTException - in case of error

See Also:

GetMode(), SetField(FairCom.CtreeDb.CTField)

GetNumber

public int GetNumber()
              throws CTException

Retrieves the segment index position in index segments list

Returns:

Current position in the index

Throws:

CTException - in case of error

See Also:

GetField(), GetPartialField(), GetFieldName(), GetMode(), GetStatus()

GetStatus

public int GetStatus()

Retrieves the SEGMENT_STATUS

Returns:

Current SEGMENT_STATUS value

See Also:

GetField(), GetPartialField(), GetFieldName(), GetMode(), GetNumber()

MoveSegment

public void MoveSegment(int newIndex)
                 throws CTException

Moves a key segment to a location indicated by newIndex.

Parameters:

newIndex - Index of the new location of the segment.

Throws:

CTException - in case of error

See Also:

GetNumber()

SetField

public void SetField(CTField field)
              throws CTException

Changes the underlying segment CTField

Parameters:

field - New CTField object

Throws:

CTException - in case of error

See Also:

GetField(), SetMode(int)

SetJSONField

public void SetJSONField(CTField field,
                java.lang.String Key,
                int Type,
                int Size)
                  throws CTException

Changes the underlying segment CTField

Parameters:

field - New CTField object

Key - JSON key name that is being indexed

Type - c-tree data type of key value

Size - Key segment length

Throws:

CTException - in case of error

See Also:

GetField(), SetMode(int)