db_class.h

Go to the documentation of this file.

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2009, Willow Garage, Inc.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the Willow Garage nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *********************************************************************/

// Author(s): Matei Ciocarlie

#ifndef _DB_CLASS_H_
#define _DB_CLASS_H_

#include "database_interface/db_field.h"

namespace database_interface {


class DBClass
{
 private:

  DBClass& operator = (const DBClass& rhs);

 protected:
  DBFieldBase* primary_key_field_;

  std::vector<DBFieldBase*> fields_;


  std::map<std::string, DBFieldBase*> foreign_keys_;

 public:
  DBClass() : primary_key_field_(NULL) {}

  size_t getNumFields() const {return fields_.size();}

  DBFieldBase* getField(size_t i) {return fields_.at(i);}
  const DBFieldBase* getField(size_t i) const {return fields_.at(i);}

  DBFieldBase* getField(std::string name) 
  {
    if (primary_key_field_->getName() == name) return primary_key_field_;
    for (size_t t=0; t<fields_.size(); t++)
    {
      if (fields_[t]->getName() == name) return fields_[t];
    }
    return NULL;
  }
  const DBFieldBase* getField(std::string name) const {return getField(name);}

  DBFieldBase* getPrimaryKeyField() {return primary_key_field_;}
  const DBFieldBase* getPrimaryKeyField() const {return primary_key_field_;}


  bool getForeignKey(std::string table, const DBFieldBase* &key) const
  {
    std::map<std::string, DBFieldBase*>::const_iterator it;
    it = foreign_keys_.find(table);
    if (it==foreign_keys_.end()) return false;
    key = it->second;
    return true;
  }

  bool getForeignKey(std::string table, DBFieldBase* &key)
  {
    return getForeignKey(table, key);
  }

  void setAllFieldsReadFromDatabase(bool sync)
  {
    if (primary_key_field_) primary_key_field_->setReadFromDatabase(sync);
    for (size_t i=0; i<fields_.size(); i++)
    {
      fields_[i]->setReadFromDatabase(sync);
    }
  }

  void setAllFieldsWriteToDatabase(bool sync)
  {
    if (primary_key_field_) primary_key_field_->setWriteToDatabase(sync);
    for (size_t i=0; i<fields_.size(); i++)
    {
      fields_[i]->setWriteToDatabase(sync);
    }
  }

};

} //namespace database_interface

#endif