TDbiResultSetNonAgg.cxx

Go to the documentation of this file.

// $Id: TDbiResultSetNonAgg.cxx,v 1.2 2011/06/08 09:49:18 finch Exp $

#include "TDbiBinaryFile.hxx"
#include "TDbiResultKey.hxx"
#include "TDbiResultSetNonAgg.hxx"
#include "TDbiInRowStream.hxx"
#include "TDbiTableRow.hxx"
#include "TDbiTimerManager.hxx"
#include <TSK_DBI_Log.hxx>
#include <MsgFormat.h>
using std::endl;

ClassImp(TDbiResultSetNonAgg)

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



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

//
//.....................................................................
///\verbatim
///  Purpose:  Default constructor
///
///  Arguments:
///      resultSet    in/out Pointer TDbiInRowStream 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 TDbiInRowStream generated by query.  If first
///    column is named SeqNo then strip it off before filling each
///    TDbiTableRow and quit as soon as the SeqNo changes.
///
///
///  Program Notes:-
///  =============
///
///  o tableRow is just used to create new subclass TDbiTableRow objects.
///
///  o  The special treatment for tables that start with SeqNo allow
///     a single TDbiInRowStream to fill multiple TDbiResultSet 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 TDbiResultSetNonAgg
///  that are part of a TDbiResultSetAgg there is no need to build the
///  table.
///\endverbatim

TDbiResultSetNonAgg::TDbiResultSetNonAgg(TDbiInRowStream* resultSet,
                                 const TDbiTableRow* tableRow,
                                 const TDbiValidityRec* vrec,
                                 Bool_t dropSeqNo,
                                 const string& sqlQualifiers) :
TDbiResultSet(resultSet,vrec,sqlQualifiers),
fBuffer(0)
{

  this->DebugCtor();

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

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

//Move to first row if result set not yet started.
  TDbiInRowStream& 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();
  }

// Main (non-VLD) tables have a ROW_COUNTER (which has to be ignored when reading).
  bool hasRowCounter = ! rs.IsVLDTable();

// 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();
    TDbiTableRow* row = tableRow->CreateTableRow();
    if ( vrec) TDbiTimerManager::gTimerManager.StartSubWatch(3);
    row->SetOwner(this);
    row->Fill(rs,vrec);
    if ( vrec) TDbiTimerManager::gTimerManager.StartSubWatch(2);
    fRows.push_back(row);
    rs.FetchRow();
    if ( vrec) TDbiTimerManager::gTimerManager.StartSubWatch(1);
  }

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

}


//.....................................................................
//
///\verbatim
///  Purpose: Destructor
///
///  Arguments:
///    None.
///
///  Return:    n/a
///
///  Contact:   N. West
///
///  Specification:-
///  =============
///
///  o  Destroy ResultNonAgg and all its owned TDbiTableRow subclass
///     objects.
///
///
///  Program Notes:-
///  =============
///
///  If fRows restored from BinaryFile then it doesn't own its
///  TDbiTableRows.
///\endverbatim
TDbiResultSetNonAgg::~TDbiResultSetNonAgg() {


  SK_DBI_Trace( "Destroying TDbiResultSetNonAgg."  << "  ");

  if ( ! fBuffer ) for ( vector<TDbiTableRow*>::iterator itr = fRows.begin();
        itr != fRows.end();
        ++itr) delete *itr;
  else {
    delete [] fBuffer;
    fBuffer = 0;
  }
}
//.....................................................................
///  Purpose:  Create a key that corresponds to this result.
TDbiResultKey* TDbiResultSetNonAgg::CreateKey() const {
//
//



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

}

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

void TDbiResultSetNonAgg::DebugCtor() const {

  SK_DBI_Trace( "Creating TDbiResultSetNonAgg" << (void*) this << "  ");
  static const TDbiResultSetNonAgg* that = 0;
  if ( this == that ) {
    cout << "debug " << (void*) this << endl;
  }
}
//.....................................................................
///\verbatim
///
///  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.
///\endverbatim
const TDbiTableRow* TDbiResultSetNonAgg::GetTableRow(UInt_t rowNum) const {

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

//  None.

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

//.....................................................................
///\verbatim
///
///  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.
///\endverbatim
const TDbiTableRow* TDbiResultSetNonAgg::GetTableRowByIndex(UInt_t index) const {


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

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

}
//.....................................................................
//
///\verbatim
///  Purpose:  Return true if owns row.
///
///
///  Program Notes:-
///  =============
///
///  Only TDbiResultSetNonAggs own rows; the base class TDbiResultSet supplies
///  the default method that returns false.
///\endverbatim
Bool_t TDbiResultSetNonAgg::Owns(const TDbiTableRow* row ) const {

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

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

 return kFALSE;


}

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


  SK_DBI_Debug(  "Trying to satisfy: Vrec " << vrec << " SQL: " << sqlQualifiers
    << "\n with CanReuse: " << this->CanReuse()
    << " vrec: " << this->GetValidityRec()
    << " sqlQualifiers: " << this->GetSqlQualifiers()
    << "  ");

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

  return kFALSE;

}

//.....................................................................
///\verbatim
///
///  Purpose:  I/O to binary file
///
///  Program Notes:-
///  =============
///  Do I/O for base class TDbiResultSet first.  Rebuild fIndexKeys on input.
///\endverbatim
void TDbiResultSetNonAgg::Streamer(TDbiBinaryFile& file) {

  if ( file.IsReading() ) {
    this->TDbiResultSet::Streamer(file);
    SK_DBI_Debug( "    Restoring TDbiResultSetNonAgg ..." << "  ");
    file >> fRows;
//  Take ownership of the memory holding the array.
    fBuffer = file.ReleaseArrayBuffer();
    this->BuildLookUpTable();
    SK_DBI_Debug( "    Restored TDbiResultSetNonAgg. Size:"
                            << fRows.size() << " rows" << "  ");
  }
  else if ( file.IsWriting() ) {
    this->TDbiResultSet::Streamer(file);
    SK_DBI_Debug( "    Saving TDbiResultSetNonAgg. Size:"
                            << fRows.size() << " rows" << "  ");
    file << fRows;
  }
}

/*    Template for New Member Function

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

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

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

//  None.


}

*/