DataMethod.hxx

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// CVS: $Revision: 4695 $, $Date: 2008-04-09 16:18:42 +0100 (Wed, 09 Apr 2008) $, $Author: EckhardSutorius $
//-----------------------------------------------------------------------------
#ifndef DATAMETHOD_H
#define DATAMETHOD_H

#include <string>

#include "DataTypes.h"
#include "Logger.h"
#include "MyException.h"
#include "Options.h"
#include "StringOps.h"
#include "TableData.hxx"
#include "TableInfo.h"
//-----------------------------------------------------------------------------
class DataMethodException : public MyException
{
public:
  DataMethodException(const std::string& aMsg)
    : MyException("DataMethodException: ", aMsg) { }
};
//-----------------------------------------------------------------------------
template<typename DataType>
class DataMethod
{
public:
  DataMethod() { methodName = "Unspecified DataMethod"; }

  virtual ~DataMethod() { }

  const std::string& getName() const { return methodName; }

  //---------------------------------------------------------------------------
  void logInfo(const StringMap& aTarget)
  {
    std::string mess("Instantiated method '" + methodName + "' for targets: ");
    for (StringMap::const_iterator targetItr = aTarget.begin();
                                   targetItr != aTarget.end();
                                   ++targetItr)
    {
      mess += targetItr->second + " ";
    }
    Logger log;
    log.addMessage(mess);
  }

  //---------------------------------------------------------------------------
  bool useOtherTables(IntMap& sourceTbl, int tabNo)
  {
    for (unsigned n = 0; n < sourceTbl.size(); ++n)
    {
      if (tabNo != sourceTbl[n]) { return true; }
    }
    return false;
  }

  //---------------------------------------------------------------------------

  void determineSourceAndTarget(const TableInfo& aInfo,
                                const StringMap& aTarget)
  {
    Options options;
    logInfo(aTarget);

    IntMap targetCol;
    StringMap targetUnits;

    string qtag;
    for (StringMap::const_iterator targetItr = aTarget.begin();
                                   targetItr != aTarget.end();
                                   ++targetItr)
    {
      // @@TODO: Check against TableInfo::ColNotFound
      targetCol[targetItr->first]
        = aInfo.getAttNo(targetItr->second);
      targetUnits[targetItr->first]
        = aInfo.getUnits(targetCol[targetItr->first]);
      // @@BUG: Should this be summing????
      qtag = aInfo.getUsingValue(targetCol[targetItr->first]);
    }

    StringMap source;
    StringOps::split(qtag, ',', source);

    IntMap sourceTbl;
    IntMap sourceCol;
    StringMap sourceUnits;

    for (unsigned n = 0; n < source.size(); ++n)
    {
      // @@TODO: Check against TableInfo::ColNotFound
      sourceTbl[n]   = options.getTableNum(aInfo.getTableName());
      sourceCol[n]   = aInfo.getAttNo(source[n]);
      sourceUnits[n] = aInfo.getUnits(sourceCol[n]);
    }

    setSource(sourceTbl, sourceCol, sourceUnits);
    setTarget(targetCol, targetUnits);
  }

  //---------------------------------------------------------------------------

  bool determineDetectionSourceAndTarget(const TableInfo *aInfo, int tabNo,
                                         const StringMap& aTarget)
  {
    Options options;
    logInfo(aTarget);

    IntMap targetCol;
    StringMap targetUnits;

    string qtag;
    for (StringMap::const_iterator targetItr = aTarget.begin();
                                   targetItr != aTarget.end();
                                   ++targetItr)
    {
      // @@TODO: Check against TableInfo::ColNotFound
      targetCol[targetItr->first]
        = aInfo[tabNo].getAttNo(targetItr->second);
      targetUnits[targetItr->first]
        = aInfo[tabNo].getUnits(targetCol[targetItr->first]);
      // @@BUG: Should this be summing????
      qtag = aInfo[tabNo].getUsingValue(targetCol[targetItr->first]);
    }

    StringMap source;
    StringOps::split(qtag, ',', source);

    IntMap sourceTbl;
    IntMap sourceCol;
    StringMap sourceUnits;
    
    for (unsigned n = 0; n < source.size(); ++n)
    {
      // @@TODO: Check against TableInfo::ColNotFound
      if (source[n].find('.') != std::string::npos)
      {
        StringMap qtab;
        StringOps::split(source[n], '.', qtab);
        sourceTbl[n]   = options.getTableNum(qtab[0]);
        sourceCol[n]   = aInfo[sourceTbl[n]].getAttNo(qtab[1]);
        sourceUnits[n] = aInfo[sourceTbl[n]].getUnits(sourceCol[n]);
      } else {
        sourceTbl[n]   = tabNo;
        sourceCol[n]   = aInfo[tabNo].getAttNo(source[n]);
        sourceUnits[n] = aInfo[tabNo].getUnits(sourceCol[n]);
      }
    }
    setSource(sourceTbl, sourceCol, sourceUnits);
    setTarget(targetCol, targetUnits);
    bool useOtherTbl = useOtherTables(sourceTbl, tabNo);
    return useOtherTbl;
  }

  //---------------------------------------------------------------------------
  // Here we define 3 pure virtual functions that provides the
  // standard interface for a data method. The actual implementation
  // for a given method is coded up in the appropriate derived class

  virtual void setSource(IntMap& tbls, IntMap& cols, StringMap units) = 0;

  virtual void setTarget(IntMap& cols, StringMap units) = 0;

  virtual void doit(TableData<DataType>& data, int row1, int row2) = 0;
  virtual void doit2(TableData<DataType>& inpData, TableData<DataType>& data, int row1, int row2) = 0;

protected:
  std::string methodName;
};
//-----------------------------------------------------------------------------
template<typename DataType>
class NothingToDo : public DataMethod<DataType>
{
public:
  NothingToDo()
    { DataMethod<DataType>::methodName = "NothingToDo"; }

  void setSource(IntMap& tbls, IntMap& cols, StringMap units) {}

  void setTarget(IntMap& cols, StringMap units) {}

  void doit(TableData<DataType>& data, int row1, int row2) {}

  void doit2(TableData<DataType>& inpData, TableData<DataType>& data, int row1, int row2) {}

  // explicit Destructor
  ~NothingToDo() {}
};
//-----------------------------------------------------------------------------
#endif
//-----------------------------------------------------------------------------
// Change log:
//
// 27-May-2004,  IAB: Original version.
// 15-Mar-2006,  RSC: Moved logMethodInfo() from MakeCSV.hxx to become a method
//                    of this class
// 16-Mar-2006,  RSC: Made function checkArguments() in DataMethodFactory.hxx a
//                    method of DataMethod called determineSourceAndTarget()
//  7-Apr-2008, ETWS: Upgraded to use new detection table layout.

---