GloClassInfoAttribute.h

Go to the documentation of this file.

#ifndef INC_GLOCLASSINFOATTRIBUTE_H
#define INC_GLOCLASSINFOATTRIBUTE_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#include "GloTypes.h"
#include <string>
#include <unordered_set>
#include "GloClassInfoItem.h"
#include "EuLanguageFunctions.h"
//-----------------------------------------------------------------------------
namespace glo
{
  //---------------------------------------------------------------------------
  class AttributeID;
  class GloBaseRecordAttribute;
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( disable : 4251 )
  #endif
  //---------------------------------------------------------------------------
  class __glo_export_dll ClassInfoAttribute : public ClassInfoItem
  {
    private:
      //============== Friends
      //-----------------------------------------------------------------------
      friend class SchemaInterface;
      friend class ClassInfo;
      //-----------------------------------------------------------------------
 
    public:
      //-----------------------------------------------------------------------
      // >>>>>>>>>>>>>>>>>>>>>>>>>>> Type >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
      //-----------------------------------------------------------------------
      class __glo_export_dll Type
      {
        private:
          //============== Attribute
          //---------------------------------------------------------------------
          EnDataType m_eType;
          //---------------------------------------------------------------------
          // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
          // Is a reference to the GlobalObjects documentation.
          //---------------------------------------------------------------------
          std::string m_sInfo;
          //---------------------------------------------------------------------
          std::string m_sSubType;
          //---------------------------------------------------------------------
          unsigned long m_ulSubTypeClassID;
          //---------------------------------------------------------------------
 
        public:
          //============== Konstruktoren
          //---------------------------------------------------------------------
          Type();
          //---------------------------------------------------------------------
          // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
          // Is a reference to the GlobalObjects documentation.
          //---------------------------------------------------------------------
          Type( EnDataType eType,
                const std::string & rsInfo,
                const std::string & rsSubType,
                unsigned long ulSubTypeClassID );
          //---------------------------------------------------------------------
          Type( const Type & rT );
          //---------------------------------------------------------------------
 
          //============== Methoden
          //---------------------------------------------------------------------
          void setType( EnDataType eType );
          //---------------------------------------------------------------------
          EnDataType getType() const;
          //---------------------------------------------------------------------
          // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
          // Is a reference to the GlobalObjects documentation.
          //---------------------------------------------------------------------
          void setTypeInfo( const std::string & rsInfo );
          //---------------------------------------------------------------------
          // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
          // Is a reference to the GlobalObjects documentation.
          //---------------------------------------------------------------------
          std::string getTypeInfo() const;
          //---------------------------------------------------------------------
          bool isCrossreferenceType() const;
          //---------------------------------------------------------------------
          bool isCrossreferenceType( unsigned long & rulBaseID ) const;
          //---------------------------------------------------------------------
          bool isCrossreferenceType( std::string & rsCrossRefFileName ) const;
          //---------------------------------------------------------------------
          void setSubType( const std::string & rsSubType );
          //---------------------------------------------------------------------
          std::string getSubType() const;
          //---------------------------------------------------------------------
          void setSubTypeClassID( unsigned long ulSubTypeClassID );
          //---------------------------------------------------------------------
          unsigned long getSubTypeClassID() const;
          //---------------------------------------------------------------------
 
          //============== Operatoren
          //---------------------------------------------------------------------
 
          bool operator== ( const ClassInfoAttribute::Type & rT ) const;
          bool operator!= ( const ClassInfoAttribute::Type & rT ) const;
          //---------------------------------------------------------------------
          ClassInfoAttribute::Type & operator= ( const ClassInfoAttribute::Type & rT );
          //---------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      // <<<<<<<<<<<<<<<<<<<<<<<<<<<< Type <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      //-----------------------------------------------------------------------
 
    private:
      //============== Attribute
      //-----------------------------------------------------------------------
      std::string m_sTableName;
      //-----------------------------------------------------------------------
      std::string m_sFieldName;
      //-----------------------------------------------------------------------
      int m_iFieldPos;
      //-----------------------------------------------------------------------
      ClassInfoAttribute::Type m_Type;
      //-----------------------------------------------------------------------
 
      //============== Developer Attribute
      //-----------------------------------------------------------------------
      std::string m_sDeveloperAccessControl;
      //-----------------------------------------------------------------------
 
    public:
      //============= Konstruktoren
      //-----------------------------------------------------------------------
      ClassInfoAttribute();
      //-----------------------------------------------------------------------
      // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
      // Is a reference to the GlobalObjects documentation.
      //-----------------------------------------------------------------------
      ClassInfoAttribute( const std::string & rsName,
                          const std::string & rsTableName,
                          const std::string & rsFieldName,
                          int iFieldPos,
                          const std::string & rsAttributeType,
                          const std::string & rsInfo );
      //-----------------------------------------------------------------------
      ClassInfoAttribute( const ClassInfoAttribute & rT );
      //-----------------------------------------------------------------------
      virtual ~ClassInfoAttribute();
      //-----------------------------------------------------------------------
 
      //============== Methoden
      //-----------------------------------------------------------------------
      AttributeID getAttributeID() const;
      //-----------------------------------------------------------------------
      void setTableName( const std::string & rsName );
      //-----------------------------------------------------------------------
      void setFieldName( const std::string & rsName );
      //-----------------------------------------------------------------------
      void setFieldPos( int iFieldPos );
      //-----------------------------------------------------------------------
      void setDataType( EnDataType eType );
      //-----------------------------------------------------------------------
      // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
      // Is a reference to the GlobalObjects documentation.
      //-----------------------------------------------------------------------
      void setDataTypeInfo( const std::string & rsInfo );
      //-----------------------------------------------------------------------
      void setDataTypeSubType( const std::string & rsSubType );
      //-----------------------------------------------------------------------
      void setDataTypeSubTypeClassID( unsigned long ulSubTypeClassID );
      //-----------------------------------------------------------------------
      std::string getClassAttributeName() const;
      //-----------------------------------------------------------------------
      std::string getTableFieldName() const;
      //-----------------------------------------------------------------------
      std::string getTableName() const;
      //-----------------------------------------------------------------------
      std::string getFieldName() const;
      //-----------------------------------------------------------------------
      int getFieldPos() const;
      //-----------------------------------------------------------------------
      std::string getFieldPosAsString() const;
      //-----------------------------------------------------------------------
      ClassInfoAttribute::Type getType() const;
      //-----------------------------------------------------------------------
      EnDataType getDataType() const;
      //-----------------------------------------------------------------------
      std::string getDataTypeSubType() const;
      //-----------------------------------------------------------------------
      unsigned long getDataTypeSubTypeClassID() const;
      //-----------------------------------------------------------------------
      std::string getDataTypeInfo() const;
      //-----------------------------------------------------------------------
      bool isCrossreferenceType() const;
      //-----------------------------------------------------------------------
      bool isCrossreferenceType( unsigned long & rulBaseID ) const;
      //-----------------------------------------------------------------------
      bool isCrossreferenceType( std::string & rsCrossRefFileName ) const;
      //-----------------------------------------------------------------------
      bool isNum() const;
      //-----------------------------------------------------------------------
      int getSignificantCharacter() const;
      //-----------------------------------------------------------------------
      std::string getTypeAsCppString() const;
      //-----------------------------------------------------------------------
      std::string getTypeAsString() const;
      //-----------------------------------------------------------------------
      EnDataTypeGroup getInfoType();
      //-----------------------------------------------------------------------
      std::string formatAnIndexString(  const std::string & rsStringToBeFormatted,
                                        const std::vector< eut::LanguageFunctions::EnLanguageKey > & rLanguageKeys,
                                        bool bCaseSensitive,
                                        void * pIndexAttributeItem ) const;
      //-----------------------------------------------------------------------
      std::string formatAnSearchIndexString(  const std::string & rsStringToBeFormatted,
                                              const std::vector< eut::LanguageFunctions::EnLanguageKey > & rLanguageKeys,
                                              bool bCaseSensitive,
                                              void * pIndexAttributeItem ) const;
      //-----------------------------------------------------------------------
 
    public:
      //============== Developer Methoden
      //-----------------------------------------------------------------------
      void setDeveloperAccessControl( const std::string & rsAccessControl );
      //-----------------------------------------------------------------------
      std::string getDeveloperAccessControl() const;
      //-----------------------------------------------------------------------
 
      //============== Debug-Methoden
      //-----------------------------------------------------------------------
      #ifdef _DEBUG
      std::string _DEBUG_ToString();
      #endif
      //-----------------------------------------------------------------------
 
    private:
      //============== Methoden
      //-----------------------------------------------------------------------
      std::string formatAnyIndexString( const std::string & rsStringToBeFormatted,
                                        const std::vector< eut::LanguageFunctions::EnLanguageKey > & rLanguageKeys,
                                        bool bCaseSensitive,
                                        bool bIsSearchString,
                                        void * pIndexAttributeItem ) const;
      //-----------------------------------------------------------------------
      // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
      // Is a reference to the GlobalObjects documentation.
      //-----------------------------------------------------------------------
      void convertAttributeType( const std::string & rsType,
                                 const std::string & rsTypeInfo );
      //-----------------------------------------------------------------------
 
    public:
      //============== static Methoden
      //-----------------------------------------------------------------------
      static int getRecordAttributeLimits( const ClassInfoAttribute::Type & rDataType,
                                           std::string & rsMin,
                                           std::string & rsMax,
                                           std::string & rsDataFieldSize );
      //-----------------------------------------------------------------------
      static EnDataType getTypeFromString( const std::string & rsType );
      //-----------------------------------------------------------------------
      static std::string getTypeAsString( EnDataType eType,
                                          bool bSimple = true );
      //-----------------------------------------------------------------------
      static std::string getTypeAsCppString( EnDataType eType,
                                             const std::string & rsSubType );
      //-----------------------------------------------------------------------
      static EnDataTypeGroup getInfoType( EnDataType eType );
      //-----------------------------------------------------------------------
      static unsigned int getDataTypesCount();
      //-----------------------------------------------------------------------
      static bool isNum( EnDataType eDataType );
      //-----------------------------------------------------------------------
      static int getSignificantCharacter( EnDataType eDataType );
      //-----------------------------------------------------------------------
 
      //============== Operatoren
      //-----------------------------------------------------------------------
 
      bool operator== ( const ClassInfoAttribute & rT ) const;
      bool operator!= ( const ClassInfoAttribute & rT ) const;
      //-----------------------------------------------------------------------
      ClassInfoAttribute & operator= ( const ClassInfoAttribute & rT );
      //-----------------------------------------------------------------------
  };
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( default : 4251 )
  #endif
  //---------------------------------------------------------------------------
} // namespace glo
#endif