IAddInfoLayoutFactory.hpp

#ifndef DM_IADDINFO_LAYOUT_CREATOR_HPP_INCLUDED
#define DM_IADDINFO_LAYOUT_CREATOR_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/ColumnTypes.hpp"
#include "DM/Handle.hpp"
#include "DM/IAddInfoLayout.hpp"
#include "DM/AutoLink.hpp" //enable autolink


DM_NAMESPACE_BEGIN

class IDatamanager; //forward declaration


/// \brief Interface to a factory object for creating AddInfo layouts
class DM_API IAddInfoLayoutFactory : public ObjectBase
{
public:
  static IAddInfoLayoutFactory* New();
  //static AddInfoLayoutHandle    getEmptyTableLayout();

  static AddInfoLayoutHandle  getPredefinedLayout(const char *label);
  static AddInfoLayoutHandle  merge(AddInfoLayoutHandle layout1, AddInfoLayoutHandle layout2);

protected:
  virtual ~IAddInfoLayoutFactory() {}

public:
  /// \brief clear added entries from the factory
  virtual void clear() = 0;

  /// \brief add a user-defined attribute
  /// User-defined attribute always have to start with a '_'. For adding predefined attributes please use the corresponding ColumnSemantic value
  /// \param[in]  type  type of the user-defined attribute
  /// \param[in]  name  name of the user-defined attribute
  /// \return reference to the factory object (allows calling multiple addColumn in a row)
  virtual IAddInfoLayoutFactory& addColumn(ColumnType::Type type, const char *name) = 0;
  virtual IAddInfoLayoutFactory& addColumn(ColumnType::Type type, const char *name, unsigned arraySize) = 0;
  /// \brief add a pre-defined attribute
  /// \param[in]  semantic  semantic value of the corresponding attribute
  /// \return reference to the factory object (allows calling multiple addColumn in a row)
  virtual IAddInfoLayoutFactory& addColumn(ColumnSemantic::Type semantic) = 0;

  /// \brief add a column from an existing layout
  /// \param[in]  layout  existing layout
  /// \param[in]  idx     index of column that should be added
  virtual IAddInfoLayoutFactory& addColumn(const DM::IAddInfoLayout &layout, unsigned idx) = 0;

  /// \brief add all columns of an existing layout
  /// \param[in]  layout  existing layout
  virtual IAddInfoLayoutFactory& addColumn(const DM::IAddInfoLayout &layout) = 0;

  /// \brief add pre- or user-defined attribute based on attributes stored within a datamanager
  /// In contrast to the other addColumn functions, this function supports adding user- and per-defined attributes. 
  /// Whereas the type of pre-defined attributes is fixed, for user-defined attributes the type has to be specified. For accessing
  /// user-defined attributes in a datamanager, the corresponding type has to be known since it is not allow 
  /// combining identical named columns with different types within one layout. Therefore the function takes a damanager reference
  /// as first parameter and checks the type all used-defined attributes within the datamanager. If there is a match of the attribute 
  /// name, the type as in the datamanager is used. Otherwise the column is not or with the given default type added.
  ///
  /// \param[in]  dm               const reference to a datamanager object
  /// \param[in]  name             attribute name
  /// \param[in]  forceAdding      adds the attribute even if it's not within the datamanager
  /// \param[in]  defaultType      in case of user-defined attribute that are not in the manager the specified type will be used
  /// \param[in]  caseSensitive    check if the name should be compared case sensitive (or not) to the datamanager attributes
  /// \return type of the attribute (or ColumnType::none if no attribute was added) and the flag if the attribute exists within the manager
  virtual std::pair<ColumnType::Type,bool> addColumn(const IDatamanager &dm, const char *name, bool forceAdding = true, ColumnType::Type defaultType = ColumnType::float_,  bool caseSensitive = false) = 0;


  virtual AddInfoLayoutHandle getLayout(bool clear = true) = 0;

  virtual AddInfoLayoutHandle getEmptyLayout() const = 0;
};

typedef Handle<IAddInfoLayoutFactory> AddInfoLayoutFactoryHandle;

DM_NAMESPACE_END

#endif //DM_IADDINFO_LAYOUT_CREATOR_HPP_INCLUDED