DbiResult.h

Go to the documentation of this file.

#ifndef DBIRESULT_H
#define DBIRESULT_H

#include <map>
#include <string>
using std::string;

#include "DatabaseInterface/Dbi.h"
#include "DatabaseInterface/DbiExceptionLog.h"
#include "DatabaseInterface/DbiValidityRec.h"

typedef std::map<UInt_t,const DbiTableRow*> IndexToRow_t;

class DbiBinaryFile;
class DbiResultKey;
class DbiResult;
class DbiResultSet;
class DbiTableRow;
class Context;

DbiBinaryFile& operator<<(DbiBinaryFile& bf, const DbiResult& res);    
DbiBinaryFile& operator>>(DbiBinaryFile& bf, DbiResult& res);    

class DbiResult
{

public:

// Constructors and destructors.
           DbiResult(DbiResultSet* resultSet = 0, 
                     const DbiValidityRec* vrec = 0,
                     const string& sqlQualifiers = "");
  virtual ~DbiResult();

// State testing member functions
 
 virtual                Bool_t CanReuse() const  { return fCanReuse; }
 virtual                Bool_t CanSave() const  { return kTRUE; }
 virtual                  void Connect() const { ++fNumClients; }
 virtual         DbiResultKey* CreateKey() const = 0;
 virtual                  void Disconnect() const { --fNumClients; } 
        const DbiExceptionLog& GetExceptionLog() const { return fExceptionLog; }
                         Int_t GetID() const { return fID; }
 virtual   const DbiResultKey* GetKey() const;
 virtual                UInt_t GetNumAggregates() const =0;
 virtual                UInt_t GetNumClients() const { 
                                                   return fNumClients; }
 virtual                UInt_t GetNumRows() const =0;
                 const string& GetSqlQualifiers() const { return fSqlQualifiers; }
 virtual    const DbiTableRow* GetTableRow(UInt_t rowNum) const =0;
 virtual    const DbiTableRow* GetTableRowByIndex(UInt_t index) const;
 virtual const DbiValidityRec& GetValidityRec(
                                  const DbiTableRow* /* row */ = 0) const { 
                                        return GetValidityRecGlobal(); }
 virtual const DbiValidityRec& GetValidityRecGlobal() const { 
                                                      return fEffVRec; }
                        Bool_t IsExtendedContext() const { 
                                       return this->GetSqlQualifiers() != ""; }
 virtual                Bool_t Owns(const DbiTableRow* /* row */) const { return kFALSE; }
                        Bool_t ResultsFromDb() const { return fResultsFromDb; }
 virtual         const string& TableName() const { return fTableName; }

// State changing member functions
                          void CaptureExceptionLog(UInt_t startFrom);

 virtual                Bool_t CanDelete(const DbiResult* res = 0);

 virtual    Bool_t Satisfies(const Context& vc,
                             const Dbi::SubSite& subsite,
                             const Dbi::Task& task);
virtual     Bool_t Satisfies(const string&) {return kFALSE;}
virtual     Bool_t Satisfies(const DbiValidityRec&,
                             const string& = "") {return kFALSE;}

 virtual    void DeRegisterKey();
 virtual    void RegisterKey();

 virtual void Streamer(DbiBinaryFile& file);
 virtual void SetCanReuse(Bool_t reuse)  { fCanReuse = reuse ; }

protected:
         void SetResultsFromDb() { fResultsFromDb = kTRUE; }

// State testing member functions

         void BuildLookUpTable() const;
       Bool_t LookUpBuilt() const { return fIndexKeys.size() > 0; } 

//  State changing member functions.

 virtual void SetTableName(const string& tableName)  { 
                                               fTableName = tableName; }
 virtual void SetValidityRec(const DbiValidityRec& vRec)  { 
                                                      fEffVRec = vRec; }


private:  

// Data members

  Int_t fID;            

  Bool_t fCanReuse;      

  DbiValidityRec fEffVRec;       

  mutable IndexToRow_t fIndexKeys;     

  const DbiResultKey* fKey;     

  Bool_t fResultsFromDb;
  mutable Int_t fNumClients;    

  string fTableName;     

  string fSqlQualifiers;

  DbiExceptionLog fExceptionLog;  


  static  Int_t fgLastID;            


// Removed: ClassDef(DbiResult,0)     //Abstract base representing query result 

};


#endif  // DBIRESULT_H