IImportShape.hpp

#pragma once
 
//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:
  /// \brief creates new shape import object
  /**
    interface for importing geometry objects from a shpae file
    \param[in]  file                shape filename
    \param[in]  filter              filter for subselecting/transforming objects during export
    \param[in]  control             control object for retrieving export progress information
    \param[in]  collectHdrContents  flag for explicitly collecting header information while exporting
    \param[in]  maxBulkPoints       chunk size for bulk points being imported at once
    \param[in]  defaultLayout       default attribute layout for objects while importing (attribute stored within the file, will be extended to this layout)
  */  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 (deprecated. use attribute information in file header instead)
  static ShapeTableDefinitionHandle getTableDefinition(const char *file);
 
protected:
  virtual ~IImportShape() {}
 
public:
  /// \brief enable (default) or disable dbf attribute import.
  /// any subsequent importAttribute, v_setAddInfoMapping or v_setSemanticMapping call will automatic re-enable the dbf import flag
  virtual void importDBFAttributes(bool flag) = 0;
 
  /// \brief import a dbf column as predefined DM attribute specified by its ColumnSemantic
  virtual void importAttribute(int dbfAttrIndex, ColumnSemantic ngCol) = 0;
 
  /// \brief import a dbf column as predefined or user-defined DM attribute
  virtual void importAttribute(int dbfAttrIndex, const char *ngName = 0, ColumnType ngType = ColumnType::count) = 0;
 
  /// \brief set a mapping between dbf attributes and an add info layout for importing the attribute information as well (deprecated)
  /** 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 (deprecated)
  /** 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