FairDbSqlValPacket.h

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file FairDbSqlValPacket.h

#ifndef FAIRDBSQLVALPACKET
#define FAIRDBSQLVALPACKET


#include <fstream>
#include <list>
#include <vector>
#include <string>
using std::string;

#if !defined(__CINT__) || defined(__MAKECINT__)
#include "Rtypes.h"
#endif

#include "ValTimeStamp.h"

class FairDbTableRow;
class FairDbValidityRec;
class VldRange;

class FairDbSqlValPacket
{

  public:

// Types and enum

    typedef enum ECompResult {
      kIdentical,
      kUpdate,
      kOutOfDate,
      kConflict
    } CompResult_t;

// Constructors and destructors.
    FairDbSqlValPacket();
    FairDbSqlValPacket(std::ifstream& is);
    FairDbSqlValPacket(const FairDbValidityRec& vrec);
    virtual ~FairDbSqlValPacket();

// State testing member functions
    Bool_t CanBeStored() const {
      return (fSeqNo > 0 && fNumErrors == 0 && this->GetNumSqlStmts()> 0)
             ? kTRUE : kFALSE;
    };
    CompResult_t Compare(const FairDbSqlValPacket& that,
                         Bool_t log = kFALSE,
                         const Char_t* thisName = "this",
                         const Char_t* thatName = "that" ) const;
    Bool_t CreateTable(UInt_t dbNo) const;
    UInt_t GetNumErrors() const { return fNumErrors; }
    UInt_t GetNumSqlStmts() const { return fNumStmts; }
    UInt_t GetSeqNo() const { return fSeqNo; }
    ValTimeStamp GetCreationDate() const { return fCreationDate; }
    string GetStmt(UInt_t stmtNo) const;
    std::vector<string> GetStmtValues(UInt_t stmtNo) const;
    const string& GetTableName() const { return fTableName; }
    Bool_t IsEqual(const FairDbSqlValPacket& that,
                   Bool_t log = kFALSE,
                   const Char_t* thisName = "this",
                   const Char_t* thatName = "that" ) const;

//  I/O
    Bool_t Fill(std::ifstream& is);
    Bool_t Store(UInt_t dbNo, Bool_t replace = kFALSE) const;
    Bool_t Write(std::ofstream& ios,
                 Bool_t addMetadata = kFALSE) const;

//  Reconstruct.
    void Recreate(const string& tableName,
                  const ValRange& vr,
                  Int_t aggNo,
                  FairDb::Task task = 0,
                  ValTimeStamp creationDate = ValTimeStamp());
    Bool_t AddDataRow(const FairDbTableProxy& tblProxy,
                      const FairDbValidityRec* vrec,
                      const FairDbTableRow& row);

//  State changing member functions
    void Clear() { this->Reset(); fNumErrors = 0; }
    void SetCreationDate(ValTimeStamp ts);
    void SetSeqNo(UInt_t seqno);
    void Reset();  //Doesn't clear fNumErrors.

    virtual void Print(Option_t* option="") const;

  protected:

  private:
    void AddRow(const string& row);
    Bool_t AddRow(const FairDbTableProxy& tblProxy,
                  const FairDbValidityRec* vrec,
                  const FairDbTableRow& row);
    void Report(const char* msg,
                UInt_t line_num,
                const string& line);
    void SetMetaData() const;
    void SetSeqNoOnRow(string& row,const string& seqno);

    static Bool_t fgLastMetaHadRowCounter;  // Ugly hack during transition to ROW_COUNTER tables.
    FairDbSqlValPacket(const FairDbSqlValPacket& );  // Not allowed.


// Data members

    UInt_t fNumErrors;

    UInt_t fSeqNo;

    mutable string fSqlMySqlMetaMain;

    mutable string fSqlMySqlMetaVal;

    std::list<string>  fSqlStmts;

    UInt_t fNumStmts;

    string fTableName;

    ValTimeStamp fCreationDate;

    ClassDef(FairDbSqlValPacket,0)           // SQL to generate Validity Packet.

};
#endif  // FAIRDBSQLVALPACKET