AllSet, which returns generic objects. More...
#include <GloGenericAllSet.h>
Public Member Functions | |
GenericAllSet () | |
GenericAllSet (Base &rBase) | |
GenericAllSet (Base &rBase, unsigned long ulClassID, bool bWithSubClasses=true) | |
GenericAllSet (Base &rBase, unsigned long ulClassID, const std::string &rsFullIndexName) | |
virtual | ~GenericAllSet () |
int | get (GenericPersistent *&prRetVal, EnSeekMode eMode) |
int | get (ObjID &rObjID, GenericPersistent *&prRetVal, EnSeekMode eMode) |
int | get (ObjID &rObjID, std::shared_ptr< GenericPersistent > &rRetVal, EnSeekMode eMode) |
int | get (std::shared_ptr< GenericPersistent > &rRetVal, const ObjID &rObjID) |
int | get (std::shared_ptr< GenericPersistent > &rRetVal, EnSeekMode eMode) |
virtual void | setClassID (unsigned long ulClassID) |
virtual int | setWatch (TdWatchNotifyMode ulWatchMode, CallBack *pCallBack=0) |
virtual int | unsetWatch (TdWatchNotifyMode ulWatchMode, CallBack *pCallBack=0) |
virtual int | getPersistent (BasePersistent *&prRetVal, const ObjID &rObjID) |
Returns an object from the AllSet of the database with passed object ID. | |
int | get (GenericPersistent *&prRetVal, const ObjID &rObjID) |
Returns an object from the AllSet of the database with passed object ID. | |
![]() | |
BaseAllSet () | |
BaseAllSet (Base &rBase) | |
BaseAllSet (Base &rBase, unsigned long ulClassID, bool bWithSubClasses=true) | |
BaseAllSet (Base &rBase, unsigned long ulClassID, const std::string &rsFullIndexName) | |
virtual | ~BaseAllSet () |
int | close () |
std::vector< AllSetIndexInfo > | getAvailableIndices () |
std::size_t | getAvailableIndicesSize () |
virtual Base * | getBase () const override |
unsigned long | getClassID () const |
std::string | getFullIndexName () const |
unsigned long | getIndexClassID () const |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsFullIndexName, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp) |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsFullIndexName, const std::string &rsIndexSearchValue, EnQueryType eQuerryType) |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsFullIndexName, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue) |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp) |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsIndexSearchValue, EnQueryType eQuerryType) |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue) |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp) |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexSearchValue, EnQueryType eQuerryType) |
int | getIndexedObjIds (std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue) |
std::string | getIndexName () const |
int | getObjID (glo::ObjID &rObjID, EnSeekMode eMode) |
virtual int | getTypeAsString (std::string &rsTypeName) override |
virtual bool | inLot (const glo::ObjID &rObjID) const override |
virtual bool | inSet (const glo::ObjID &rObjID) const |
bool | isIndexAvailable (const BaseAllSet::IndexNameClassIdTuple &rIndexNameClassIdTuple) |
bool | isIndexAvailable (const std::string &rsFullIndexName) |
bool | isIndexAvailable (unsigned long ulClassID, const std::string &rsIndexName) |
int | open () |
bool | readWithSubClasses () const |
int | removeIndexFilter () |
virtual int | setBase (Base &rBase) |
virtual int | setBase (Base *pBase) override |
virtual int | setCurrentObject (const glo::ObjID &rObjID) override |
int | setFullIndexName (const std::string &rsFullIndexName) |
int | setIndex (const BaseAllSet::IndexNameClassIdTuple &rIndexNameClassIdTuple) |
int | setIndexFilter (const std::string &rsIndexFilter) |
int | setIndexFilter (const std::string &rsIndexFilter, EnComparisionOp eComparisionOp) |
int | setIndexFilter (const std::string &rsRangeStartIndexFilter, const std::string &rsRangeEndIndexFilter) |
virtual int | setPosition (std::size_t nPosition) override |
void | setReadWithSubClasses (bool bWithSubClasses) |
virtual std::size_t | size () const override |
![]() | |
AbstractBaseLot () | |
virtual | ~AbstractBaseLot () |
virtual int | getPersistent (std::shared_ptr< BasePersistent > &rRetVal, const ObjID &rObjID) |
virtual int | setCurrentObject (const BasePersistent &rObject) |
![]() | |
CallBack () | |
virtual | ~CallBack () |
virtual void | notify (NotifyNote &rNote) |
CallBack & | operator= (const CallBack &rT) |
bool | operator== (const CallBack &rT) const |
Comparison operator, all attributes are compared. | |
bool | operator!= (const CallBack &rT) const |
Comparison operator, all attributes are compared. | |
Private Member Functions | |
GenericAllSet (const GenericAllSet &) | |
GenericAllSet & | operator= (const GenericAllSet &) |
Additional Inherited Members | |
![]() | |
std::string | m_strDebugInfo |
![]() | |
void | setAllSetOpen (bool bOpen) |
int | setAvailableIndices () |
void | setClassIDFromTemplate (unsigned long ulClassID) |
![]() | |
CallBack (const CallBack &rT) | |
void | deinit () |
void | init () |
AllSet, which returns generic objects.
AllSets contains all instances of an object type in the database.
When an object of this class is instantiated and opened (only works with a valid database), the Manager creates an iterator that allows iteration through the internal AllSet. In the destructor the Manager is notified, which destroys the iterator again.
glo::GenericAllSet::GenericAllSet | ( | ) |
Standard constructor.
Referenced by GenericAllSet(), and operator=().
glo::GenericAllSet::GenericAllSet | ( | Base & | rBase | ) |
Constructor with parameter passing.
[in] | rBase | The authoritative database is passed. |
eut::ErrorNException | An exception is thrown if an error occurs. |
References glo::BaseAllSet::Base.
glo::GenericAllSet::GenericAllSet | ( | Base & | rBase, |
unsigned long | ulClassID, | ||
bool | bWithSubClasses = true ) |
Constructor with parameter passing.
[in] | rBase | The authoritative database is passed. |
[in] | ulClassID | A generic AllSet must know which object type is involved. This is guaranteed by the class ID from the schema. |
[in] | bWithSubClasses | If false, only objects with the class ID from m_ulClassID without subclasses are considered. |
eut::ErrorNException | An exception is thrown if an error occurs. |
eut::ErrorNException | Bei einem Fehler wird eine Exception geworfen. |
References glo::BaseAllSet::Base.
glo::GenericAllSet::GenericAllSet | ( | Base & | rBase, |
unsigned long | ulClassID, | ||
const std::string & | rsFullIndexName ) |
Constructor with parameter passing.
[in] | rBase | The authoritative database is passed. |
[in] | ulClassID | The class ID. |
[in] | rsFullIndexName | An AllSet can be sorted by an index. The index name must be passed preceded by the full class name (e.g. "mynamespace::MyClassName.IndexName"). |
eut::ErrorNException | An exception is thrown if an error occurs. |
References glo::BaseAllSet::Base.
|
virtual |
Destructor.
|
private |
The copy constructor is not available.
References GenericAllSet().
int glo::GenericAllSet::get | ( | GenericPersistent *& | prRetVal, |
const ObjID & | rObjID ) |
Returns an object from the AllSet of the database with passed object ID.
[in,out] | prRetVal | If no error, the fetched object. |
[in] | rObjID | The object ID. |
int glo::GenericAllSet::get | ( | GenericPersistent *& | prRetVal, |
EnSeekMode | eMode ) |
Returns a generic object from the AllSet of the referenced database in relation to eMode.
[in,out] | prRetVal | The object if found. |
[in] | eMode | The seek mode. |
Parameter examples:
int glo::GenericAllSet::get | ( | ObjID & | rObjID, |
GenericPersistent *& | prRetVal, | ||
EnSeekMode | eMode ) |
Returns an object ID and if possible a generic object from the AllSet of the database in relation to eMode. This also allows iteration over read-locked objects (only the object ID is returned).
[in,out] | rObjID | The object ID. |
[in,out] | prRetVal | The object, if found. |
[in] | eMode | The seek mode. |
Parameter examples:
int glo::GenericAllSet::get | ( | ObjID & | rObjID, |
std::shared_ptr< GenericPersistent > & | rRetVal, | ||
EnSeekMode | eMode ) |
Returns an object ID and if possible a generic object in a std::shared_ptr from the AllSet of the database in relation to eMode. This also allows iteration over read-locked objects (only the object ID is returned).
[in,out] | rObjID | The object ID. |
[in,out] | rRetVal | The object in std::shared_ptr, if found. |
[in] | eMode | The seek mode. |
Parameter examples:
int glo::GenericAllSet::get | ( | std::shared_ptr< GenericPersistent > & | rRetVal, |
const ObjID & | rObjID ) |
Returns a generic object in a std::shared_ptr from the AllSet of the database with passed object ID.
[in,out] | rRetVal | If no error, the fetched object in a std::shared_ptr. |
[in] | rObjID | The object ID. |
int glo::GenericAllSet::get | ( | std::shared_ptr< GenericPersistent > & | rRetVal, |
EnSeekMode | eMode ) |
Returns a generic object in a std::shared_ptr from the AllSet of the referenced database in relation to eMode.
[in,out] | rRetVal | The object in std::shared_ptr, if found. |
[in] | eMode | The seek mode. |
Parameter examples:
|
virtual |
Returns an object from the AllSet of the database with passed object ID.
[in,out] | prRetVal | If no error, the fetched object. |
[in] | rObjID | The object ID. |
Implements glo::AbstractBaseLot.
|
private |
The assignment operator is not available.
References GenericAllSet().
|
virtual |
Sets the class ID. If another class ID already exists, the AllSet of the last class ID is closed.
eut::ErrorNException | An exception is thrown if an error occurs. |
Reimplemented from glo::BaseAllSet.
|
virtual |
The AllSet is monitored in the database.
[in] | ulWatchMode | The monitoring mode. Allowed surveillance modes:
|
[in] | pCallBack | The CallBack object that is notified via its method CallBack::notify(NotifyNote&). If no CallBack is passed, notify(NotifyNote&) is taken from this; in this case the method notify(NotifyNote&) should be overwritten in the respective derived class. |
Implements glo::BaseAllSet.
|
virtual |
Monitoring of the AllSet in the referenced database is cancelled.
[in] | ulWatchMode | The monitoring mode. Allowed surveillance modes:
|
[in] | pCallBack | The CallBack object, which should be notified via its method CallBack::notify(NotifyNote&). |
Implements glo::BaseAllSet.