In This Package:

DbiResult Class Reference

Id

DbiResult.h,v 1.22 2006/08/08 10:51:32 west Exp

More...

#include <DbiResult.h>

Inheritance diagram for DbiResult:

[legend]Collaboration diagram for DbiResult:[legend]List of all members.

Public Member Functions
	DbiResult (DbiResultSet *resultSet=0, const DbiValidityRec *vrec=0, const string &sqlQualifiers="")
virtual	~DbiResult ()
virtual Bool_t	CanReuse () const
virtual Bool_t	CanSave () const
virtual void	Connect () const
virtual DbiResultKey *	CreateKey () const =0
virtual void	Disconnect () const
const DbiExceptionLog &	GetExceptionLog () const
Int_t	GetID () const
virtual const DbiResultKey *	GetKey () const
virtual UInt_t	GetNumAggregates () const =0
virtual UInt_t	GetNumClients () const
virtual UInt_t	GetNumRows () const =0
const string &	GetSqlQualifiers () const
virtual const DbiTableRow *	GetTableRow (UInt_t rowNum) const =0
virtual const DbiTableRow *	GetTableRowByIndex (UInt_t index) const
virtual const DbiValidityRec &	GetValidityRec (const DbiTableRow *=0) const
virtual const DbiValidityRec &	GetValidityRecGlobal () const
Bool_t	IsExtendedContext () const
virtual Bool_t	Owns (const DbiTableRow *) const
Bool_t	ResultsFromDb () const
virtual const string &	TableName () const
void	CaptureExceptionLog (UInt_t startFrom)
virtual Bool_t	CanDelete (const DbiResult *res=0)
	Return true if no clients and unlikely to be reused.
virtual Bool_t	Satisfies (const Context &vc, const Dbi::SubSite &subsite, const Dbi::Task &task)
	All DbiResult classes can satisfy this type of primary query so impliment here.
virtual Bool_t	Satisfies (const string &)
	Not all DbiResult classes can satisfy these types of query so those that do must override.
virtual Bool_t	Satisfies (const DbiValidityRec &, const string &="")
virtual void	DeRegisterKey ()
	Key handling.
virtual void	RegisterKey ()
virtual void	Streamer (DbiBinaryFile &file)
virtual void	SetCanReuse (Bool_t reuse)
Protected Member Functions
void	SetResultsFromDb ()
void	BuildLookUpTable () const
Bool_t	LookUpBuilt () const
virtual void	SetTableName (const string &tableName)
virtual void	SetValidityRec (const DbiValidityRec &vRec)
Private Attributes
Int_t	fID
	Unique ID within the current job.
Bool_t	fCanReuse
DbiValidityRec	fEffVRec
IndexToRow_t	fIndexKeys
const DbiResultKey *	fKey
Bool_t	fResultsFromDb
	True is at least part didn't come from cache.
Int_t	fNumClients
string	fTableName
string	fSqlQualifiers
	Null unless Extended Context query in which case it contains:- context-sql;data-sql;fill-options.
DbiExceptionLog	fExceptionLog
	Exception log produced when query was executed.
Static Private Attributes
static Int_t	fgLastID
	Used to allocate unique ID within the current job.

---

Detailed Description

Id

DbiResult.h,v 1.22 2006/08/08 10:51:32 west Exp

Definition at line 48 of file DbiResult.h.

---

Constructor & Destructor Documentation

DbiResult::DbiResult	(	DbiResultSet *	resultSet = 0,
		const DbiValidityRec *	vrec = 0,
		const string &	sqlQualifiers = ""
	)

virtual DbiResult::~DbiResult

(

)

[virtual]

---

Member Function Documentation

virtual Bool_t DbiResult::CanReuse

(

)

const [inline, virtual]

Definition at line 61 of file DbiResult.h.

{ return fCanReuse; }

virtual Bool_t DbiResult::CanSave

(

)

const [inline, virtual]

Definition at line 62 of file DbiResult.h.

{ return kTRUE; }

virtual void DbiResult::Connect

(

)

const [inline, virtual]

Definition at line 63 of file DbiResult.h.

{ ++fNumClients; }

virtual DbiResultKey* DbiResult::CreateKey

(

)

const [pure virtual]

Implemented in DbiResultAgg, and DbiResultNonAgg.

virtual void DbiResult::Disconnect

(

)

const [inline, virtual]

Definition at line 65 of file DbiResult.h.

{ --fNumClients; } 

const DbiExceptionLog& DbiResult::GetExceptionLog

(

)

const [inline]

Definition at line 66 of file DbiResult.h.

{ return fExceptionLog; }

Int_t DbiResult::GetID

(

)

const [inline]

Definition at line 67 of file DbiResult.h.

{ return fID; }

virtual const DbiResultKey* DbiResult::GetKey

(

)

const [virtual]

virtual UInt_t DbiResult::GetNumAggregates

(

)

const [pure virtual]

Implemented in DbiResultAgg, and DbiResultNonAgg.

virtual UInt_t DbiResult::GetNumClients

(

)

const [inline, virtual]

Definition at line 70 of file DbiResult.h.

                                                     { 
                                                   return fNumClients; }

virtual UInt_t DbiResult::GetNumRows

(

)

const [pure virtual]

Implemented in DbiResultAgg, and DbiResultNonAgg.

const string& DbiResult::GetSqlQualifiers

(

)

const [inline]

Definition at line 73 of file DbiResult.h.

{ return fSqlQualifiers; }

virtual const DbiTableRow* DbiResult::GetTableRow

(

UInt_t

rowNum

)

const [pure virtual]

Implemented in DbiResultAgg, and DbiResultNonAgg.

virtual const DbiTableRow* DbiResult::GetTableRowByIndex

(

UInt_t

index

)

const [virtual]

Reimplemented in DbiResultNonAgg.

virtual const DbiValidityRec& DbiResult::GetValidityRec

(

const DbiTableRow *

= 0

)

const [inline, virtual]

Reimplemented in DbiResultAgg.

Definition at line 76 of file DbiResult.h.

                                                                          { 
                                        return GetValidityRecGlobal(); }

virtual const DbiValidityRec& DbiResult::GetValidityRecGlobal

(

)

const [inline, virtual]

Definition at line 79 of file DbiResult.h.

                                                            { 
                                                      return fEffVRec; }

Bool_t DbiResult::IsExtendedContext

(

)

const [inline]

Definition at line 81 of file DbiResult.h.

                                                         { 
                                       return this->GetSqlQualifiers() != ""; }

virtual Bool_t DbiResult::Owns

(

const DbiTableRow *

)

const [inline, virtual]

Reimplemented in DbiResultNonAgg.

Definition at line 83 of file DbiResult.h.

{ return kFALSE; }

Bool_t DbiResult::ResultsFromDb

(

)

const [inline]

Definition at line 84 of file DbiResult.h.

{ return fResultsFromDb; }

virtual const string& DbiResult::TableName

(

)

const [inline, virtual]

Definition at line 85 of file DbiResult.h.

{ return fTableName; }

void DbiResult::CaptureExceptionLog

(

UInt_t

startFrom

)

virtual Bool_t DbiResult::CanDelete

(

const DbiResult *

res = 0

)

[virtual]

Return true if no clients and unlikely to be reused.

virtual Bool_t DbiResult::Satisfies	(	const Context &	vc,
		const Dbi::SubSite &	subsite,
		const Dbi::Task &	task
	)			[virtual]

All DbiResult classes can satisfy this type of primary query so impliment here.

virtual Bool_t DbiResult::Satisfies

(

const string &

)

[inline, virtual]

Not all DbiResult classes can satisfy these types of query so those that do must override.

Reimplemented in DbiResultAgg.

Definition at line 100 of file DbiResult.h.

{return kFALSE;}

virtual Bool_t DbiResult::Satisfies	(	const DbiValidityRec &	,
		const string &	= ""
	)			[inline, virtual]

Reimplemented in DbiResultNonAgg.

Definition at line 101 of file DbiResult.h.

                                                 {return kFALSE;}

virtual void DbiResult::DeRegisterKey

(

)

[virtual]

Key handling.

virtual void DbiResult::RegisterKey

(

)

[virtual]

virtual void DbiResult::Streamer

(

DbiBinaryFile &

file

)

[virtual]

Reimplemented in DbiResultAgg, and DbiResultNonAgg.

virtual void DbiResult::SetCanReuse

(

Bool_t

reuse

)

[inline, virtual]

Definition at line 109 of file DbiResult.h.

{ fCanReuse = reuse ; }

void DbiResult::SetResultsFromDb

(

)

[inline, protected]

Definition at line 112 of file DbiResult.h.

{ fResultsFromDb = kTRUE; }

void DbiResult::BuildLookUpTable

(

)

const [protected]

Bool_t DbiResult::LookUpBuilt

(

)

const [inline, protected]

Definition at line 117 of file DbiResult.h.

{ return fIndexKeys.size() > 0; } 

virtual void DbiResult::SetTableName

(

const string &

tableName

)

[inline, protected, virtual]

Definition at line 121 of file DbiResult.h.

                                                     { 
                                               fTableName = tableName; }

virtual void DbiResult::SetValidityRec

(

const DbiValidityRec &

vRec

)

[inline, protected, virtual]

Definition at line 123 of file DbiResult.h.

                                                          { 
                                                      fEffVRec = vRec; }

---

Member Data Documentation

Int_t DbiResult::fID [private]

Unique ID within the current job.

Definition at line 132 of file DbiResult.h.

Bool_t DbiResult::fCanReuse [private]

Definition at line 135 of file DbiResult.h.

DbiValidityRec DbiResult::fEffVRec [private]

Definition at line 138 of file DbiResult.h.

IndexToRow_t DbiResult::fIndexKeys [mutable, private]

Definition at line 141 of file DbiResult.h.

const DbiResultKey* DbiResult::fKey [private]

Definition at line 144 of file DbiResult.h.

Bool_t DbiResult::fResultsFromDb [private]

True is at least part didn't come from cache.

Definition at line 147 of file DbiResult.h.

Int_t DbiResult::fNumClients [mutable, private]

Definition at line 149 of file DbiResult.h.

string DbiResult::fTableName [private]

Definition at line 152 of file DbiResult.h.

string DbiResult::fSqlQualifiers [private]

Null unless Extended Context query in which case it contains:- context-sql;data-sql;fill-options.

Definition at line 156 of file DbiResult.h.

DbiExceptionLog DbiResult::fExceptionLog [private]

Exception log produced when query was executed.

Definition at line 159 of file DbiResult.h.

Int_t DbiResult::fgLastID [static, private]

Used to allocate unique ID within the current job.

Definition at line 163 of file DbiResult.h.

---

The documentation for this class was generated from the following file:

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/Database/DatabaseInterface/DatabaseInterface/DbiResult.h

---