Logo Search packages:      
Sourcecode: poco version File versions

DynamicFactory.h

//
// DynamicFactory.h
//
// $Id: //poco/1.4/Foundation/include/Poco/DynamicFactory.h#1 $
//
// Library: Foundation
// Package: Core
// Module:  DynamicFactory
//
// Definition of the DynamicFactory class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
// 
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


#ifndef Foundation_DynamicFactory_INCLUDED
#define Foundation_DynamicFactory_INCLUDED


#include "Poco/Foundation.h"
#include "Poco/Instantiator.h"
#include "Poco/Exception.h"
#include "Poco/Mutex.h"
#include <map>
#include <memory>


namespace Poco {


template <class Base>
00055 class DynamicFactory
      /// A factory that creates objects by class name.
{
public:
      typedef AbstractInstantiator<Base> AbstractFactory;

00061       DynamicFactory()
            /// Creates the DynamicFactory.
      {
      }

00066       ~DynamicFactory()
            /// Destroys the DynamicFactory and deletes the instantiators for 
            /// all registered classes.
      {
            for (typename FactoryMap::iterator it = _map.begin(); it != _map.end(); ++it)
            {
                  delete it->second;
            }
      }
      
00076       Base* createInstance(const std::string& className) const
            /// Creates a new instance of the class with the given name.
            /// The class must have been registered with registerClass.
            /// If the class name is unknown, a NotFoundException is thrown.
      {
            FastMutex::ScopedLock lock(_mutex);

            typename FactoryMap::const_iterator it = _map.find(className);
            if (it != _map.end())
                  return it->second->createInstance();
            else
                  throw NotFoundException(className);
      }
      
      template <class C> 
00091       void registerClass(const std::string& className)
            /// Registers the instantiator for the given class with the DynamicFactory.
            /// The DynamicFactory takes ownership of the instantiator and deletes
            /// it when it's no longer used.
            /// If the class has already been registered, an ExistsException is thrown
            /// and the instantiator is deleted.
      {
            registerClass(className, new Instantiator<C, Base>);
      }
      
00101       void registerClass(const std::string& className, AbstractFactory* pAbstractFactory)
            /// Registers the instantiator for the given class with the DynamicFactory.
            /// The DynamicFactory takes ownership of the instantiator and deletes
            /// it when it's no longer used.
            /// If the class has already been registered, an ExistsException is thrown
            /// and the instantiator is deleted.
      {
            poco_check_ptr (pAbstractFactory);

            FastMutex::ScopedLock lock(_mutex);

            std::auto_ptr<AbstractFactory> ptr(pAbstractFactory);
            typename FactoryMap::iterator it = _map.find(className);
            if (it == _map.end())
                  _map[className] = ptr.release();
            else
                  throw ExistsException(className);
      }
      
00120       void unregisterClass(const std::string& className)
            /// Unregisters the given class and deletes the instantiator
            /// for the class.
            /// Throws a NotFoundException if the class has not been registered.
      {
            FastMutex::ScopedLock lock(_mutex);

            typename FactoryMap::iterator it = _map.find(className);
            if (it != _map.end())
            {
                  delete it->second;
                  _map.erase(it);
            }
            else throw NotFoundException(className);
      }
      
00136       bool isClass(const std::string& className) const
            /// Returns true iff the given class has been registered.
      {
            FastMutex::ScopedLock lock(_mutex);

            return _map.find(className) != _map.end();
      }

private:
      DynamicFactory(const DynamicFactory&);
      DynamicFactory& operator = (const DynamicFactory&);

      typedef std::map<std::string, AbstractFactory*> FactoryMap;
      
      FactoryMap _map;
      mutable FastMutex _mutex;
};


} // namespace Poco


#endif // Foundation_DynamicFactory_INCLUDED

Generated by  Doxygen 1.6.0   Back to index