IShapeTableDefinition.hpp

#ifndef DM_IO_ISHAPE_TABLE_DEFINITION_HPP_INCLUDED
#define DM_IO_ISHAPE_TABLE_DEFINITION_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

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

#include "DM/ColumnTypes.hpp"
#include "DM/IAddInfoLayout.hpp"
#include "DM/ObjectBase.hpp"
#include "DM/Handle.hpp"

DM_NAMESPACE_BEGIN

/// \brief Object storing a dbf table definition (for shape files)
class DM_API IShapeTableDefinition : public ObjectBase 
{
public:
  /// \brief create a dbf table definition based on a add info layout
  static IShapeTableDefinition* New(const AddInfoLayoutHandle &layout);
  static IShapeTableDefinition* New(unsigned count, const char **names, const ColumnType::Type *types, const unsigned *widths, const unsigned *decimals);

  static void translate(ColumnSemantic::Type sem, ColumnType::Type &dbfType, unsigned &dbfWidth, unsigned &dbfDecimals);
  static void translate(ColumnType::Type ngType, unsigned size, ColumnType::Type &dbfType, unsigned &dbfWidth, unsigned &dbfDecimals);
protected:
  virtual ~IShapeTableDefinition() {}

public:
  /// number of attributes/columns
  virtual unsigned columns() const = 0;

  /// get name of attribute 'index'
  virtual const char*       name(unsigned index) const = 0;
  /// get type of attribute 'index'
  /** a shape file can contain following types:
      - DM::ColumnType::cstr_   (fixed length c string)
      - DM::ColumnType::int_    (4 byte, signed integer)
      - DM::ColumnType::double_ (8 byte, real value)
      - DM::ColumnType::bool_   (bit value)
  */
  virtual ColumnType::Type  type(unsigned index) const = 0;  
  
  /// length of string or number of digits for real and integeral number types
  virtual unsigned          width(unsigned index) const = 0;

  /// number of decimal places (only relevant for type DM::ColumnType::double_)
  virtual unsigned          decimales(unsigned index) const = 0;

};

typedef Handle<IShapeTableDefinition> ShapeTableDefinitionHandle;

DM_NAMESPACE_END

#endif //DM_IO_ISHAPE_TABLE_DEFINITION_HPP_INCLUDED