DDD_ConverterFactory.h

Go to the documentation of this file.

#ifndef _DDD_ConverterFactory_h_
#define _DDD_ConverterFactory_h_

/*! \file DDD_ConverterFactory.h
  \brief  The DDD_ConverterFactory class.  Factory for creating Data Director converters.

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#include "DDD_Include.h"
#include "DDD_LogFacade.h"
#include "DDD_ConvertBase.h"
#include "DDD_StringList.h"
#include "DDD_DynamicLibrary.h"
#include <string>


namespace disti
{

class DDD_ConverterLibrary;
/** \brief  The DDD_ConverterFactory class.  Factory for creating Data Director converters.
    */
class DDD_EXPORT DDD_ConverterFactory : public DDD_LogFacade
{
private:

    typedef DynamicPtrArray<DDD_ConverterLibrary*> ConverterLibraryList;

    ConverterLibraryList _loadedLibs;  /**< List of loaded converter libraries */

    /** Constructor.  Only the static Instance() interface can create this */
    DDD_ConverterFactory();

    /** Destructor. */
    ~DDD_ConverterFactory();

    /** Intalls the built-in converters into the factory */
    void InstallBuiltInConverters();

public:

    /** Public interface to the singleton 
      * \return Returns a pointer to the singleton instance 
      */
    static DDD_ConverterFactory& Instance();

    /** Creates a new converter of the requested type
      * \param className The name of the converter class to instantiate
      * \param observer  An attribute observer that will be notified when the converter fires.
      * \return Returns a pointer to instantiated converter, or null if converter cannot be instantiated
      */
    DDD_ConvertBase* InstantiateNewConverter(const std::string& className,DDD_AttributeObserver *observer);

    /** Attempts to load multiple converters that are stored into a single plugin file
      * \param libFileName  The name of the library file to search
      *  \return Returns true if any were discovered and successfully added
      */
    bool FindAllConverters(const std::string& libFileName);

    /** \return Returns a list of known converter types
      */
    DDD_StringList& GetKnownConverterTypes();
};


}   // end namespace disti


#endif