DbiValidityRec.cxx

Go to the documentation of this file.

// $Id: DbiValidityRec.cxx,v 1.19 2005/05/02 11:29:47 minoscvs Exp $
//
// DbiValidityRec
//
// Package: Dbi (Database Interface).

// Begin_Html<img src="../../pedestrians.gif" align=center>
// <a href="../source_warning.html">Warning for beginners</a>.<br>
// Also see <a href="../../root_crib/index.html">The ROOT Crib</a> and
// <a href="../index.html">The MINOS Class User Guide</a>End_Html
//
// N. West 03/20000
//
// Concept: A concrete data type corresponding to a single row in an
//          auxillary validity range database table.
//   
// Purpose: To resolve ambiguities in the case of multiple matches
//          to a query and to record results of validity range
//          trimming due to neighbouring database entries. 
//

#include "Conventions/DetectorType.h"
#include "Conventions/SimFlag.h"
#include "DatabaseInterface/DbiBinaryFile.h"
#include "DatabaseInterface/DbiResultSet.h"
#include "DatabaseInterface/DbiOutRowStream.h"
#include "DatabaseInterface/DbiValidityRec.h"
#include "MessageService/MsgService.h"
#include "LeakChecker/Lea.h"
#include "Validity/VldRange.h"
#include "Validity/VldTimeStamp.h"

#include "TString.h"

#include <sstream>
#include <iostream>

ClassImp(DbiValidityRec)


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

CVSID("$Id: DbiValidityRec.cxx,v 1.19 2005/05/02 11:29:47 minoscvs Exp $\n  \
      CVSID_DBIRESULTPTR ");

//  Instantiate associated Result Pointer class.
//  *******************************************

#include "DatabaseInterface/DbiResultPtr.tpl"
template class  DbiResultPtr<DbiValidityRec>;

//  Global functions
//  *****************

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

ostream& operator<<(ostream& os, const DbiValidityRec& vRec) {
//
//
//  Purpose:  Output validity record to ostream.
//
//  Arguments: 
//    os           in    output stream
//    vRec         in    Validity record to be output
//
//  Return:        updated ostream   
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Output validity record to ostream.

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

//  None.

  const VldRange&           range(vRec.GetVldRange());
  
  ostringstream os2;  //Use local to avoid manipulators from making permanent change to os.
  os2 << "SeqNo: " << vRec.GetSeqNo()  
      << "  AggNo: " << vRec.GetAggregateNo()
      << "  DbNo: " << vRec.GetDbNo();
  if ( vRec.IsGap() ) os2 << " (gap)";
  os2  << "  VldRange: |" 
       << setprecision(3) << hex << setfill ('0') << "0x" <<  setw(3) << range.GetDetectorMask() << "|"
       << "0x" << setw(3) << range.GetSimMask() << "|"
       << " " << range.GetTimeStart().AsString("s") << " .. "
       << range.GetTimeEnd().AsString("s") 
       << " from: " << range.GetDataSource();
  os << os2.str();
  return os;

}

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


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

void DbiValidityRec::AndTimeWindow(const VldTimeStamp& startOther,
                                   const VldTimeStamp& endOther) {
//
//
//  Purpose:  And in supplied start and end times.
//
//  Arguments: 
//    startOther   in    Start time to be ANDed in.
//    endOther     in    End time to be ANDed in.
//
//  Return:   None. 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Trim time windown on current record to be the overlap (and)
//    with the supplied time window.

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

//  None.

  VldTimeStamp start = fVldRange.GetTimeStart();
  VldTimeStamp end   = fVldRange.GetTimeEnd();

  SetTimeWindow( start > startOther ? start : startOther,
                 end   < endOther   ? end   : endOther );
}

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

DbiValidityRec::DbiValidityRec(Int_t dbNo,Bool_t isGap) :

fAggregateNo(-2),
fDbNo(dbNo),
fIsGap(isGap),
fTask(0),
fSeqNo(0),
fTableProxy(0)
{
//
//
//  Purpose:  Default constructor
//
//  Arguments:.  
//    dbNo     in    Cascade no. of database holding record.
//    isGap    in    = kTRUE if a gap.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create ValidityRec.


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

//  None.

  LEA_CTOR    //Leak Checker

  MSG("Dbi", Msg::kVerbose) << "Creating DbiValidityRec" << endl;
}
//.....................................................................

DbiValidityRec::DbiValidityRec(const DbiValidityRec& from) : DbiTableRow(from)
{
//
//
//  Purpose:  Copy constructor
//
//  Arguments:  
//    from    in    Object to be copied from.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create ValidityRec.


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

//  Explicit just for leak checking.

  LEA_CTOR    //Leak Checker

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

  *this = from;

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

DbiValidityRec::DbiValidityRec(const VldRange& range,
                               Dbi::Task task,
                               Int_t aggNo,
                               UInt_t seqNo,
                               Int_t dbNo,
                               Bool_t isGap,
                               VldTimeStamp time) :
fAggregateNo(aggNo),
fCreationDate(time),
fDbNo(dbNo),
fIsGap(isGap),
fTask(task),
fSeqNo(seqNo),
fTableProxy(0),
fVldRange(range)
{
//
//
//  Purpose:  Constructor from components
//
//  Arguments:  
//    range    in   component range
//    task     in   component task 
//    aggNo    in   component aggregate number
//    seqNo    in   component sequence number
//    dbNo     in    Cascade no. of database holding record.
//    isGap    in    = kTRUE if a gap.
//
//
//
// 
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create ValidityRec.


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

//  None.

  LEA_CTOR    //Leak Checker

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

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

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


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

//  None.

  LEA_DTOR    //Leak Checker

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

}

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

void DbiValidityRec::Fill(DbiResultSet& rs,
                          const DbiValidityRec* /* vrec */) {
//
//
//  Purpose:  Fill oject from Result Set
//
//  Arguments: 
//    rs           in    Result Set used to fill object
//    vrec         in    =0.  If filling other table rows it points
//                       to the associated validity record.
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Fill object from current row of Result Set.

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

//  None.

    VldTimeStamp start, end;
    Int_t detMask, simMask;

//  Establish source DbiTableProxy and cascade no.

    fTableProxy = rs.GetTableProxy();
    fDbNo       = rs.GetDbNo();

//  Read data from row.

    rs >> fSeqNo >> start >> end >> detMask >> simMask >> fTask 
       >> fAggregateNo    >> fCreationDate  >> fInsertDate;    

    fIsGap = kFALSE;

    VldRange vr(detMask, simMask, start, end, "From Database");
    fVldRange = vr;   

    MSG("Dbi", Msg::kVerbose) 
         << "DbiValidityRec for row " << rs.CurRowNum()
         << ": " << fVldRange.AsString()
         << " seq num: " << fSeqNo << endl;
}

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

std::string DbiValidityRec::GetL2CacheName() const {
//
//
//  Purpose:  Return the associated Level 2 Cache Name.
//
//  Specification:-
//  =============
//
//  o See GetL2CacheName(UInt_t seqLo, UInt_t seqHi, VldTimeStamp ts);

  return DbiValidityRec::GetL2CacheName(this->GetSeqNo(),
                                        this->GetSeqNo(),
                                        this->GetCreationDate());

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

std::string DbiValidityRec::GetL2CacheName(UInt_t seqLo, 
                                           UInt_t seqHi, 
                                           VldTimeStamp ts) {
//
//
//  Purpose:  Return the associated Level 2 Cache Name.
//
//  Specification:-
//  =============
//
//  o For unaggregated queries name format: <Seqno>_<CreationDate>
//
//  o For aggregated queries name format:   <LowSeqno>_<HighSeqNo>_<MaxCreationDate>

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

//  The static routine centralises the definition of cache names both for
//  DbiValidityRec and DbiValidityRecBuilder.

  ostringstream oss;
  oss << seqLo << "_";
  if ( seqLo != seqHi )  oss << seqHi << "_";
  oss << ts.AsString("s");
  std::string str(oss.str());
  // Convert white space to underscore.
  int i = str.size();
  while ( i-- ) if ( str[i] == ' ' ) str[i] = '_';
  return str;

}

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

Bool_t DbiValidityRec::HasExpired(const DbiValidityRec& other) const {
//
//
//  Purpose: See if validity record has expired i.e. is compatible with
//           this one except for date.
//
//  Arguments: 
//    other        in    Other DbiValidityRec to be compared with
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o See if validity record has expired i.e. is compatible with
//    this one except for date.

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

//  This method is used by DbiCache to select candidates for
//  purging.

  const VldRange& otherVR =other.GetVldRange();
 
  return 
     (       other.GetTask() == fTask  
        && ( otherVR.GetDetectorMask() & fVldRange.GetDetectorMask() )
        && ( otherVR.GetSimMask()      & fVldRange.GetSimMask() )
        && (    otherVR.GetTimeStart() >= fVldRange.GetTimeEnd()
             || otherVR.GetTimeEnd()   <= fVldRange.GetTimeStart() )
     );

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


Bool_t DbiValidityRec::HasExpired(const VldContext& vc,
                                  const Dbi::Task& task) const {
//
//
//  Purpose: See if validity record has expired i.e. is compatible with
//           this context query except for date.
//
//  Arguments: 
//    vc           in    Context of query
//    task         in    Task of query
//
//
//  Contact:   N. West

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

//  This method is used by DbiResult to identify when ready for
//  purging.

  VldTimeStamp    ts = vc.GetTimeStamp();
  const VldRange& vr = this->GetVldRange();

  return 
     (       task             == this->GetTask()  
        && ( vc.GetDetector() &  vr.GetDetectorMask() )
        && ( vc.GetSimFlag()  &  vr.GetSimMask() )
        && (    ts            >= vr.GetTimeEnd()
             || ts            <  vr.GetTimeStart() )
     );

}

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


Bool_t DbiValidityRec::IsCompatible(const VldContext& vc,
                                    const Dbi::Task& task) const {
//
//
//  Purpose: See if result is compatible with query. 
//
//  Arguments: 
//    vc           in    Context of new query
//    task         in    Task of new query
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o See if result is compatible with query.

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

//  None.

   MSG("Dbi",Msg::kDebug) 
     << " DbiValidityRec::IsCompatible : tasks:"
     << task << "," << fTask
     << " is compat: " << fVldRange.IsCompatible(vc) << endl
     << "   range " << fVldRange.AsString() << endl
     << "   context " << vc.AsString() << endl;

  return task == fTask  && fVldRange.IsCompatible(vc);

}

void DbiValidityRec::SetTimeWindow(const VldTimeStamp& start,
                                   const VldTimeStamp& end) {
//
//
//  Purpose:  Set supplied start and end times.
//
//  Arguments: 
//    start        in    Start time to be set,
//    end          in    End time to be set.
//
//  Return:   None. 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Set time windown on current record.

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

//  The method here is rather clumsy, but I don't know of anything
//  better!

  VldRange  range(fVldRange.GetDetectorMask(),
                  fVldRange.GetSimMask(),
                  start,
                  end,
                  fVldRange.GetDataSource() );
  fVldRange = range;

}

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

void DbiValidityRec::Store(DbiOutRowStream& ors,
                           const DbiValidityRec* /* vrec */) const {
//
//
//  Purpose:  Stream object to output row stream
//
//  Arguments: 
//    ors          in    Output row stream.
//    vrec         in    =0.  If filling other table rows it points
//                       to the associated validity record.
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Stream object to output row stream.

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

//  None.

//  Write data to row.

    ors << fSeqNo 
        << fVldRange.GetTimeStart() 
        << fVldRange.GetTimeEnd() 
        << fVldRange.GetDetectorMask()
        << fVldRange.GetSimMask() 
        << fTask 
        << fAggregateNo    
        << fCreationDate  
        << fInsertDate;       
}
//.....................................................................

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

//  Don't store the pointer fTableProxy (don't want to get into storing
//  pointers!); the DbiCache will fix it up on input

  if ( file.IsReading() ) {
    file >> fAggregateNo
         >> fCreationDate
         >> fDbNo
         >> fInsertDate
         >> fIsGap
         >> fTask
         >> fSeqNo
         >> fVldRange;
    fTableProxy = 0;
  }
  else if ( file.IsWriting() ) {
    file << fAggregateNo
         << fCreationDate
         << fDbNo
         << fInsertDate
         << fIsGap
         << fTask
         << fSeqNo
         << fVldRange;
  }
}

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

void DbiValidityRec::Trim(const VldTimeStamp& queryTime,
                          const DbiValidityRec& other) {
//
//
//  Purpose:  Trim this validity record so that represents 
//            best validity record for query.
//
//  Arguments: 
//    queryTime    in    Time of query
//    other        in    DbiValidity record satisfying query
//
//  Return:    None.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Update this validity record so that it remains the best
//    validity record taking into account the supplied record.


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

//  This is the function that deal with validity management.
//  It takes into account that several validity records may
//  overlap and that the best one is the one with the latest
//  creation date that brackets the query date.  Other entries
//  with later creation dates may trim start or end times.

//  Assumptions:-
//  ===========
//
//  That entries are submitted in strict descending priority i.e.:-
//
//  1)  Entries for a higher priority database precede those from a
//      lower priority one.
//
//  2)  Within a database entries are in descending creation date order.


//  Ignore other records that are either gaps or have wrong
//  aggregate number.

  if ( fAggregateNo != other.fAggregateNo || other.IsGap() ) return;
  
//  If this record is not a gap then the other record can be ignore
//  as it is of lower priority.

  if ( ! IsGap() ) return;

  VldTimeStamp start      = fVldRange.GetTimeStart();
  VldTimeStamp end        = fVldRange.GetTimeEnd();
  VldTimeStamp startOther = other.GetVldRange().GetTimeStart();
  VldTimeStamp endOther   = other.GetVldRange().GetTimeEnd();
  
// If entry brackets query date, then use it but with a validity that
// is trimmed by the current record.

  if ( startOther <= queryTime && endOther > queryTime ) {
    if ( start < startOther ) start = startOther;
    if ( end   > endOther   ) end   = endOther;
    *this = other;
    SetTimeWindow(start,end);
  }

// It doesn't bracket, so use it to trim the window

  else {

    if ( endOther <= queryTime ) {
      if ( start < endOther   ) SetTimeWindow(endOther,end);
    }
    else if ( startOther > queryTime ) {
      if ( end   > startOther ) SetTimeWindow(start, startOther);
    }
  }

}

/*    Template for New Member Function

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

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

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

//  None.


}

*/

---