GloClassInfo.h

Go to the documentation of this file.

#ifndef INC_GLOCLASSINFO_H
#define INC_GLOCLASSINFO_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#include <string>
#include <list>
#include <set>
#include <vector>
#include <map>
#include <memory>
#include "GloTypes.h"
//-----------------------------------------------------------------------------
namespace glo
{
  //---------------------------------------------------------------------------
  /* Forwards */
  class ClassInfoAttribute;
  class ClassInfoIndex;
  class AttributeID;
  class AllSetIndexInfo;
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( disable : 4251 )
  #endif
  //---------------------------------------------------------------------------
  class __glo_export_dll ClassInfo
  {
    private:
      //============== Friends
      //-----------------------------------------------------------------------
      friend class SchemaInterface;
      //-----------------------------------------------------------------------
 
    public:
      //-----------------------------------------------------------------------
      // >>>>>>>>>>>>>>>>>>>> SuperClassIdInfoTuple >>>>>>>>>>>>>>>>>>>>>>>>>>>>>
      //-----------------------------------------------------------------------
      class __glo_export_dll SuperClassIdInfoTuple
      {
        private:
          //============== Attribute
          //---------------------------------------------------------------------
          unsigned long m_ulClassID;
          //---------------------------------------------------------------------
          std::string m_sSuperClassInfo;
          //---------------------------------------------------------------------
 
        public:
          //============== Konstruktoren
          //---------------------------------------------------------------------
          SuperClassIdInfoTuple();
          //---------------------------------------------------------------------
          SuperClassIdInfoTuple( unsigned long ulClassID );
          //---------------------------------------------------------------------
          SuperClassIdInfoTuple( const std::string & rsSuperClassInfo );
          //---------------------------------------------------------------------
          SuperClassIdInfoTuple( unsigned long ulClassID,
                                 const std::string & rsSuperClassInfo );
          //---------------------------------------------------------------------
          SuperClassIdInfoTuple( const SuperClassIdInfoTuple & rT );
          //---------------------------------------------------------------------
          ~SuperClassIdInfoTuple();
          //---------------------------------------------------------------------
 
          //============== Methoden
          //---------------------------------------------------------------------
          void setClassID (unsigned long ulClassID);
          //---------------------------------------------------------------------
          unsigned long getClassID ();
          //---------------------------------------------------------------------
          void setSuperClassInfo (const std::string & rsSuperClassInfo);
          //---------------------------------------------------------------------
          std::string getSuperClassInfo () const;
          //---------------------------------------------------------------------
 
          //---------------------------------------------------------------------
 
          bool operator== ( SuperClassIdInfoTuple & rT ) const;
          bool operator!= ( SuperClassIdInfoTuple & rT ) const;
          //---------------------------------------------------------------------
          ClassInfo::SuperClassIdInfoTuple & operator= ( SuperClassIdInfoTuple & rT );
          //---------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      // <<<<<<<<<<<<<<<<<<<<< SuperClassIdInfoTuple <<<<<<<<<<<<<<<<<<<<<<<<<<<<
      //-----------------------------------------------------------------------
 
    private:
      //============== Attributes
      //-----------------------------------------------------------------------
      std::string m_sName;
      //-----------------------------------------------------------------------
      std::string m_sSchemaName;
      //-----------------------------------------------------------------------
      unsigned long m_ulClassID;
      //-----------------------------------------------------------------------
      std::string m_sSuperClasses;
      //-----------------------------------------------------------------------
      std::string m_sSuperClassesInfo;
      //-----------------------------------------------------------------------
      std::list< ClassInfoAttribute *> m_AttributeList;
      //-----------------------------------------------------------------------
      std::list< ClassInfoAttribute * >::iterator m_AttributeListIterator;
      //-----------------------------------------------------------------------
      std::list<ClassInfoIndex *> m_IndexList;
      //-----------------------------------------------------------------------
      std::list< ClassInfoIndex * >::iterator m_IndexListIterator;
      //-----------------------------------------------------------------------
      std::list<ClassInfo *> m_SubClassInfoList;
      //-----------------------------------------------------------------------
 
      //============== Developer attributes
      //-----------------------------------------------------------------------
      std::string m_sFileName;
      //-----------------------------------------------------------------------
      std::string m_sFileDescription;
      //-----------------------------------------------------------------------
      std::string m_sClassDescription;
      //-----------------------------------------------------------------------
      std::string m_sClassModifier;
      //-----------------------------------------------------------------------
 
    public:
      //============= constructors
      //-----------------------------------------------------------------------
      ClassInfo ();
      //-----------------------------------------------------------------------
      ClassInfo(  const std::string & rsSchemaName,
                  const std::string & rsName,
                  unsigned long ulClassID,
                  const std::string & rsSuperClasses,
                  const std::string & rsSuperClassesInfo );
      //-----------------------------------------------------------------------
      ClassInfo (const ClassInfo & rT);
      //-----------------------------------------------------------------------
      virtual ~ClassInfo();
      //-----------------------------------------------------------------------
 
      //============== methods
      //-----------------------------------------------------------------------
      void setSchemaName( const std::string & rsSchemaName );
      //-----------------------------------------------------------------------
      std::string getSchemaName() const;
      //-----------------------------------------------------------------------
      void setName( const std::string & rsName );
      //-----------------------------------------------------------------------
      std::string getName() const;
      //-----------------------------------------------------------------------
      std::string getClassName() const;
      //-----------------------------------------------------------------------
      void getNamespaces( std::vector<std::string> & rNamespaces ) const;
      //-----------------------------------------------------------------------
      void setClassID( unsigned long ulClassID );
      //-----------------------------------------------------------------------
      unsigned long getClassID() const;
      //-----------------------------------------------------------------------
 
      //============== superclass methods
      //-----------------------------------------------------------------------
      void setSuperClasses( const std::string & rsSuperClasses );
      //-----------------------------------------------------------------------
      std::string getSuperClasses() const;
      //-----------------------------------------------------------------------
      void setSuperClassesInfo( const std::string & rsSuperClassesInfo );
      //-----------------------------------------------------------------------
      std::string getSuperClassesInfo() const;
      //-----------------------------------------------------------------------
      bool isDirectSubclassOf( unsigned long ulSuperClassID ) const;
      //-----------------------------------------------------------------------
      void getSuperClasses( std::vector<unsigned long> & rSuperClassIdVector ) const;
      //-----------------------------------------------------------------------
      void getSuperClassesInfo( std::vector<std::string> & rSuperClassesInfoVector ) const;
      //-----------------------------------------------------------------------
      void getSuperClassesInfoTuples( std::vector< std::shared_ptr<SuperClassIdInfoTuple> > & rSuperClassesInfoTuplesVector ) const;
      //-----------------------------------------------------------------------
      void setSuperClassesInfoTuples( const std::vector< std::shared_ptr<SuperClassIdInfoTuple> > & rSuperClassesInfoTuplesVector );
      //-----------------------------------------------------------------------
 
      //============== Attribut-Methoden
      //-----------------------------------------------------------------------
      int takeOverAttribute( ClassInfoAttribute * pAttribute );
      //-----------------------------------------------------------------------
      ClassInfoAttribute * getAttribute( EnSeekMode eMode );
      //-----------------------------------------------------------------------
      std::size_t getNumberOfAttributes() const;
      //-----------------------------------------------------------------------
      ClassInfoAttribute * getAttributeByName( const std::string & rsName ) const;
      //-----------------------------------------------------------------------
      ClassInfoAttribute * getAttributeByFieldName( const std::string & rsTableName,
                                                    const std::string & rsFieldName ) const;
      //-----------------------------------------------------------------------
      ClassInfoAttribute * getAttributeByID( const AttributeID & rAttributeID ) const;
      //-----------------------------------------------------------------------
      bool attributeExisting( ClassInfoAttribute * pAttribute ) const;
      //-----------------------------------------------------------------------
      bool attributeExisting( const std::string & rsAttributeName ) const;
      //-----------------------------------------------------------------------
      int attributeFieldNameExisting (const std::string & rsAttributeFieldName);
      //-----------------------------------------------------------------------
      int removeAttribute( ClassInfoAttribute * pAttribute, bool bDelete = false );
      //-----------------------------------------------------------------------
      void deleteAllInfoAttributes();
      //-----------------------------------------------------------------------
      std::string getTableNameFirstAttribute() const;
      //-----------------------------------------------------------------------
      void getAllClassMemberNamesSortByID( std::map< AttributeID, std::string> & rRetValMap ) const;
      //-----------------------------------------------------------------------
      void getAllAttributesSortByFieldPos(  std::map< int, ClassInfoAttribute *,
                                            std::less<int> > & rRetValMap ) const;
      //-----------------------------------------------------------------------
      std::string getAllAttributeFildNamesAsColumnRow( char cColumnDelimiter = g_cTableColumnDelimiter ) const;
      //-----------------------------------------------------------------------
      void setAllAttributesTableName( const std::string & rsTableName ) const;
      //-----------------------------------------------------------------------
 
      //============== Index-Methoden
      //-----------------------------------------------------------------------
      int takeOverIndex( ClassInfoIndex * pIndex );
      //-----------------------------------------------------------------------
      ClassInfoIndex * getIndex( EnSeekMode eMode );
      //-----------------------------------------------------------------------
      std::size_t getNumberOfIndexes() const;
      //-----------------------------------------------------------------------
      ClassInfoIndex * getIndexFromName( const std::string & rsIndexName ) const;
      //-----------------------------------------------------------------------
      void getIndexes( std::vector< AllSetIndexInfo > & rIndexes ) const;
      //-----------------------------------------------------------------------
      int indexExisting( ClassInfoIndex * pIndex ) const;
      //-----------------------------------------------------------------------
      int indexExisting( const std::string & rsIndexName ) const;
      //-----------------------------------------------------------------------
      int removeIndex( ClassInfoIndex * pIndex, bool bDelete = false );
      //-----------------------------------------------------------------------
      void deleteAllInfoIndexes();
      //-----------------------------------------------------------------------
 
      //============== SubClass Methoden
      //-----------------------------------------------------------------------
      bool asSubClassAvailable( unsigned long ulSubClassID ) const;
      //-----------------------------------------------------------------------
      void insertSubClassInfo( ClassInfo * pSubClassInfo );
      //-----------------------------------------------------------------------
      std::list< ClassInfo * > & getSubClassInfos();
      //-----------------------------------------------------------------------
      void removeSubClassInfo( unsigned long ulClassID );
      //-----------------------------------------------------------------------
 
      //============== Developer Methoden
      //-----------------------------------------------------------------------
      void setFileName( const std::string & rsFileName );
      //-----------------------------------------------------------------------
      std::string getFileName() const;
      //-----------------------------------------------------------------------
      void setFileDescription( const std::string & rstrFileDescription );
      //-----------------------------------------------------------------------
      std::string getFileDescription() const;
      //-----------------------------------------------------------------------
      void setClassDescription( const std::string & rstrClassDescription );
      //-----------------------------------------------------------------------
      std::string getClassDescription() const;
      //-----------------------------------------------------------------------
      void setClassModifier( const std::string & rstrClassModifier );
      //-----------------------------------------------------------------------
      std::string getClassModifier() const;
      //-----------------------------------------------------------------------
 
    private:
      //============== Methoden
      //-----------------------------------------------------------------------
      void copyAttributListFrom( const ClassInfo & rT );
      //-----------------------------------------------------------------------
      void copyIndexListFrom( const ClassInfo & rT );
      //-----------------------------------------------------------------------
 
    public:
      //============== Debug-Methoden
      //-----------------------------------------------------------------------
      #ifdef _DEBUG
      std::string _DEBUG_ToString();
      #endif
      //-----------------------------------------------------------------------
 
      //============== Operatoren
      //-----------------------------------------------------------------------
      ClassInfo & operator= ( const ClassInfo & rT );
      //-----------------------------------------------------------------------
  };
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( default : 4251 )
  #endif
  //---------------------------------------------------------------------------
} // namespace glo
#endif