FairCom.CtreeDb

Class CTDatabase

java.lang.Object

FairCom.CtreeDb.CTBase

FairCom.CtreeDb.CTDatabase

public class CTDatabase
extends CTBase

Deals with the Database concept. The Database can be thought as a collection of tables. Multiple databases can be connected at the same time, within the same session. The same database may open in different sessions. CTDatabase class is derived from the CTBase class.

See Also:

CTBase, CTSession, CTTable

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

m_handle

Constructor Summary

Constructors

Constructor and Description
CTDatabase(CTSession Handle) Constructor for a given Session handle.

Method Summary

Modifier and Type	Method and Description
void	AddTable(java.lang.String Name, java.lang.String Path) Adds an existing table to the current database.
void	AddTableXtd(java.lang.String Name, java.lang.String PhysicName, java.lang.String Path) Adds an existing table to the current database.
void	CloseAll() Closes all active tables for the current database.
void	Connect(java.lang.String Name) Connects to a database.
void	Create(java.lang.String Name, java.lang.String Path) Creates a new database.
void	DeleteTable(java.lang.String Name, java.lang.String Password) Drops a table from a database and deletes the table data and index files from disk.
void	Disconnect() Disconnects a database.
void	DropTable(java.lang.String Name) Drops a table from a database, but does not delete the table data and index files from disk.
void	finalize() Destroys an allocated CTDatabase object.
CTTable	FindActiveTable(java.lang.String TableName) Finds an active table by name in the current database.
boolean	FindTable(int uid, java.lang.StringBuffer Name, java.lang.StringBuffer Path) Locates a table in a database by name.
boolean	FindTable(java.lang.String Name, java.lang.StringBuffer Path) Locates a table in a database by name.
boolean	FirstTable(java.lang.StringBuffer Name, java.lang.StringBuffer Path) Locates the first table in a database.
java.lang.String	GetDefaultSqlTableOwner() Retrieves the current default SQL table owner.
java.lang.String	GetName() Retrieves the database name.
java.lang.String	GetPath() Retrieves the database path.
int	GetTableCount() Retrieves the number of tables in the database dictionary.
int	GetTableUID(java.lang.String Name) Retrieves the table UID.
boolean	IsActive() Checks whether the database is connected or disconnected.
boolean	IsExclusive() Retrieves the current database exclusive flag value.
boolean	IsSQL() Checks if the database is SQL (i.e., checks if the database contains the SQL system tables).
boolean	NextTable(java.lang.StringBuffer Name, java.lang.StringBuffer Path) Locates the next table in a database.
void	RenameTable(java.lang.String OldName, java.lang.String NewName) Assigns a new name to an existing table.
void	SetDefaultSqlTableOwner(java.lang.String Owner) Sets the default SQL table owner name.
void	SetExclusive(boolean Flag) Sets or clears the database exclusive flag.

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

CTDatabase

public CTDatabase(CTSession Handle)
           throws CTException

Constructor for a given Session handle.

Parameters:

Handle - CTSession object.

Throws:

CTException - in case of error

See Also:

finalize()

Method Detail

finalize

public void finalize()

Destroys an allocated CTDatabase object. This method should be called to avoid memory leaks. Release all resources associated with a database

Overrides:

finalize in class java.lang.Object

See Also:

CTDatabase(FairCom.CtreeDb.CTSession)

Connect

public void Connect(java.lang.String Name)
             throws CTException

Connects to a database.

Parameters:

Name - Database name to be connected.

Throws:

CTException - in case of error

See Also:

Disconnect()

Disconnect

public void Disconnect()
                throws CTException

Disconnects a database.

Throws:

CTException - in case of error

CTException - in case of error

See Also:

Connect(java.lang.String)

Create

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

Creates a new database.

Parameters:

Name - Name to assign to the database.

Path - Path where the database will be created.

Throws:

CTException - in case of error

See Also:

Connect(java.lang.String)

FirstTable

public boolean FirstTable(java.lang.StringBuffer Name,
                          java.lang.StringBuffer Path)
                   throws CTException

Locates the first table in a database.

Parameters:

Name - Table name (Output)

Path - Table path (Output)

Returns:

true if the table was found, otherwise return false.

Throws:

CTException - in case of error

See Also:

NextTable(java.lang.StringBuffer, java.lang.StringBuffer), FindTable(java.lang.String, java.lang.StringBuffer)

NextTable

public boolean NextTable(java.lang.StringBuffer Name,
                         java.lang.StringBuffer Path)
                  throws CTException

Locates the next table in a database.

Parameters:

Name - Table name (Output).

Path - Table path (Output).

Returns:

true if the table was found, otherwise return false.

Throws:

CTException - in case of error

See Also:

FirstTable(java.lang.StringBuffer, java.lang.StringBuffer), FindTable(java.lang.String, java.lang.StringBuffer)

FindTable

public boolean FindTable(java.lang.String Name,
                         java.lang.StringBuffer Path)
                  throws CTException

Locates a table in a database by name.

Parameters:

Name - Table name to be found.

Path - Table path (Output).

Returns:

true if the table was found, otherwise return false.

Throws:

CTException - in case of error

See Also:

FirstTable(java.lang.StringBuffer, java.lang.StringBuffer), NextTable(java.lang.StringBuffer, java.lang.StringBuffer), FindActiveTable(java.lang.String)

FindTable

public boolean FindTable(int uid,
                         java.lang.StringBuffer Name,
                         java.lang.StringBuffer Path)
                  throws CTException

Locates a table in a database by name.

Parameters:

uid - Table ID to be found. This is an internal unique table identification.

Name - Table name (Output)

Path - Table path (Output)

Returns:

true if the table was found, otherwise return false.

Throws:

CTException - in case of error

See Also:

FirstTable(java.lang.StringBuffer, java.lang.StringBuffer), NextTable(java.lang.StringBuffer, java.lang.StringBuffer), FindActiveTable(java.lang.String)

AddTable

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

Adds an existing table to the current database.

Parameters:

Name - Table name.

Path - Table path.

Throws:

CTException - in case of error

See Also:

AddTableXtd(java.lang.String, java.lang.String, java.lang.String), DeleteTable(java.lang.String, java.lang.String), DropTable(java.lang.String), RenameTable(java.lang.String, java.lang.String)

AddTableXtd

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

Adds an existing table to the current database.

Parameters:

Name - Table name used inside the database.

PhysicName - Physical table file name.

Path - Table path.

Throws:

CTException - in case of error

See Also:

AddTable(java.lang.String, java.lang.String), DeleteTable(java.lang.String, java.lang.String), DropTable(java.lang.String), RenameTable(java.lang.String, java.lang.String)

DeleteTable

public void DeleteTable(java.lang.String Name,
                        java.lang.String Password)
                 throws CTException

Drops a table from a database and deletes the table data and index files from disk.

Parameters:

Name - Table name to be deleted.

Password - Optional table password.

Throws:

CTException - in case of error

See Also:

AddTable(java.lang.String, java.lang.String), AddTableXtd(java.lang.String, java.lang.String, java.lang.String), DropTable(java.lang.String), RenameTable(java.lang.String, java.lang.String)

DropTable

public void DropTable(java.lang.String Name)
               throws CTException

Drops a table from a database, but does not delete the table data and index files from disk.

Parameters:

Name - Table name to be droped.

Throws:

CTException - in case of error

See Also:

AddTable(java.lang.String, java.lang.String), AddTableXtd(java.lang.String, java.lang.String, java.lang.String), DeleteTable(java.lang.String, java.lang.String), RenameTable(java.lang.String, java.lang.String)

GetTableUID

public int GetTableUID(java.lang.String Name)
                throws CTException

Retrieves the table UID.

Parameters:

Name - Table name.

Returns:

Table's unique identification for the current database.

Throws:

CTException - in case of error

See Also:

GetName(), GetPath()

IsActive

public boolean IsActive()

Checks whether the database is connected or disconnected.

Returns:

true if database is connected, or false if it is disconnected.

See Also:

Connect(java.lang.String), Disconnect()

GetPath

public java.lang.String GetPath()

Retrieves the database path.

Returns:

Current database path.

See Also:

GetName(), IsActive()

GetName

public java.lang.String GetName()

Retrieves the database name.

Returns:

Current database name.

See Also:

GetPath(), IsActive()

CloseAll

public void CloseAll()
              throws CTException

Closes all active tables for the current database.

Throws:

CTException - in case of error

See Also:

GetTableUID(java.lang.String)

GetTableCount

public int GetTableCount()

Retrieves the number of tables in the database dictionary.

Returns:

Number of tables in database dictionary.

See Also:

FirstTable(java.lang.StringBuffer, java.lang.StringBuffer), NextTable(java.lang.StringBuffer, java.lang.StringBuffer), AddTable(java.lang.String, java.lang.String), DeleteTable(java.lang.String, java.lang.String), DropTable(java.lang.String)

GetDefaultSqlTableOwner

public java.lang.String GetDefaultSqlTableOwner()

Retrieves the current default SQL table owner.

Returns:

Default SQL table owner name.

See Also:

SetDefaultSqlTableOwner(java.lang.String), IsSQL()

SetDefaultSqlTableOwner

public void SetDefaultSqlTableOwner(java.lang.String Owner)
                             throws CTException

Sets the default SQL table owner name.

Parameters:

Owner - New default SQL table owner name.

Throws:

CTException - in case of error

See Also:

GetDefaultSqlTableOwner(), IsSQL()

IsSQL

public boolean IsSQL()

Checks if the database is SQL (i.e., checks if the database contains the SQL system tables).

Returns:

Returns true if the database is SQL, or false if it is not

See Also:

GetDefaultSqlTableOwner(), SetDefaultSqlTableOwner(java.lang.String)

SetExclusive

public void SetExclusive(boolean Flag)
                  throws CTException

Sets or clears the database exclusive flag. If a database exclusive flag is set, only one connect will be allowed on this database. Set the database exclusive flag after allocating the database handle, but before performing a connect. Setting the database exclusive flag after a database connect is performed will not have any effect during the current connection.

Parameters:

Flag - True will set the exclusive flag, while false will clear the exclusive flag.

Throws:

CTException - in case of error

See Also:

IsExclusive(), Connect(java.lang.String)

IsExclusive

public boolean IsExclusive()

Retrieves the current database exclusive flag value.

Returns:

true if database is in Exclusive mode, or false if it is shared.

See Also:

IsExclusive(), SetExclusive(boolean)

RenameTable

public void RenameTable(java.lang.String OldName,
                        java.lang.String NewName)
                 throws CTException

Assigns a new name to an existing table.

Parameters:

OldName - Current table name.

NewName - New table name to be set.

Throws:

CTException - in case of error

See Also:

GetName(), AddTable(java.lang.String, java.lang.String), AddTableXtd(java.lang.String, java.lang.String, java.lang.String), DeleteTable(java.lang.String, java.lang.String), DropTable(java.lang.String)

FindActiveTable

public CTTable FindActiveTable(java.lang.String TableName)
                        throws CTException

Finds an active table by name in the current database.

Parameters:

TableName - Table name to be found.

Returns:

Active matching CTTable object.

Throws:

CTException - in case of error

See Also:

FirstTable(java.lang.StringBuffer, java.lang.StringBuffer), NextTable(java.lang.StringBuffer, java.lang.StringBuffer), FindTable(java.lang.String, java.lang.StringBuffer), IsActive()