IImportShape.hpp

#ifndef DM_IO_IMPORT_SHAPE_HPP_INCLUDED
#define DM_IO_IMPORT_SHAPE_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

//DM
#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink

#include "DM/ColumnTypes.hpp"
#include "DM/IO/IImport.hpp"
#include "DM/IO/IShapeTableDefinition.hpp"

DM_NAMESPACE_BEGIN

/// Specific import class for handling shape file imports
class DM_API IImportShape : public virtual IImport 
{
public:
  static IImportShape* New( const char *file, FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(), 
                            bool collectHdrContents = false, unsigned maxBulkPoints = 1000, AddInfoLayoutHandle defaultLayout = AddInfoLayoutHandle() );

  /// retrieve the table definition of corresponding dbf file
  static ShapeTableDefinitionHandle getTableDefinition(const char *file);

protected:
  virtual ~IImportShape() {}

public:
  /// \brief set a mapping between dbf attributes and an add info layout for importing the attribute information as well
  /** This is optional import definition must be set before the first element (and file header) is read. If nothing is set no
      dbf attributes will be imported. 
      \param[in] layout   layout that should be attached to each geometry object
      \param[in] mapSize  size of the idxMap, which has to be a corresponding C array
      \param[in] idxMap   C array mapping the dbf attribute index (first value of std::pair) to the add info layout index (second value of std::pair)
   */
  virtual void setAttributeMapping(AddInfoLayoutHandle layout, unsigned mapSize, std::pair<unsigned, unsigned> *idxMap) = 0;

  /// \brief set a mapping between dbf attributes and an add info layout for importing the attribute information as well
  /** This is optional import definition must be set before the first element (and file header) is read. If nothing is set no
      dbf attributes will be imported. 
      \param[in] layout   layout that should be attached to each geometry object
      \param[in] mapSize  size of the idxMap, which has to be a corresponding C array
      \param[in] idxMap   C array mapping the dbf attribute name (first value of std::pair) to the add info layout index (second value of std::pair)
   */
  virtual void setAttributeMapping(AddInfoLayoutHandle layout, unsigned mapSize, std::pair<const char*, unsigned> *idxMap) = 0;

  /// \brief set a translation map between a dbf attribute and the scop semantic 
  /** This is optional import definition must be set before the first element (and file header) is read.
      \param[in] columnIdx      index of the dbf attribute to be used
      \param[in] mapSize        size of the idxMap, which has to be a corresponding C array
      \param[in] translationMap C array mapping string values (first value of std::pair) to the scop semantic (second value of std::pair)
   */
  virtual void setSemanticTranslation(unsigned columnIdx, unsigned mapSize, std::pair<const char*, int> *translationMap ) = 0;

  /// \brief set a translation map between a dbf attribute and the scop semantic 
  /** This is optional import definition must be set before the first element (and file header) is read.
      \param[in] columnName       dbf attribute name to be used
      \param[in] mapSize          size of the idxMap, which has to be a corresponding C array
      \param[in] translationMap   C array mapping string values (first value of std::pair) to the scop semantic (second value of std::pair)
   */
  virtual void setSemanticTranslation(const char* columnName, unsigned mapSize, std::pair<const char*, int> *translationMap ) = 0;

};

typedef Handle<IImportShape> ImportShapeHandle;

DM_NAMESPACE_END

#endif //DM_IO_IMPORT_SHAPE_HPP_INCLUDED