stringHashMap.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: stringHashMap.h,v 1.25 2004/05/06 21:39:37 oliver Exp $
//

#ifndef BALL_DATATYPE_STRINGHASHMAP_H
#define BALL_DATATYPE_STRINGHASHMAP_H

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_COMMON_HASH_H
# include <BALL/COMMON/hash.h>
#endif

#ifndef BALL_CONCEPT_VISITOR_H
# include <BALL/CONCEPT/visitor.h>
#endif

#ifndef BALL_CONCEPT_PROCESSOR_H
# include <BALL/CONCEPT/processor.h>
#endif

#ifndef BALL_DATATYPE_HASHMAP_H
# include <BALL/DATATYPE/hashMap.h>
#endif

#include <algorithm>

namespace BALL 
{


  template <typename Value>
  class StringHashMap
    : public HashMap<String, Value>
  {
    public:

    BALL_CREATE(StringHashMap)

    

    typedef typename HashMap<String, Value>::Iterator Iterator;

    typedef typename HashMap<String, Value>::ConstIterator ConstIterator; 
    
    typedef typename HashMap<String, Value>::ValueType ValueType; 


    StringHashMap()
      : HashMap<String, Value>()
    {
    }

    StringHashMap(const StringHashMap& map)
      : HashMap<String, Value>(map)
    {
    }
      
    virtual ~StringHashMap()
    {
    }

    void destroy()
    {
      HashMap<String, Value>::clear();
    }
  

      
    void set(const StringHashMap& hash_map)
    {
      HashMap<String, Value>::clear();

      ConstIterator it = hash_map.begin();
      for ( ; it != hash_map.end(); ++it)
      {
        insert(*it);
      }
    }

    const StringHashMap& operator = (const StringHashMap& hash_map)
    {
      set(hash_map);
      return *this;
    }
      
    void get(StringHashMap& hash_map) const
    {
      hash_map.set(*this);
    }

    void swap(StringHashMap& hash_map)
    {
      std::swap(*this, hash_map);
    }



    std::pair<Iterator, bool> insert(const ValueType& obj)
    {
      return HashMap<String, Value>::insert(obj);
    }
    
    ::std::pair<Iterator, bool> insert(const String& key, const Value& value)
    {
      return HashMap<String, Value>::insert(::std::pair<String, Value>(key, value));
    }

      
    bool remove(const String& key)
    {
      // search the key
      Iterator it = HashMap<String, Value>::find(key);
      if (it == HashMap<String, Value>::end())
      {
        // we didn't find it..
        return false;
      }
      
      // found it: delete it
      HashMap<String, Value>::erase(it);

      return true;
    }

    Size getSize() const
    {
      return HashMap<String, Value>::size();
    }
    


    bool operator == (const StringHashMap<Value>& hash_map) const
    {
      return HashMap<String, Value>::operator == (hash_map);
    }

    bool operator != (const StringHashMap<Value>& hash_map) const
    {
      return !(HashMap<String, Value>::operator == (hash_map));
    }

    bool has(const String& key) const
    {
      return !(HashMap<String, Value>::find(key) == HashMap<String, Value>::end());
    }

    bool isEmpty() const
    {
      return (HashMap<String, Value>::size() == 0);
    }


    void host(Visitor<StringHashMap<Value> >& visitor)
    {
      visitor.visit(*this);  
    }

  };

// required for visual studio
#ifdef BALL_COMPILER_MSVC
template class BALL_EXPORT StringHashMap<String>;
#endif

}// namespace BALL

#endif // BALL_DATATYPE_HASHMAP_H