DbiResultNonAgg.cxx

Go to the documentation of this file.

// $Id: DbiResultNonAgg.cxx,v 1.25 2006/08/08 10:51:32 west Exp $

#include "DatabaseInterface/DbiBinaryFile.h"
#include "DatabaseInterface/DbiResultKey.h"
#include "DatabaseInterface/DbiResultNonAgg.h"
#include "DatabaseInterface/DbiResultSet.h"
#include "DatabaseInterface/DbiTableRow.h"
#include "DatabaseInterface/DbiTimerManager.h"
#include "LeakChecker/Lea.h"
#include "MessageService/MsgService.h"

ClassImp(DbiResultNonAgg)

//   Definition of static data members
//   *********************************

CVSID("$Id: DbiResultNonAgg.cxx,v 1.25 2006/08/08 10:51:32 west Exp $");


//    Definition of all member functions (static or otherwise)
//    *******************************************************
//
//    -  ordered: ctors, dtor, operators then in alphabetical order.


//.....................................................................

DbiResultNonAgg::DbiResultNonAgg(DbiResultSet* resultSet,
                                 const DbiTableRow* tableRow,
                                 const DbiValidityRec* vrec,
                                 Bool_t dropSeqNo,
                                 const string& sqlQualifiers) :
DbiResult(resultSet,vrec,sqlQualifiers),
fBuffer(0)
{
//
//
//  Purpose:  Default constructor
//
//  Arguments: 
//      resultSet    in/out Pointer DbiResultSet from query. May be null.  
//      tableRow     in     Pointer to a sample tableRow object. 
//                          May be null.
//      vrec         in     Pointer to validity record from query. 
//                          May be null
//      dropSeqNo    in     If = kTRUE, drop SeqNo if it is the first col.
//      sqlQualifier in     Extended Context sql qualifiers
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create Result from DbiResultSet generated by query.  If first
//    column is named SeqNo then strip it off before filling each 
//    DbiTableRow and quit as soon as the SeqNo changes. 
//     

//  Program Notes:-
//  =============

//  o tableRow is just used to create new subclass DbiTableRow objects.
//
//  o  The special treatment for tables that start with SeqNo allow   
//     a single DbiResultSet to fill multiple DbiResult objects but does
//     require that the result set is ordered by SeqNo.
//
//  The look-up table is not built by default, its construction is
//  triggered by use (GetTableRowByIndex).  For DbiResultNonAgg
//  that are part of a DbiResultAgg there is no need to build the
//  table.



  LEA_CTOR    //Leak Checker
  this->DebugCtor();

  if ( ! resultSet || resultSet->IsExhausted() || ! tableRow ) return;

  if ( vrec ) DbiTimerManager::gTimerManager.RecFillAgg(vrec->GetAggregateNo());

//Move to first row if result set not yet started.
  DbiResultSet& rs = *resultSet;
  if ( rs.IsBeforeFirst() ) rs.FetchRow();
  if ( rs.IsExhausted() ) return;
    
//Check and load sequence number if necessary.
  Int_t seqNo = 0;
  if ( dropSeqNo && rs.CurColName() == "SEQNO" ) {
    rs >> seqNo;
    rs.DecrementCurCol();
  }

// Check for ROW_COUNTER (which has to be ignored when reading).
  bool hasRowCounter = rs.HasRowCounter();

// Create and fill table row object and move result set onto next row.

  while ( ! rs.IsExhausted() ) {

//  If stripping off sequence numbers check the next and quit,
//  having restored the last, if it changes.
    if ( seqNo != 0 ) {
      Int_t nextSeqNo;
      rs >> nextSeqNo;
      if ( nextSeqNo != seqNo ) {
        rs.DecrementCurCol();
        break;
      }
    }

// Strip off ROW_COUNTER if present.
    if ( hasRowCounter ) rs.IncrementCurCol();
    DbiTableRow* row = tableRow->CreateTableRow();
    if ( vrec) DbiTimerManager::gTimerManager.StartSubWatch(3);
    row->SetOwner(this);
    row->Fill(rs,vrec);
    if ( vrec) DbiTimerManager::gTimerManager.StartSubWatch(2);
    fRows.push_back(row);
    rs.FetchRow();
    if ( vrec) DbiTimerManager::gTimerManager.StartSubWatch(1);
  }

  //Flag that data was read from Database.
  this->SetResultsFromDb();
  if ( seqNo  == 0 ) 
        MSG("Dbi",Msg::kSynopsis) << "Created unaggregated VLD result set no. of rows: " 
                                               << this->GetNumRows() << endl;
  else  MSG("Dbi",Msg::kSynopsis) << "Created unaggregated result set for SeqNo: " << seqNo
                                  << " no. of rows: " << this->GetNumRows() << endl;

}


//.....................................................................

DbiResultNonAgg::~DbiResultNonAgg() {
//
//
//  Purpose: Destructor
//
//  Arguments: 
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Destroy ResultNonAgg and all its owned DbiTableRow subclass 
//     objects.


//  Program Notes:-
//  =============

//  If fRows restored from BinaryFile then it doesn't own its
//  DbiTableRows.

  LEA_DTOR    //Leak Checker

  MSG("Dbi", Msg::kVerbose) << "Destroying DbiResultNonAgg."  << endl;

  if ( ! fBuffer ) for ( vector<DbiTableRow*>::iterator itr = fRows.begin();
        itr != fRows.end();
        ++itr) delete *itr;
  else {
    delete [] fBuffer;
    fBuffer = 0;
  }
}
//.....................................................................

DbiResultKey* DbiResultNonAgg::CreateKey() const {
//
//
//  Purpose:  Create a key that corresponds to this result.

  
  string rowName("empty_table");
  const DbiTableRow* row = this->GetTableRow(0);
  if ( row ) rowName = row->GetName();
  const DbiValidityRec& vrec = this->GetValidityRec();
  return new DbiResultKey(this->TableName(),
                          rowName,
                          vrec.GetSeqNo(),
                          vrec.GetCreationDate() );

}

//.....................................................................

void DbiResultNonAgg::DebugCtor() const {

  MSG("Dbi", Msg::kVerbose) << "Creating DbiResultNonAgg" << (void*) this << endl;
  static const DbiResultNonAgg* that = 0;
  if ( this == that ) {
    cout << "debug " << (void*) this << endl;
  }
}
//.....................................................................

const DbiTableRow* DbiResultNonAgg::GetTableRow(UInt_t rowNum) const {
//
//
//  Purpose:  Return TableRow from last query.
//
//  Arguments: 
//    rowNum      in    Required row number (0..NumRows-1)
//
//  Return:    TableRow ptr, or =0 if no row.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Return TableRow from last query, or =0 if no row.

//  Program Notes:-
//  =============

//  None.

  if ( rowNum >= fRows.size() ) return 0;
  return fRows[rowNum];
}

//.....................................................................

const DbiTableRow* DbiResultNonAgg::GetTableRowByIndex(UInt_t index) const {
//
//
//  Purpose: Return TableRow with supplied index, or =0 if no row. 
//
//  Arguments: 
//    index        in    Required index.
//
//  Return:    TableRow with required index, or =0 if no row.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o If look-up table not yet built, build it.
//
//  o Return TableRow with supplied index, or =0 if no row. 

 
  if ( ! this->LookUpBuilt() ) this->BuildLookUpTable();

// The real look-up still takes place in the base class.
  return this->DbiResult::GetTableRowByIndex(index);

}
//.....................................................................

Bool_t DbiResultNonAgg::Owns(const DbiTableRow* row ) const {
//
//
//  Purpose:  Return true if owns row.
//

//  Program Notes:-
//  =============

//  Only DbiResultNonAggs own rows; the base class DbiResult supplies
//  the default method that returns false.

 vector<DbiTableRow*>::const_iterator itr    = fRows.begin();
 vector<DbiTableRow*>::const_iterator itrEnd = fRows.end();

 for (; itr != itrEnd; ++itr) if ( *itr == row ) return kTRUE;

 return kFALSE;


}

//.....................................................................

Bool_t DbiResultNonAgg::Satisfies(const DbiValidityRec& vrec,
                                  const string& sqlQualifiers) {
//
//
//  Purpose: Check to see if this Result matches the supplied  DbiValidityRec.

  MSG("Dbi",Msg::kDebug) 
    << "Trying to satisfy: Vrec " << vrec << " SQL: " << sqlQualifiers
    << "\n with CanReuse: " << this->CanReuse() 
    << " vrec: " << this->GetValidityRec()
    << " sqlQualifiers: " << this->GetSqlQualifiers() 
    << endl;

  if ( this->CanReuse() ) {
    const DbiValidityRec& this_vrec = this->GetValidityRec();
    if (    sqlQualifiers           == this->GetSqlQualifiers()
         && vrec.GetSeqNo()         == this_vrec.GetSeqNo()
         && vrec.GetCreationDate()  == this_vrec.GetCreationDate() 
       )  return kTRUE;
  }

  return kFALSE;

}

//.....................................................................

void DbiResultNonAgg::Streamer(DbiBinaryFile& file) {
//
//
//  Purpose:  I/O to binary file
//
//  Program Notes:-
//  =============

//  Do I/O for base class DbiResult first.  Rebuild fIndexKeys on input.

  if ( file.IsReading() ) {
    this->DbiResult::Streamer(file);
    MSG("Dbi", Msg::kDebug) << "    Restoring DbiResultNonAgg ..." << endl; 
    file >> fRows;
//  Take ownership of the memory holding the array.
    fBuffer = file.ReleaseArrayBuffer();
    this->BuildLookUpTable();
    MSG("Dbi", Msg::kDebug) << "    Restored DbiResultNonAgg. Size:" 
                            << fRows.size() << " rows" << endl;
  }
  else if ( file.IsWriting() ) {
    this->DbiResult::Streamer(file);
    MSG("Dbi", Msg::kDebug) << "    Saving DbiResultNonAgg. Size:" 
                            << fRows.size() << " rows" << endl;
    file << fRows;
  }
}

/*    Template for New Member Function

//.....................................................................

DbiResultNonAgg:: {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  None.


}

*/

---