GlobalObjects
Loading...
Searching...
No Matches
GloBasePersistent.h
Go to the documentation of this file.
1#ifndef INC_GLOBASEPERSISTENT_H
2#define INC_GLOBASEPERSISTENT_H
3//-----------------------------------------------------------------------------
43//-----------------------------------------------------------------------------
44#include <list>
45#include <vector>
46#include <map>
47#include "GloTypes.h"
48#include "GloCallBack.h"
49#include "GloLockSpecification.h"
50#include "GloWatchSpecification.h"
51#if defined (__PTHREADS)
52 #include <EuPCriticalSection.h>
53#else
54 #include "EuCriticalSection.h"
55#endif
56#include <ctime>
57#include <memory>
58//-----------------------------------------------------------------------------
59namespace glo
60{
61 //---------------------------------------------------------------------------
62 /* Forwards */
63 class Record;
64 class ClassInfo;
65 class AttributeID;
66 class BaseRecordAttribute;
67 //---------------------------------------------------------------------------
68 #ifdef _MSC_VER
69 /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
70 #pragma warning( disable : 4251 )
71 #endif
72 //---------------------------------------------------------------------------
123 class __glo_export_dll BasePersistent : public CallBack
124 {
125 //============== Friends
126 //-----------------------------------------------------------------------
135 friend class PrivateBase;
136 //-----------------------------------------------------------------------
137
138 protected:
139 //============== Attribute
140 //-----------------------------------------------------------------------
150 Base * m_pBase;
151 //-----------------------------------------------------------------------
161 unsigned int m_uiReferenceCount;
162 //-----------------------------------------------------------------------
176 #if defined (__PTHREADS)
177 EuPCriticalSection m_LocalCriticalSection;
178 #else
179 eut::CriticalSection m_LocalCriticalSection;
180 #endif
181 //-----------------------------------------------------------------------
193 Record * m_pRecord;
194 //-----------------------------------------------------------------------
216 bool m_bSpyaction;
217 //-----------------------------------------------------------------------
218
219 public:
220 //============= ctor
221 //-----------------------------------------------------------------------
231 BasePersistent();
232 //-----------------------------------------------------------------------
233
234 protected:
235 //============== dtor
236 //-----------------------------------------------------------------------
252 virtual ~BasePersistent();
253 //-----------------------------------------------------------------------
254
255 public:
256 //============= Copy ctor
257 //-----------------------------------------------------------------------
271 BasePersistent( const BasePersistent & rT );
272 //-----------------------------------------------------------------------
273
274 //============== Methoden
275 //-----------------------------------------------------------------------
296 virtual int setBase( Base * pBase ) override;
297 //-----------------------------------------------------------------------
312 virtual Base * getBase() const override;
313 //-----------------------------------------------------------------------
323 virtual void removeBase();
324 //-----------------------------------------------------------------------
342 virtual int getClassInfo( ClassInfo *& prClassInfo );
343 //-----------------------------------------------------------------------
357 virtual int getTypeAsString( std::string & rsTypeName ) override;
358 //-----------------------------------------------------------------------
370 virtual std::time_t getCreateDate() const = 0;
371 //-----------------------------------------------------------------------
383 virtual std::time_t getLastChangeDate() const = 0;
384 //-----------------------------------------------------------------------
406 virtual unsigned int remember();
407 //-----------------------------------------------------------------------
431 virtual unsigned int forget();
432 //-----------------------------------------------------------------------
460 virtual int assign( Base & rBase );
461 //-----------------------------------------------------------------------
471 virtual bool isAssigned() const;
472 //-----------------------------------------------------------------------
483 unsigned int getLinkCount() const;
484 //-----------------------------------------------------------------------
494 virtual ObjID getObjID() const;
495 //-----------------------------------------------------------------------
519 int getRecord( Record *& prRecord ) const;
520 //-----------------------------------------------------------------------
534 int getRecord( std::shared_ptr<Record> & rRetVal ) const;
535 //-----------------------------------------------------------------------
553 int getAllPersAttributeNames( std::list<std::string> & rRetValList,
554 const std::vector<unsigned long> * pClassIdVector = nullptr ) const;
555 //-----------------------------------------------------------------------
575 int getAllPersAttributeNamesSortByID( std::map< AttributeID, std::string> & rRetValMap,
576 const std::vector<unsigned long> * pClassIdVector = nullptr ) const;
577 //-----------------------------------------------------------------------
611 int getPersAttribute( BaseRecordAttribute *& prRetVal,
612 const std::string & sName ) const;
613 //-----------------------------------------------------------------------
634 int getPersAttribute( std::shared_ptr<BaseRecordAttribute> & rRetVal,
635 const std::string & sName ) const;
636 //-----------------------------------------------------------------------
666 int getPersAttribute( BaseRecordAttribute *& prRetVal,
667 const AttributeID & rAttributeID) const;
668 //-----------------------------------------------------------------------
686 int getPersAttribute( std::shared_ptr<BaseRecordAttribute> & rRetVal,
687 const AttributeID & rAttributeID ) const;
688 //-----------------------------------------------------------------------
720 int getAllPersAttributes( std::list< BaseRecordAttribute * > & rRetValList,
721 const std::vector<unsigned long> * pClassIdVector = nullptr ) const;
722 //-----------------------------------------------------------------------
742 int getAllPersAttributes( std::list< std::shared_ptr<BaseRecordAttribute> > & rRetValList,
743 const std::vector<unsigned long> * pClassIdVector = nullptr ) const;
744 //-----------------------------------------------------------------------
776 int getAllPersAttributesSortByName( std::map< std::string, BaseRecordAttribute *, std::less<std::string> > & rRetValMap,
777 const std::vector<unsigned long> * pClassIdVector = nullptr ) const;
778 //-----------------------------------------------------------------------
798 int getAllPersAttributesSortByName( std::map< std::string, std::shared_ptr<BaseRecordAttribute>, std::less<std::string> > & rRetValMap,
799 const std::vector<unsigned long> * pClassIdVector = nullptr ) const;
800 //-----------------------------------------------------------------------
834 int getAllPersAttributesSortByID( std::map< AttributeID, BaseRecordAttribute *, std::less<AttributeID> > & rRetValMap,
835 const std::vector<unsigned long> * pClassIdVector = nullptr ) const;
836 //-----------------------------------------------------------------------
858 int getAllPersAttributesSortByID( std::map< AttributeID, std::shared_ptr<BaseRecordAttribute>, std::less<AttributeID> > & rRetValMap,
859 const std::vector<unsigned long> * pClassIdVector = nullptr ) const;
860 //-----------------------------------------------------------------------
874 virtual void takeOverRecord( Record * pRecord );
875 //-----------------------------------------------------------------------
885 virtual unsigned long getGloClassID() const =0;
886 //-----------------------------------------------------------------------
906 virtual int store( EnDeepMode eDeepMode = DM_SHALLOW );
907 //-----------------------------------------------------------------------
921 virtual bool isStored();
922 //-----------------------------------------------------------------------
938 virtual int deleteInBase( EnDeepMode eDeepMode = DM_SHALLOW );
939 //-----------------------------------------------------------------------
957 virtual bool isDeletedInBase();
958 //-----------------------------------------------------------------------
976 virtual int refresh();
977 //-----------------------------------------------------------------------
1001 virtual int lock( EnLockMode eLockMode = LK_DELETEvWRITE,
1002 EnDeepMode eDeepMode = DM_SHALLOW );
1003 //-----------------------------------------------------------------------
1028 virtual int lock( const LockSpecification & rLockSpecification );
1029 //-----------------------------------------------------------------------
1061 virtual int lockAndRefresh( EnLockMode eLockMode = LK_DELETEvWRITE,
1062 EnDeepMode eDeepMode = DM_SHALLOW );
1063 //-----------------------------------------------------------------------
1096 virtual int lockAndRefresh( const LockSpecification & rLockSpecification );
1097 //-----------------------------------------------------------------------
1131 virtual int relock( EnLockMode eLockMode = LK_DELETEvWRITE,
1132 EnDeepMode eDeepMode = DM_SHALLOW );
1133 //-----------------------------------------------------------------------
1169 virtual int relock( const LockSpecification & rLockSpecification );
1170 //-----------------------------------------------------------------------
1212 virtual int relockAndRefresh( EnLockMode eLockMode = LK_DELETEvWRITE,
1213 EnDeepMode eDeepMode = DM_SHALLOW );
1214 //-----------------------------------------------------------------------
1258 virtual int relockAndRefresh( const LockSpecification & rLockSpecification );
1259 //-----------------------------------------------------------------------
1285 virtual int unlock( EnLockMode eLockMode = LK_DELETEvWRITE,
1286 EnDeepMode eDeepMode = DM_SHALLOW);
1287 //-----------------------------------------------------------------------
1314 virtual int unlock( const LockSpecification & rLockSpecification );
1315 //-----------------------------------------------------------------------
1316 //-----------------------------------------------------------------------
1317 // doxygen -> warning: unable to resolve reference to 'GLO_LOCKING_ASK_LOCK' for \ref command
1318 // doxygen -> warning: unable to resolve reference to 'GLO_LOCKING_OBJ' for \ref command
1319 // doxygen -> warning: unable to resolve reference to 'PAGE_GLO_WATCH_NOTIFY' for \ref command
1320 // are references to the GlobalObjects documentation.
1321 //-----------------------------------------------------------------------
1345 virtual int isLocked( EnLockMode eLockMode = LK_DELETEvWRITE,
1346 EnDeepMode eDeepMode = DM_SHALLOW ) const;
1347 //-----------------------------------------------------------------------
1368 virtual int isLocked( const LockSpecification & rLockSpecification ) const;
1369 //-----------------------------------------------------------------------
1393 virtual int isPossible( bool bRead,
1394 bool bWrite,
1395 bool bDelete,
1396 EnDeepMode eDeepMode = DM_SHALLOW ) const;
1397 //-----------------------------------------------------------------------
1417 virtual int isPossible( const LockPossibleSpecification & rLockPossibleSpec,
1418 EnDeepMode eDeepMode = DM_SHALLOW ) const;
1419 //-----------------------------------------------------------------------
1437 virtual int getProcessingPossibilities( LockPossibleSpecification & rLockPossibleSpec,
1438 EnDeepMode eDeepMode = DM_SHALLOW ) const;
1439 //-----------------------------------------------------------------------
1497 virtual int setWatch( TdWatchNotifyMode ulWatchMode,
1498 EnDeepMode eDeepMode,
1499 CallBack * pCallBack = nullptr );
1500 //-----------------------------------------------------------------------
1533 virtual int setWatch( const WatchSpecification & rWatchSpec );
1534 //-----------------------------------------------------------------------
1592 virtual int unsetWatch( TdWatchNotifyMode ulWatchMode,
1593 EnDeepMode eDeepMode,
1594 CallBack * pCallBack = nullptr );
1595 //-----------------------------------------------------------------------
1632 virtual int unsetWatch( const WatchSpecification & rWatchSpec );
1633 //-----------------------------------------------------------------------
1634
1635 protected:
1636 //============== Methoden
1637 //-----------------------------------------------------------------------
1649 virtual void insertInObjectSpy() const = 0;
1650 //-----------------------------------------------------------------------
1662 virtual void removeInObjectSpy() const = 0;
1663 //-----------------------------------------------------------------------
1673 virtual void setCreateDate() = 0;
1674 //-----------------------------------------------------------------------
1688 void setSpyaction( bool bSpyaction );
1689 //-----------------------------------------------------------------------
1690
1691 public:
1692 //============== Operatoren
1693 //-----------------------------------------------------------------------
1705 BasePersistent & operator= ( const BasePersistent & rT );
1706 //-----------------------------------------------------------------------
1708
1719 bool operator== ( const BasePersistent & rT ) const;
1720 bool operator!= ( const BasePersistent & rT ) const;
1722 //-----------------------------------------------------------------------
1723 };
1724 //---------------------------------------------------------------------------
1725 #ifdef _MSC_VER
1726 /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
1727 #pragma warning( default : 4251 )
1728 #endif
1729 //---------------------------------------------------------------------------
1730} // namespace glo
1731#endif
EuCriticalSection.h
Header for CriticalSection
EuPCriticalSection.h
Header for EuPCriticalSection
GloCallBack.h
Header for CallBack
GloLockSpecification.h
Header for LockSpecification
GloTypes.h
For each library, here 'GlobalObjects' there is a type file.
__glo_export_dll
#define __glo_export_dll
Definition GloTypes.h:70
GloWatchSpecification.h
Header for WatchSpecification
EuPCriticalSection
Is a mutex which can be queried via its lock mode. See isLocked().
Definition EuPCriticalSection.h:104
eut::CriticalSection
Is a mutex which can be queried via its lock mode. See isLocked().
Definition EuCriticalSection.h:109
glo::AttributeID
This class reflects a unique ID of a class information attribute.
Definition GloAttributeID.h:81
glo::Base
Definition GloBase.h:263
glo::BasePersistent::isPossible
virtual int isPossible(const LockPossibleSpecification &rLockPossibleSpec, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::BasePersistent::getProcessingPossibilities
virtual int getProcessingPossibilities(LockPossibleSpecification &rLockPossibleSpec, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::BasePersistent::lock
virtual int lock(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW)
glo::BasePersistent::isPossible
virtual int isPossible(bool bRead, bool bWrite, bool bDelete, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::BasePersistent::isAssigned
virtual bool isAssigned() const
glo::BasePersistent::getRecord
int getRecord(Record *&prRecord) const
glo::BasePersistent::relockAndRefresh
virtual int relockAndRefresh(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW)
glo::BasePersistent::forget
virtual unsigned int forget()
glo::BasePersistent::getAllPersAttributeNames
int getAllPersAttributeNames(std::list< std::string > &rRetValList, const std::vector< unsigned long > *pClassIdVector=nullptr) const
glo::BasePersistent::BasePersistent
BasePersistent(const BasePersistent &rT)
glo::BasePersistent::m_LocalCriticalSection
eut::CriticalSection m_LocalCriticalSection
Definition GloBasePersistent.h:179
glo::BasePersistent::assign
virtual int assign(Base &rBase)
glo::BasePersistent::unsetWatch
virtual int unsetWatch(const WatchSpecification &rWatchSpec)
glo::BasePersistent::isDeletedInBase
virtual bool isDeletedInBase()
glo::BasePersistent::getTypeAsString
virtual int getTypeAsString(std::string &rsTypeName) override
glo::BasePersistent::unsetWatch
virtual int unsetWatch(TdWatchNotifyMode ulWatchMode, EnDeepMode eDeepMode, CallBack *pCallBack=nullptr)
glo::BasePersistent::isLocked
virtual int isLocked(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::BasePersistent::getLastChangeDate
virtual std::time_t getLastChangeDate() const =0
glo::BasePersistent::getBase
virtual Base * getBase() const override
glo::BasePersistent::getPersAttribute
int getPersAttribute(std::shared_ptr< BaseRecordAttribute > &rRetVal, const std::string &sName) const
glo::BasePersistent::lockAndRefresh
virtual int lockAndRefresh(const LockSpecification &rLockSpecification)
glo::BasePersistent::unlock
virtual int unlock(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW)
glo::BasePersistent::getAllPersAttributes
int getAllPersAttributes(std::list< BaseRecordAttribute * > &rRetValList, const std::vector< unsigned long > *pClassIdVector=nullptr) const
glo::BasePersistent::unlock
virtual int unlock(const LockSpecification &rLockSpecification)
glo::BasePersistent::getLinkCount
unsigned int getLinkCount() const
glo::BasePersistent::setBase
virtual int setBase(Base *pBase) override
glo::BasePersistent::m_pBase
Base * m_pBase
Definition GloBasePersistent.h:150
glo::BasePersistent::setWatch
virtual int setWatch(TdWatchNotifyMode ulWatchMode, EnDeepMode eDeepMode, CallBack *pCallBack=nullptr)
glo::BasePersistent::setCreateDate
virtual void setCreateDate()=0
glo::BasePersistent::relock
virtual int relock(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW)
glo::BasePersistent::takeOverRecord
virtual void takeOverRecord(Record *pRecord)
glo::BasePersistent::getAllPersAttributeNamesSortByID
int getAllPersAttributeNamesSortByID(std::map< AttributeID, std::string > &rRetValMap, const std::vector< unsigned long > *pClassIdVector=nullptr) const
glo::BasePersistent::getRecord
int getRecord(std::shared_ptr< Record > &rRetVal) const
glo::BasePersistent::deleteInBase
virtual int deleteInBase(EnDeepMode eDeepMode=DM_SHALLOW)
glo::BasePersistent::getAllPersAttributesSortByName
int getAllPersAttributesSortByName(std::map< std::string, std::shared_ptr< BaseRecordAttribute >, std::less< std::string > > &rRetValMap, const std::vector< unsigned long > *pClassIdVector=nullptr) const
glo::BasePersistent::insertInObjectSpy
virtual void insertInObjectSpy() const =0
glo::BasePersistent::relockAndRefresh
virtual int relockAndRefresh(const LockSpecification &rLockSpecification)
glo::BasePersistent::remember
virtual unsigned int remember()
glo::BasePersistent::~BasePersistent
virtual ~BasePersistent()
glo::BasePersistent::m_bSpyaction
bool m_bSpyaction
Definition GloBasePersistent.h:216
glo::BasePersistent::lock
virtual int lock(const LockSpecification &rLockSpecification)
glo::BasePersistent::getAllPersAttributesSortByID
int getAllPersAttributesSortByID(std::map< AttributeID, std::shared_ptr< BaseRecordAttribute >, std::less< AttributeID > > &rRetValMap, const std::vector< unsigned long > *pClassIdVector=nullptr) const
glo::BasePersistent::setSpyaction
void setSpyaction(bool bSpyaction)
glo::BasePersistent::relock
virtual int relock(const LockSpecification &rLockSpecification)
glo::BasePersistent::getClassInfo
virtual int getClassInfo(ClassInfo *&prClassInfo)
glo::BasePersistent::getAllPersAttributesSortByID
int getAllPersAttributesSortByID(std::map< AttributeID, BaseRecordAttribute *, std::less< AttributeID > > &rRetValMap, const std::vector< unsigned long > *pClassIdVector=nullptr) const
glo::BasePersistent::isStored
virtual bool isStored()
glo::BasePersistent::getCreateDate
virtual std::time_t getCreateDate() const =0
glo::BasePersistent::removeBase
virtual void removeBase()
glo::BasePersistent::getPersAttribute
int getPersAttribute(std::shared_ptr< BaseRecordAttribute > &rRetVal, const AttributeID &rAttributeID) const
glo::BasePersistent::isLocked
virtual int isLocked(const LockSpecification &rLockSpecification) const
glo::BasePersistent::removeInObjectSpy
virtual void removeInObjectSpy() const =0
glo::BasePersistent::lockAndRefresh
virtual int lockAndRefresh(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW)
glo::BasePersistent::getPersAttribute
int getPersAttribute(BaseRecordAttribute *&prRetVal, const std::string &sName) const
glo::BasePersistent::getAllPersAttributesSortByName
int getAllPersAttributesSortByName(std::map< std::string, BaseRecordAttribute *, std::less< std::string > > &rRetValMap, const std::vector< unsigned long > *pClassIdVector=nullptr) const
glo::BasePersistent::m_uiReferenceCount
unsigned int m_uiReferenceCount
Definition GloBasePersistent.h:161
glo::BasePersistent::getGloClassID
virtual unsigned long getGloClassID() const =0
glo::BasePersistent::store
virtual int store(EnDeepMode eDeepMode=DM_SHALLOW)
glo::BasePersistent::m_pRecord
Record * m_pRecord
Definition GloBasePersistent.h:193
glo::BasePersistent::getPersAttribute
int getPersAttribute(BaseRecordAttribute *&prRetVal, const AttributeID &rAttributeID) const
glo::BasePersistent::setWatch
virtual int setWatch(const WatchSpecification &rWatchSpec)
glo::BasePersistent::getObjID
virtual ObjID getObjID() const
glo::BasePersistent::PrivateBase
friend class PrivateBase
Definition GloBasePersistent.h:135
glo::BasePersistent::getAllPersAttributes
int getAllPersAttributes(std::list< std::shared_ptr< BaseRecordAttribute > > &rRetValList, const std::vector< unsigned long > *pClassIdVector=nullptr) const
glo::BasePersistent::refresh
virtual int refresh()
glo::BaseRecordAttribute
Base class for the individual attributes of a Record.
Definition GloBaseRecordAttribute.h:116
glo::ClassInfo
This class contains all information to store objects of a class in a database, to build objects from ...
Definition GloClassInfo.h:86
glo::LockSpecification
To be able to lock objects, the 'lock mode' and the 'lock depth' are required as parameters....
Definition GloLockSpecification.h:65
glo::ObjID
An object ID consists of the class ID, a database ID and the actual unique object number (all unsigne...
Definition GloObjID.h:84
glo::Record
Objects of this class transport the data from the tables into the persistent object and from these ag...
Definition GloRecord.h:108
glo::WatchSpecification
To be able to watch objects, the 'watching mode', the 'watching depth' and the 'notification object' ...
Definition GloWatchSpecification.h:67
glo
Definition GloAbstractBaseLot.h:49
glo::EnDeepMode
EnDeepMode
Definition GloTypes.h:254
glo::DM_SHALLOW
@ DM_SHALLOW
Definition GloTypes.h:290
glo::EnLockMode
EnLockMode
Definition GloTypes.h:1055
glo::LK_DELETEvWRITE
@ LK_DELETEvWRITE
Definition GloTypes.h:1105
glo::TdWatchNotifyMode
unsigned long TdWatchNotifyMode
Definition GloTypes.h:558
glo::LockPossibleSpecification
Permitted actions in the database such as read, write and delete can be queried for an object....
Definition GloTypes.h:1256