FairCom.CtreeDb

Class CTBase

java.lang.Object

FairCom.CtreeDb.CTBase

Direct Known Subclasses:

CTDatabase, CTField, CTFullTextIndex, CTFullTextIndexDictionary, CTIndex, CTRecord, CTResultSet, CTResultSetCriteria, CTSegment, CTSession, CTTable

public class CTBase
extends java.lang.Object

Basic class, upon which most of the other classes are built. In general, this class is not directly used. However, since most of the other classes are based on this, there are some important methods described in here that are applicable to most of the derived classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected FairCom.CtreeDb.CTHANDLE	m_handle Internal JTDB handle

Constructor Summary

Constructors

Constructor and Description
CTBase() Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	Abort() Aborts a transaction started with a call to Begin().
void	Begin() Begins a transaction using the current BEGIN_MODE value.
void	ClearSavePoint() Clears the last transaction save point.
void	Commit() Commits a transaction started with a call to Begin().
boolean	GetAutoCommit() Retrieves the auto commit flag.
FairCom.CtreeDb.CTHANDLE	GetHandle() Retrieves the internal JTDB handle.
int	GetKeepLock() Retrieves the current KEEPLOCK_MODE.
int	GetLockMode() Retrieves the current LOCK_MODE.
int	GetOperation() Retrieves the OPS_MODE for special performance-related functionality and tests operational states for critical events.
int	GetTransactionMode() Gets the current BEGIN_MODE.
boolean	IsLockActive() Checks if the locks are active.
boolean	IsTransActive() Indicates if a transaction has been started with a call to Begin(), but not terminated with a call to Commit() or Abort().
boolean	IsUnicodeLib() Retrieves c-treeDB UNICODE mode.
void	Lock(int mode) Enables or disables record locks.
void	PrepareCommit() Prepares a two-phase commit transaction to be committed.
void	RestoreSavePoint(int SavePoint) Restores a previously set save point.
void	SetAutoCommit(boolean flag) Sets the auto commit mode.
void	SetHandle(FairCom.CtreeDb.CTHANDLE Handle) Sets the internal JTDB handle.
void	SetKeepLock(int mode) Sets the KEEPLOCK_MODE applied when an active transaction is commited or aborted by calling Abort() or Commit().
void	SetOperation(int mode, int state) Sets the OPS_MODE for special performance-related functionality and tests operational states for critical events.
int	SetSavePoint() Sets a new transaction save point.
void	SetTransactionMode(int mode) Sets the BEGIN_MODE.
void	Unlock() Disables record locks.

Methods inherited from class java.lang.Object

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

Field Detail

m_handle

protected FairCom.CtreeDb.CTHANDLE m_handle

Internal JTDB handle

Constructor Detail

CTBase

public CTBase()

Default Constructor.

Method Detail

IsTransActive

public boolean IsTransActive()

Indicates if a transaction has been started with a call to Begin(), but not terminated with a call to Commit() or Abort().

Returns:

true if there is a pending transaction, otherwise returns false.

See Also:

Begin(), Commit(), Abort()

Begin

public void Begin()
           throws CTException

Begins a transaction using the current BEGIN_MODE value.

Throws:

CTException - in case of error

See Also:

IsLockActive(), Commit(), Abort(), PrepareCommit(), SetTransactionMode(int)

Commit

public void Commit()
            throws CTException

Commits a transaction started with a call to Begin().

Throws:

CTException - in case of error

See Also:

IsLockActive(), Commit(), Abort(), PrepareCommit(), SetTransactionMode(int)

Abort

public void Abort()
           throws CTException

Aborts a transaction started with a call to Begin().

Throws:

CTException - in case of error

See Also:

IsLockActive(), Commit(), Abort(), PrepareCommit(), SetTransactionMode(int)

PrepareCommit

public void PrepareCommit()
                   throws CTException

Prepares a two-phase commit transaction to be committed.

Throws:

CTException - in case of error

See Also:

IsLockActive(), Begin(), Commit(), Abort(), SetTransactionMode(int)

SetSavePoint

public int SetSavePoint()
                 throws CTException

Sets a new transaction save point.

Returns:

Integer with the save point number.

Throws:

CTException - in case of error

See Also:

Begin(), Commit(), Abort(), RestoreSavePoint(int)

RestoreSavePoint

public void RestoreSavePoint(int SavePoint)
                      throws CTException

Restores a previously set save point.

Parameters:

SavePoint - Previously saved save point number.

Throws:

CTException - in case of error

See Also:

Begin(), Commit(), Abort(), SetSavePoint()

ClearSavePoint

public void ClearSavePoint()
                    throws CTException

Clears the last transaction save point.

Throws:

CTException - in case of error

See Also:

Begin(), Commit(), Abort(), SetSavePoint()

GetHandle

public FairCom.CtreeDb.CTHANDLE GetHandle()

Retrieves the internal JTDB handle.

Returns:

Internal JTDB handle.

See Also:

SetHandle(FairCom.CtreeDb.CTHANDLE)

SetHandle

public void SetHandle(FairCom.CtreeDb.CTHANDLE Handle)

Sets the internal JTDB handle.

Parameters:

Handle - internal JTDB handle.

See Also:

GetHandle()

GetAutoCommit

public boolean GetAutoCommit()

Retrieves the auto commit flag. The auto commit of transactions are invoked automatically when records are added or updated by CTRecord.Write() method.

Returns:

true if auto commit is enabled, otherwise returns false.

See Also:

SetAutoCommit(boolean)

IsLockActive

public boolean IsLockActive()

Checks if the locks are active. Locks are active if the current lock mode is not CTLOCK_FREE or CTLOCK_SUSPEND. Please check LOCK_MODE for the other modes.

Returns:

true if locks are active, otherwise returns false.

See Also:

Lock(int), GetLockMode(), Unlock()

GetLockMode

public int GetLockMode()

Retrieves the current LOCK_MODE.

Returns:

Current lock mode. If LOCK_MODE_FREE is returned, it indicates that no locks are currently active.

See Also:

Lock(int), Unlock(), IsLockActive()

Lock

public void Lock(int mode)
          throws CTException

Enables or disables record locks.

Parameters:

mode - One of the c-tree plus lock modes LOCK_MODE.

Throws:

CTException - in case of error

See Also:

GetLockMode(), Unlock()

Unlock

public void Unlock()
            throws CTException

Disables record locks.

Throws:

CTException - in case of error

See Also:

Lock(int), GetLockMode()

GetKeepLock

public int GetKeepLock()

Retrieves the current KEEPLOCK_MODE.

Returns:

Current keep lock mode.

See Also:

Lock(int), GetLockMode(), SetKeepLock(int)

SetKeepLock

public void SetKeepLock(int mode)
                 throws CTException

Sets the KEEPLOCK_MODE applied when an active transaction is commited or aborted by calling Abort() or Commit().

Parameters:

mode - New KEEPLOCK_MODE value.

Throws:

CTException - in case of error

See Also:

Lock(int), GetLockMode(), GetKeepLock()

SetTransactionMode

public void SetTransactionMode(int mode)
                        throws CTException

Sets the BEGIN_MODE. If the transaction mode is CTBEGIN_NONE, the ctTRNLOG mode is used to start a new transaction.

Parameters:

mode - New BEGIN_MODE value.

Throws:

CTException - in case of error

See Also:

Begin(), Commit(), Abort(), GetTransactionMode()

GetTransactionMode

public int GetTransactionMode()

Gets the current BEGIN_MODE.

Returns:

Current BEGIN_MODE value.

See Also:

SetTransactionMode(int), Begin(), Commit(), Abort()

SetAutoCommit

public void SetAutoCommit(boolean flag)
                   throws CTException

Sets the auto commit mode. The auto commit of a transaction is invoked automatically when records are added or updated by CTRecord.Write(). Automatic transactions may increase performance by reducing network traffic for single record updates since this is equivalent of performing the following class:

hRecord.Begin() try { hRecord.Write(); hRecord.Commit(); } catch (CTException) { hRecord.Abort(); }

The following applies when an automatic transaction is performed:

1. An automatic transaction will only free locks acquired by the CTRecord.Write() method.

2. If an automatic transaction is aborted because of errors detected by ctdbWriteRecord, all locks acquired by CTRecord.Write() are released.

3. If locks are active, by calling Lock() method, an automatic transaction will not release any locks when it commits or aborts the write operation.

4. If OPS_UNLOCK_UPD is on, both commits and aborts on automatic transactions release only locks obtained within the transaction and/or locks on records updated within the transaction, regardless of whether the c-treeDB session lock state is active or not.

Parameters:

flag - New auto commit mode: true for enabled and false for disabled.

Throws:

CTException - in case of error

See Also:

GetAutoCommit(), Begin(), Commit(), Abort()

GetOperation

public int GetOperation()

Retrieves the OPS_MODE for special performance-related functionality and tests operational states for critical events.

Returns:

Current OPS_MODE value.

See Also:

SetOperation(int, int)

SetOperation

public void SetOperation(int mode,
                int state)
                  throws CTException

Sets the OPS_MODE for special performance-related functionality and tests operational states for critical events.

Parameters:

mode - new OPS_MODE value

state - new OPS_STATE value

Throws:

CTException - in case of error

See Also:

SetOperation(int, int)

IsUnicodeLib

public boolean IsUnicodeLib()

Retrieves c-treeDB UNICODE mode.

Returns:

true if UNICODE mode is enabled, otherwise return false.