DbiResult.cxx

Go to the documentation of this file.

// $Id: DbiResult.cxx,v 1.24 2011/10/31 18:59:42 rhatcher Exp $

#include <sstream>

#include "DatabaseInterface/DbiBinaryFile.h"
#include "DatabaseInterface/DbiResultKey.h"
#include "DatabaseInterface/DbiRecord.h"
#include "DatabaseInterface/DbiResult.h"
#include "DatabaseInterface/DbiResultSet.h"
#include "DatabaseInterface/DbiServices.h"
#include "DatabaseInterface/DbiTableRow.h"
#include "LeakChecker/Lea.h"
#include "MessageService/MsgService.h"

ClassImp(DbiResult)

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

 Int_t DbiResult::fgLastID(0);      

CVSID("$Id: DbiResult.cxx,v 1.24 2011/10/31 18:59:42 rhatcher Exp $");
//  Global functions
//  *****************

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

DbiBinaryFile& operator<<(DbiBinaryFile& bf, const DbiResult& res) {

// Writing is a const operation, but uses a non-const method, so cast away const.

  DbiResult& res_tmp = const_cast< DbiResult&>(res);
  res_tmp.Streamer(bf);
  return bf;
}

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

DbiBinaryFile& operator>>(DbiBinaryFile& bf, DbiResult& res) {

  res.Streamer(bf);
  return bf;
}

// Definition of member functions (alphabetical order)
// ***************************************************


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

DbiResult::DbiResult(DbiResultSet* resultSet,
                     const DbiValidityRec* vrec,
                     const string& sqlQualifiers) :
fID(++fgLastID),
fCanReuse(kTRUE),
fEffVRec(0),
fKey(0),
fResultsFromDb(kFALSE),
fNumClients(0),
fTableName("Unknown"),
fSqlQualifiers(sqlQualifiers)
{
//
//
//  Purpose:  Default constructor
//
//  Arguments: 
//      resultSet     in   Pointer DbiResultSet from query. May be null.  
//      vrec          in   Pointer to validity record from query. 
//                         May be null
//      sqlQualifier  in   Extended Context sql qualifiers
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create Result from DbiResultSet generated by query.


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

// None.

  LEA_CTOR    //Leak Checker

  MSG("Dbi", Msg::kVerbose) << "Creating DbiResult" << endl;

  if ( vrec ) fEffVRec = *vrec;
  if ( resultSet ) fTableName = resultSet->TableNameTc();
 
}

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

DbiResult::~DbiResult() {
//
//
//  Purpose: Destructor
//
//  Arguments: 
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Destroy Result.


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

//  None.

  LEA_DTOR    //Leak Checker

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

  if ( fNumClients ) {
    MSG("Dbi", Msg::kWarning) 
      << "Warning: Destroying DbiResult with " << fNumClients 
      << " clients " << endl;
  }

  this->DeRegisterKey();

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

void DbiResult::BuildLookUpTable() const {
//
//
//  Purpose:  Build look-up Natural Index -> TableRow.
//
//  Contact:   N. West
//
//  Program Notes:-
//  =============
//
//  This member function assumes that the sub-class can support
//  the GetTableRow(...) and GetNumRows methods so take care if 
//  called in the sub-class ctor.

//  Extended Context serach can produce duplicates.
  Bool_t duplicatesOK = this->IsExtendedContext();

  MSG("Dbi", Msg::kVerbose) << "Building look-uptable. Allow duplicates: " 
                            << duplicatesOK << endl;

  for ( Int_t rowNo = this->GetNumRows()-1; 
        rowNo >= 0;
        --rowNo ) {
    const DbiTableRow* row  = this->GetTableRow(rowNo);
    UInt_t index            = row->GetIndex(rowNo);
//  Ensure we use this class's GetTableRowByIndex, the method is
//  virtual but if the subclass has called this method then it must
//  be the right one to use. [Actually DbiResultAgg overrides
//  GetTableRowByIndex, but only to make building lazy].
    const DbiTableRow* row2 = this->DbiResult::GetTableRowByIndex(index);

    MSG("Dbi", Msg::kVerbose)
          << "Look-up. Row no " << rowNo
          << " index " << index 
          << " row,row2 " << (void*) row << "," << (void*) row2 << endl;
   
    if ( row2 != 0 && row2 != row && ! duplicatesOK ) {
      std::ostringstream msg;
      msg << "Duplicated row natural index: " << index  
          << " Found at row " <<  rowNo
          << " of table " <<  this->TableName()
          << ":-\n     index of agg " <<  row->GetAggregateNo();
      if ( row->GetOwner() ) msg << "(SEQNO " << row->GetOwner()->GetValidityRec(row).GetSeqNo() << ")";
      msg << " matches agg " <<  row2->GetAggregateNo();
      if ( row2->GetOwner() ) msg << "(SEQNO " << row2->GetOwner()->GetValidityRec(row2).GetSeqNo() << ")";
      MAXMSG("Dbi",Msg::kError,20) << msg.str() << endl;
   }

    else  fIndexKeys[index] = row;
  }  

}

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

Bool_t DbiResult::CanDelete(const DbiResult* res) {
//
//
//  Purpose:  See if suitable for deleting.
//
//  Arguments: 
//    res          in    A DbiResult that is currently used. 
//                       Optional: default = 0.

//  If the query would be satisfied apart from the date, then
//  assume we have moved out of the validity window, never
//  to return!

  if (     res 
        && this->CanReuse() 
        && this->GetValidityRec().HasExpired(res->GetValidityRec()) 
     )  this->SetCanReuse(kFALSE);

  return ! this->GetNumClients() && ! this->CanReuse();
}

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

void DbiResult::CaptureExceptionLog(UInt_t startFrom) {
//
//
//  Purpose: Capture Exception Log from latest entries in Global Exception Log. 

  fExceptionLog.Clear();
  DbiExceptionLog::GetGELog().Copy(fExceptionLog,startFrom);

}

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

void DbiResult::DeRegisterKey() {
//
//
//  Purpose: Deregister key if it exists. 

  if ( ! fKey ) return;

  DbiRecord* record = DbiServices::GetRecord();
  if ( ! record ) {
    MSG("Dbi",Msg::kWarning) << "Attempting to deregister DbiResultKey at " << (void*) fKey 
                             << " but owning DbiRecord cannot be found." << endl; 
  }
  else {
    record->DeleteKey(fKey);
    fKey = 0;
  }

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

const DbiResultKey* DbiResult::GetKey() const {

//  Purpose:  Get the associated DbiResultKey, or an empty one if none exists.

  return fKey ? fKey : DbiResultKey::GetEmptyKey();

}

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

const DbiTableRow* DbiResult::GetTableRowByIndex(UInt_t index) const {
//
//
//  Purpose:  Return row corresponding to Natural Index (or 0 if none)
//
//  Contact:   N. West
//

// Use Find rather than operator[] to avoid creating entry 
// if index missing
  IndexToRow_t::const_iterator idx = fIndexKeys.find(index);
  return ( idx == fIndexKeys.end() ) ? 0 : (*idx).second;

}

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

void DbiResult::RegisterKey() {
//
//
//  Purpose: Create and register key if set not empty and not already done. 

  if ( fKey || this->GetNumRows() == 0) return;

  DbiRecord* record = DbiServices::GetRecord();
  if ( ! record ) {
    MSG("Dbi",Msg::kWarning) << "cannot create and register key"
                             << ", owning DbiRecord cannot be found." << endl; 
  }
  else {
    DbiResultKey* key = this->CreateKey();
    record->AdoptKey(key);
    fKey = key;
  }

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

Bool_t DbiResult::Satisfies(const VldContext& vc,
                            const Dbi::Task& task) {
//
//
//  Purpose:  Check to see if this Result satisfies specific context query.
//
//  Arguments: 
//    vc           in    Context of query
//    task         in    Task of query
//
//  Return:    kTRUE if can satisfy query.
//
//  Contact:   N. West
//
//  Program Notes:-
//  =============

//  If it cannot satisfy the query in a way that suggests 
//  that its unlikely that it will satisfy future queries
//  then mark as cannot reuse so that it becomes eligible
//  for purging.

// Extended Context queries cannot satisfy specific context queries.

  Bool_t isExtendedContext = this->IsExtendedContext();
  Bool_t canReuse          = this->CanReuse();
  Bool_t isCompatible      = this->GetValidityRec().IsCompatible(vc,task);
  Bool_t hasExpired        = this->GetValidityRec().HasExpired(vc,task);
  UInt_t numClients        = this->GetNumClients();
  MSG("Dbi",Msg::kDebug) 
    << "    Checking result with DbiValidityRec:- \n      " << this->GetValidityRec()
    << "  With extended context: " << isExtendedContext
    << " CanReuse: " << canReuse
    << " Is Compatible: " << isCompatible
    << " HasExpired: " <<  hasExpired
    << " number of clients: " << numClients
    << endl;

  if ( isExtendedContext ) return kFALSE;

  if ( canReuse && isCompatible )  return kTRUE;
    
//  If the query would be satisfied apart from the date, then
//  assume we have moved out of the validity window, never
//  to return!

  if ( canReuse && hasExpired && numClients == 0 )  {
    MSG("Dbi",Msg::kDebug) << "    Marking result as not reusable" << endl;
   this-> SetCanReuse(kFALSE);
  }

  return kFALSE;

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

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

//  Don't store fIndexKeys; it will be rebuilt on input by the subclass.

  if ( file.IsReading() ) {
    MSG("Dbi", Msg::kDebug) << "    Restoring DbiResult ..." << endl;
    file >> fCanReuse;
    fEffVRec.Streamer(file);
    MSG("Dbi", Msg::kVerbose) << "    Restored " << fEffVRec << endl;
    fResultsFromDb = kFALSE;
    fNumClients    = 0;
    file >> fTableName;
    MSG("Dbi", Msg::kVerbose) << "    Restored string " << fTableName << endl;
  }
  else if ( file.IsWriting() ) {
    MSG("Dbi", Msg::kDebug) << "    Saving DbiResult ..." << endl;
    file << fCanReuse;
    MSG("Dbi", Msg::kVerbose) << "    Saving " << fEffVRec << endl;
    fEffVRec.Streamer(file);
    MSG("Dbi", Msg::kVerbose) << "    Saving string " << fTableName << endl;
    file << fTableName;
  }
}

/*    Template for New Member Function

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

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

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

//  None.


}

*/

---