KVDataBase Class Reference

Detailed Description

Simple cross-referenced database structure.

KVDataBase, along with KVDBKey, KVDBRecord and KVDBTable, are base classes for the implementation of simple cross-referenced database structures. The database is made up of tables with unique names, each table contains a list of records. Records in different tables may be linked together using keys, providing cross-referenced entries.

All these objects are ROOT TFolder objects. The KVDataBase object is added to the ROOT folder and may be browsed in the TBrowser.

           An example of use is given here:

KVDataBase my_db("my_db","Beatles' discography");
 
my_db.AddTable("Albums","All the albums made by The Beatles",kTRUE);
my_db.AddTable("Songs","All the songs written or recorded by The Beatles",kTRUE);
my_db.AddTable("Years","For chronological information",kTRUE);
 
my_db.GetTable("Years")->AddRecord(new KVDBRecord("1966","The Year 1966"));
my_db.GetTable("Years")->AddRecord(new KVDBRecord("1967","The Year 1967"));
my_db.GetTable("Years")->AddRecord(new KVDBRecord("1968","The Year 1968"));
 
my_db.GetTable("Songs")->AddRecord(new KVDBRecord("Taxman","1. Taxman"));
my_db.GetTable("Songs")->AddRecord(new KVDBRecord("Eleanor","2. Eleanor Rigby"));
my_db.GetTable("Songs")->AddRecord(new KVDBRecord("LSD","3. Lucy in the Sky with Diamonds"));
my_db.GetTable("Songs")->AddRecord(new KVDBRecord("Better","4. Getting Better"));
my_db.GetTable("Songs")->AddRecord(new KVDBRecord("USSR","1. Back In The USSR"));
my_db.GetTable("Songs")->AddRecord(new KVDBRecord("Prudence","2. Dear Prudence"));
 
my_db.GetTable("Albums")->AddRecord(new KVDBRecord("Revolver","Revolver"));
my_db.GetTable("Albums")->AddRecord(new KVDBRecord("Pepper","Sgt. Pepper's Lonely Hearts' Club Band"));
my_db.GetTable("Albums")->AddRecord(new KVDBRecord("White","The Beatles"));
 
my_db.GetTable("Albums")->GetRecord("Revolver")->AddKey("Songs","Songs on the album Revolver");
my_db.GetTable("Albums")->GetRecord("Pepper")->AddKey("Songs","Songs on the album Sgt. Pepper");
my_db.GetTable("Albums")->GetRecord("White")->AddKey("Songs","Songs on the album The Beatles");
my_db.GetTable("Albums")->GetRecord("Revolver")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("Taxman"));
my_db.GetTable("Albums")->GetRecord("Revolver")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("Eleanor"));
my_db.GetTable("Albums")->GetRecord("Pepper")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("LSD"));
my_db.GetTable("Albums")->GetRecord("Pepper")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("Better"));
my_db.GetTable("Albums")->GetRecord("White")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("USSR"));
my_db.GetTable("Albums")->GetRecord("White")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("Prudence"));
my_db.GetTable("Years")->GetRecord("1966")->AddKey("Songs","Songs from 1966");
my_db.GetTable("Years")->GetRecord("1967")->AddKey("Songs","Songs from 1967");
my_db.GetTable("Years")->GetRecord("1968")->AddKey("Songs","Songs from 1968");
my_db.GetTable("Years")->GetRecord("1966")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("Taxman"));
my_db.GetTable("Years")->GetRecord("1966")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("Eleanor"));
my_db.GetTable("Years")->GetRecord("1967")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("LSD"));
my_db.GetTable("Years")->GetRecord("1967")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("Better"));
my_db.GetTable("Years")->GetRecord("1968")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("USSR"));
my_db.GetTable("Years")->GetRecord("1968")->AddLink("Songs",my_db.GetTable("Songs")->GetRecord("Prudence"));
}

After setting up the database in this way, some typical output would be:

root [12] my_db.Print()
_______________________________________________________
my_db Beatles' discography
Available Tables :
  Albums
  Songs
  Years
_______________________________________________________
 
root [14] my_db.GetTable("Songs")->ls()
OBJ: KVDBRecord Taxman  1. Taxman : 0 at: 0x89b5910
OBJ: KVDBRecord Eleanor 2. Eleanor Rigby : 0 at: 0x89acb50
OBJ: KVDBRecord LSD     3. Lucy in the Sky with Diamonds : 0 at: 0x89b59f0
OBJ: KVDBRecord Better  4. Getting Better : 0 at: 0x89b5c08
OBJ: KVDBRecord USSR    1. Back In The USSR : 0 at: 0x89b5c40
OBJ: KVDBRecord Prudence        2. Dear Prudence : 0 at: 0x89b5cd8
 
root [15] my_db.GetTable("Albums")->GetRecord("White")->Print()
_______________________________________________________
White The Beatles
Available Keys :
  Songs
_______________________________________________________
 
root [16] my_db.GetTable("Songs")->GetRecord("LSD")->Print()
_______________________________________________________
LSD 3. Lucy in the Sky with Diamonds
Available Keys :
  Albums
  Years
_______________________________________________________
 
root [18] my_db.GetTable("Songs")->GetRecord("LSD")->GetKey("Albums")->ls()
OBJ: KVDBRecord Pepper  Sgt. Pepper's Lonely Hearts' Club Band : 0 at: 0x89b5b00
 
root [19] my_db.GetTable("Songs")->GetRecord("LSD")->GetKey("Years")->ls()
OBJ: KVDBRecord 1967    The Year 1967 : 0 at: 0x89b57a0

Definition at line 137 of file KVDataBase.h.

#include <KVDataBase.h>

Inheritance diagram for KVDataBase:

Public Member Functions
	KVDataBase ()
	KVDataBase (const Char_t *name)
	KVDataBase (const Char_t *name, const Char_t *title)
virtual	~ KVDataBase ()
virtual KVDBTable *	AddTable (const Char_t *name, const Char_t *title, Bool_t unique=kFALSE)
virtual Bool_t	AddTable (KVDBTable *table)
virtual KVDBRecord *	GetRecord (const Char_t *table_name, const Char_t *rec_name) const
virtual KVDBTable *	GetTable (const Char_t *table) const
virtual TList *	GetTables () const
virtual void	Print (Option_t *option="") const

Private Attributes
TString	fFolderName

Constructor & Destructor Documentation

KVDataBase() [1/3]

KVDataBase::KVDataBase

(

)

Definition at line 31 of file KVDataBase.cpp.

KVDataBase() [2/3]

KVDataBase::KVDataBase

(

const Char_t *

name

)

Definition at line 53 of file KVDataBase.cpp.

KVDataBase() [3/3]

KVDataBase::KVDataBase	(	const Char_t *	name,
		const Char_t *	title
	)

Definition at line 41 of file KVDataBase.cpp.

~ KVDataBase()

virtual KVDataBase::~ KVDataBase ( )

virtual

Member Function Documentation

AddTable() [1/2]

KVDBTable * KVDataBase::AddTable ( const Char_t *  name, const Char_t *  title, Bool_t  unique = kFALSE  )

virtual

Add a table to the list of tables and check if the new table's name already exists. If it exists the table is not added and null pointer is returned, otherwise a new table is created and added to the list and its address is returned. Table with this name already in DB ?

Definition at line 109 of file KVDataBase.cpp.

AddTable() [2/2]

Bool_t KVDataBase::AddTable ( KVDBTable *  tab )

virtual

Add a table to the list of available tables and return kTRUE it's added. As each table must have a unique name we check if the new table's name already exists, if not the table is added otherwise it's not added and the method return kFALSE.

table with this name already in DB ?

Definition at line 84 of file KVDataBase.cpp.

GetRecord()

KVDBRecord * KVDataBase::GetRecord ( const Char_t *  table_name, const Char_t *  rec_name  ) const

virtual

Return the KVDBRecord rec_name found in the table table_name

Definition at line 133 of file KVDataBase.cpp.

GetTable()

KVDBTable * KVDataBase::GetTable ( const Char_t *  table ) const

inlinevirtual

Definition at line 159 of file KVDataBase.h.

GetTables()

TList * KVDataBase::GetTables ( ) const

inlinevirtual

Definition at line 164 of file KVDataBase.h.

Print()

void KVDataBase::Print ( Option_t *  option = "" ) const

virtual

Definition at line 152 of file KVDataBase.cpp.

Member Data Documentation

fFolderName

TString KVDataBase::fFolderName

private

Definition at line 139 of file KVDataBase.h.