An object of this class accesses tables and reads data records (Record) and binary files (eut::Blob). More...

#include <GloTableReaderInterface.h>

Inheritance diagram for glo::TableReaderInterface:

Classes
class	AllSetObjectStrIndexIteratorItem
	Objects of this type are managed in the m_pAllSetObjectStrIndexIteratorMap to ensure that an AllSet with index can be reopened in method TableReaderInterface::setTransactionIndexPool(TransactionIndexPool*). More...

Public Member Functions
	TableReaderInterface (const SchemaInterface &rScheme, RealIndexPool *pRealIndexPool)

virtual	~TableReaderInterface ()

int	closeAllSet (NUM_PTR ipClientAllSetAddress)

int	getAllObjIDs (std::list< ObjID > &rRetValList)

void	getAllTransactionIndexPools (std::vector< TransactionIndexPool * > &rTransactionIndexPoolVector) const

int	getIndexedObjIdListFromAllSet (std::vector< glo::ObjID > &rObjIDContainer, NUM_PTR ipClientAllSetAddress, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp) const

int	getIndexedObjIdListFromAllSet (std::vector< glo::ObjID > &rObjIDContainer, NUM_PTR ipClientAllSetAddress, const std::string &rsIndexSearchValue, EnQueryType eQuerryType) const

int	getIndexedObjIdListFromAllSet (std::vector< glo::ObjID > &rObjIDContainer, NUM_PTR ipClientAllSetAddress, const std::string &rsRangeStartIndex, const std::string &rsRangeEndIndex) const

int	getObjectData (Record &prRetVal, const ObjID &rObjID, ReaderInfo pReaderInfo)

int	getObjIdFromAllSet (ObjID &rObjID, NUM_PTR ipClientAllSetAddress, EnSeekMode eMode) const

int	getObjIDs (std::list< ObjID > &rRetValList, unsigned long ulClassID)

int	getObjIDs (std::map< ObjID, ObjID, std::less< ObjID > > &rRetValMap, unsigned long ulClassID)

RealIndexPool *	getRealIndexPool () const

int	getRecord (Record &prRetVal, const ObjID &rObjID, ReaderInfo pReaderInfo)

int	getSizeFromAllSet (std::size_t &rnSize, NUM_PTR ipClientAllSetAddress) const

TransactionIndexPool *	getTransactionIndexPool (const TransactionOwner &rCommunicatorWithTreadID) const

int	isAllSetOpen (NUM_PTR ipClientAllSetAddress) const

int	objIDInAllSet (const ObjID &rObjID, NUM_PTR ipClientAllSetAddress) const

int	openAllSet (const TransactionOwner &rCommunicatorWithTreadID, NUM_PTR ipClientAllSetAddress, unsigned long ulClassID, bool bWithSubClasses)

int	openAllSet (const TransactionOwner &rCommunicatorWithTreadID, NUM_PTR ipClientAllSetAddress, unsigned long ulClassID, const std::string &rsIndexName)

virtual int	openTable (const std::string &sTableName)

void	refreshAllTables ()

int	removeFilterInAllSet (NUM_PTR ipClientAllSetAddress) const

int	setCurrentObjectInAllSet (const ObjID &rObjID, NUM_PTR ipClientAllSetAddress) const

int	setFilterInAllSet (NUM_PTR ipClientAllSetAddress, const std::string &rsIndexFilterValue) const

int	setFilterInAllSet (NUM_PTR ipClientAllSetAddress, const std::string &rsIndexFilterValue, EnComparisionOp eComparisionOp) const

int	setFilterInAllSet (NUM_PTR ipClientAllSetAddress, const std::string &rsRangeStartIndex, const std::string &rsRangeEndIndex) const

int	setPositionInAllSet (std::size_t nPosition, NUM_PTR ipClientAllSetAddress) const

int	setTransactionIndexPool (const TransactionOwner &rCommunicatorWithTreadID, TransactionIndexPool *pTransactionIndexPool)

Public Member Functions inherited from glo::TableInterface
	TableInterface (const SchemaInterface &rScheme, RealIndexPool *pRealIndexPool)

virtual	~TableInterface ()

virtual int	closeTable (const std::string &sTable)

std::string	getDataPath () const

int	getObjIDRecordAttribute (ObjIDRecordAttribute *&prRetVal, const std::string &sTable, const ObjID &rObjID)

SchemaInterface &	getSchemaInterface ()

std::string	getSchemaPath () const

int	objIDInBase (bool &rPresent, const ObjID &rObjID) const

Protected Member Functions
	TableReaderInterface ()

int	generateRecord (Record *&prRetVal, const std::string &sDataRow, ClassInfo &rClassInfo, std::streampos StreamPosRow, bool bOnlyClassIDTable=false)

int	generateRecord (Record *&prRetVal, const std::string &sFieldNameRow, const std::string &sDataRow, std::streampos StreamPosRow, const std::string &rsTable, bool bOnlyClassIDTable=false)

int	getObjectData (Record &prRetVal, const ObjID &rObjID, ReaderInfo pReaderInfo, bool bInRecursion)

int	getObjectDataFromDataRow (Record *&prRetVal, const ObjID &rObjID, unsigned long ulClassID, bool bOnlyClassIDTable=false)

int	getObjectDataFromDataRow (std::shared_ptr< Record > &sprRetVal, const ObjID &rObjID, unsigned long ulClassID, bool bOnlyClassIDTable=false)

int	getObjIDs (std::list< ObjID > pRetValList, std::map< ObjID, ObjID, std::less< ObjID > > pRetValMap, unsigned long ulClassID)

int	getRecord (Record *&prRetVal, const ObjID &rObjID, ClassInfo &rClassInfo, bool bOnlyClassIDTable=false)

int	getRecord (Record *&prRetVal, const std::string &sTableName, const ObjID &rObjID, unsigned long ulClassID, bool bOnlyClassIDTable=false)

IndexPool::TableObjIdIndexIterator *	openAllSet (int &riErr, const TransactionOwner &rCommunicatorWithTreadID, NUM_PTR ipClientAllSetAddress, unsigned long ulClassID, bool bWithSubClasses=true)

IndexPool::ObjectStrIndexIterator *	openAllSet (int &riErr, const TransactionOwner &rCommunicatorWithTreadID, NUM_PTR ipClientAllSetAddress, unsigned long ulClassID, const std::string &rsIndexName)

Protected Member Functions inherited from glo::TableInterface
	TableInterface ()

int	openFile (std::fstream *&prFStream, const std::string &sFullFileName, std::ios_base::openmode OpenMode)

Private Member Functions
	TableReaderInterface (const TableReaderInterface &)

void	deleteAllSetObjectStrIndexIteratorMap (std::unordered_map< NUM_PTR, AllSetObjectStrIndexIteratorItem * > *pMapToDelete)

void	deleteAllSetTableObjIdIndexIteratorMap (std::unordered_map< NUM_PTR, IndexPool::TableObjIdIndexIterator * > *pMapToDelete)

TableInterface &	operator= (const TableInterface &)

Private Attributes
std::unordered_map< NUM_PTR, AllSetObjectStrIndexIteratorItem * > *	m_pAllSetObjectStrIndexIteratorMap

std::unordered_map< NUM_PTR, IndexPool::TableObjIdIndexIterator * > *	m_pAllSetTableObjIdIndexIteratorMap

std::unordered_map< TransactionOwner, TransactionIndexPool *, glo::TransactionOwner::HashFunction >	m_pTransactionIndexPools

std::unordered_map< ObjID, Record *, glo::ObjID::HashFunction >	m_RecursionRecordMap

Additional Inherited Members
Protected Attributes inherited from glo::TableInterface
std::unordered_map< std::string, TableInterfaceTable * >	m_OpenTableMap

RealIndexPool *	m_pRealIndexPool

SchemaInterface *	m_pSchema

Detailed Description

An object of this class accesses tables and reads data records (Record) and binary files (eut::Blob).

All tables known to the schema are opened when instantiating, and closed again when destroying.

Copyright: © 2010 Helmut Jakoby

Author: Helmut Jakoby

Constructor & Destructor Documentation

◆ TableReaderInterface() [1/3]

glo::TableReaderInterface::TableReaderInterface ( )

protected

The default constructor is not available.

◆ TableReaderInterface() [2/3]

glo::TableReaderInterface::TableReaderInterface	(	const SchemaInterface &	rScheme,
		RealIndexPool *	pRealIndexPool )

Constructor with parameter passing.

Parameters

[in]	rScheme	Cannot be used without schema, will be copied.
[in]	pRealIndexPool	Accelerates the access to records.

Exceptions

eut::ErrorNException An exception is thrown if an error occurs.

◆ ~TableReaderInterface()

virtual glo::TableReaderInterface::~TableReaderInterface ( )

virtual

Destructor, all open table files are closed and the memory is cleaned up.

◆ TableReaderInterface() [3/3]

glo::TableReaderInterface::TableReaderInterface ( const TableReaderInterface & )

private

The copy constructor is not available.

Member Function Documentation

◆ closeAllSet()

int glo::TableReaderInterface::closeAllSet ( NUM_PTR ipClientAllSetAddress )

Closes an AllSet with the passed Client-AllSet address.

Parameters

[in] ipClientAllSetAddress The client AllSet address.

Returns: A return value < 0 indicates an error.

◆ deleteAllSetObjectStrIndexIteratorMap()

void glo::TableReaderInterface::deleteAllSetObjectStrIndexIteratorMap ( std::unordered_map< NUM_PTR, AllSetObjectStrIndexIteratorItem * > * pMapToDelete )

private

Deletes the objects in the passed AllSetObjectStrIndexIteratorMap and the objects themselves.

Parameters

[in] pMapToDelete The map to be deleted.

Note: The passed map is no longer valid.

◆ deleteAllSetTableObjIdIndexIteratorMap()

void glo::TableReaderInterface::deleteAllSetTableObjIdIndexIteratorMap ( std::unordered_map< NUM_PTR, IndexPool::TableObjIdIndexIterator * > * pMapToDelete )

private

Deletes the objects in the passed AllSetTableObjIdIndexIteratorMap and the objects themselves.

Parameters

[in] pMapToDelete The map to be deleted.

Note: The passed map is no longer valid.

◆ generateRecord() [1/2]

int glo::TableReaderInterface::generateRecord	(	Record *&	prRetVal,
		const std::string &	sDataRow,
		ClassInfo &	rClassInfo,
		std::streampos	StreamPosRow,
		bool	bOnlyClassIDTable = false )

protected

Generates a data set and transfers all data, determined from the parameters, into the data set attributes.

Parameters

[in,out]	prRetVal	The generated data set.
[in]	sDataRow	The row with the table data (e.g. "13.0.2\|1453983511\|1455873934\|") from the table file.
[in]	rClassInfo	The ClassInfo with the class ID and the table name.
[in]	StreamPosRow	The position of the table data row in the table file.
[in]	bOnlyClassIDTable	If true, only the record attributes is read from the table and not e.g. the possibly existing blob and string files.

Returns: A return value < 0 indicates an error.

Attention: The returned record must be removed from memory by the calling instance with Record::forget().

◆ generateRecord() [2/2]

int glo::TableReaderInterface::generateRecord	(	Record *&	prRetVal,
		const std::string &	sFieldNameRow,
		const std::string &	sDataRow,
		std::streampos	StreamPosRow,
		const std::string &	rsTable,
		bool	bOnlyClassIDTable = false )

protected

Generates a data set and transfers all data, determined from the parameters, into the data set attributes.

Parameters

[in,out]	prRetVal	The generated data set.
[in]	sFieldNameRow	The row with the table field names (e.g. "ObjID\|CreateDate\|LastChange\|") from the table file.
[in]	sDataRow	The row with the table data (e.g. "13.0.2\|1453983511\|1455873934\|") from the table file.
[in]	StreamPosRow	The position of the table data row in the table file.
[in]	rsTable	The complete table file name.
[in]	bOnlyClassIDTable	If true, only the record attributes is read from the table and not e.g. the possibly existing blob and string files.

Returns: A return value < 0 indicates an error.

Attention: The returned record must be removed from memory by the calling instance with Record::forget().

◆ getAllObjIDs()

int glo::TableReaderInterface::getAllObjIDs ( std::list< ObjID > & rRetValList )

Returns all object IDs from the Persistent table (Class ID == 1).

Parameters

[in,out] rRetValList Found object IDs are returned here. The list is cleared before.

Returns: A return value < 0 indicates an error.

See also: getObjIDs(std::list<ObjID>&,unsigned long),
getObjIDs(std::map< ObjID, ObjID, std::less<ObjID> >&,unsigned long)

◆ getAllTransactionIndexPools()

void glo::TableReaderInterface::getAllTransactionIndexPools ( std::vector< TransactionIndexPool * > & rTransactionIndexPoolVector ) const

Returns all TransactionIndexPools from m_pTransactionIndexPools.

Parameters

[in] rTransactionIndexPoolVector The TransactionIndexPools.

Returns: The referenced TransactionIndexPool or nullptr.

Attention: If returned, the returned objects only lives as long as the returning object, so it must not be removed from memory by the calling instance.

◆ getIndexedObjIdListFromAllSet() [1/3]

int glo::TableReaderInterface::getIndexedObjIdListFromAllSet	(	std::vector< glo::ObjID > &	rObjIDContainer,
		NUM_PTR	ipClientAllSetAddress,
		const std::string &	rsIndexSearchValue,
		EnComparisionOp	eComparisionOp ) const

Returns a list of object IDs from AllSet in relation to the parameters passed. Results can be defined using the parameter eComparisionOp. For example, if parameter rsIndexSearchValue has the value "123" and parameter eComparisionOp has the value LESS, all objects with an index smaller than "123" are returned.

Parameters

[in,out]	rObjIDContainer	The object IDs of the found object IDs are delivered to this list.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	rsIndexSearchValue	The index value.
[in]	eComparisionOp	The comparison operator.

Returns: A return value < 0 indicates an error.

◆ getIndexedObjIdListFromAllSet() [2/3]

int glo::TableReaderInterface::getIndexedObjIdListFromAllSet	(	std::vector< glo::ObjID > &	rObjIDContainer,
		NUM_PTR	ipClientAllSetAddress,
		const std::string &	rsIndexSearchValue,
		EnQueryType	eQuerryType ) const

Returns a list of object IDs from an AllSet in relation to the parameters passed.

Parameters

[in,out]	rObjIDContainer	The object IDs of the found object IDs are returned to this list.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	rsIndexSearchValue	The index expression can contain the placeholders '*' and '?', which are taken into account in the evaluation or if parameter eQueryType == eOQL, the string is interpreted as OQL expression.
[in]	eQuerryType	The query type.

Returns: A return value < 0 indicates an error.

◆ getIndexedObjIdListFromAllSet() [3/3]

int glo::TableReaderInterface::getIndexedObjIdListFromAllSet	(	std::vector< glo::ObjID > &	rObjIDContainer,
		NUM_PTR	ipClientAllSetAddress,
		const std::string &	rsRangeStartIndex,
		const std::string &	rsRangeEndIndex ) const

Returns a list of object IDs from AllSet in relation to the parameters passed. Results can be defined using a range specification. If, for example, parameter rsRangeStartIndex has the value "123" and parameter rsRangeEndIndex has the value "155", all objects with an index greater than/equal to "123" and less than/equal to "155" are delivered.

Parameters

[in,out]	rObjIDContainer	The object IDs of the found object IDs are delivered to this list.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	rsRangeStartIndex	The start index value.
[in]	rsRangeEndIndex	The end index value.

Returns: A return value < 0 indicates an error.

◆ getObjectData() [1/2]

int glo::TableReaderInterface::getObjectData	(	Record *&	prRetVal,
		const ObjID &	rObjID,
		ReaderInfo *	pReaderInfo )

Returns all record attributes in a record of the object with passed object ID.

Parameters

[in,out]	prRetVal	The generated record.
[in]	rObjID	The requested object ID.
[in]	pReaderInfo	An info, e.g. to inform about locked records, which naturally must not be delivered.

Returns: A return value < 0 indicates an error.

Attention: The delivered record must be removed from memory by the calling instance with Record::forget().

◆ getObjectData() [2/2]

int glo::TableReaderInterface::getObjectData	(	Record *&	prRetVal,
		const ObjID &	rObjID,
		ReaderInfo *	pReaderInfo,
		bool	bInRecursion )

protected

Returns all record attributes in a record of the object with the object ID passed. Is used by getObjectData(Record*&,const ObjID&,ReaderInfo*).

Parameters

[in,out]	prRetVal	The generated data set.
[in]	rObjID	The requested object ID.
[in]	pReaderInfo	An info, e.g. to inform about locked records, which naturally must not be delivered.
[in]	bInRecursion	If true, then call in itself.

Returns: A return value < 0 indicates an error.

Attention: The returned record must be removed from memory by the calling instance with Record::forget().

Note: For Glo developers: Is implemented in GloRecordAttributeFunctions.cpp, so that extensions of data set attributes can be made there collectively.

◆ getObjectDataFromDataRow() [1/2]

int glo::TableReaderInterface::getObjectDataFromDataRow	(	Record *&	prRetVal,
		const ObjID &	rObjID,
		unsigned long	ulClassID,
		bool	bOnlyClassIDTable = false )

protected

Returns all record attributes in a record of the object with the passed object ID.

Parameters

[in,out]	prRetVal	The generated data set.
[in]	rObjID	The requested object ID.
[in]	ulClassID	The class ID.
[in]	bOnlyClassIDTable	If true, only the data set attributes are read from the table and not e.g., the blob and string files.

Returns: A return value < 0 indicates an error.

Attention: The returned record must be removed from memory by the calling instance with Record::forget().

◆ getObjectDataFromDataRow() [2/2]

int glo::TableReaderInterface::getObjectDataFromDataRow	(	std::shared_ptr< Record > &	sprRetVal,
		const ObjID &	rObjID,
		unsigned long	ulClassID,
		bool	bOnlyClassIDTable = false )

protected

Returns all record attributes in a record of the object with the passed object ID.

Parameters

[in,out]	sprRetVal	The generated data set.
[in]	rObjID	The requested object ID.
[in]	ulClassID	The class ID.
[in]	bOnlyClassIDTable	If true, only the data set attributes are read from the table and not e.g., the blob and string files.

Returns: A return value < 0 indicates an error.

◆ getObjIdFromAllSet()

int glo::TableReaderInterface::getObjIdFromAllSet	(	ObjID &	rObjID,
		NUM_PTR	ipClientAllSetAddress,
		EnSeekMode	eMode ) const

Returns an object ID from an AllSet.

Parameters

[in,out]	rObjID	An object ID found is entered here.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	eMode	The seek mode.

Parameter examples:

glo::START = returns first element
glo::END = returns last element
glo::CURRENT = returns current element
glo::NEXT = returns next element
glo::PREVIOUS = returns previous element

Returns: A return < 0 indicates an error. A return == ERR_RANGE indicates the end of the list.

Note: The AllSet from ipClientAllSetAddress must be open.

◆ getObjIDs() [1/3]

int glo::TableReaderInterface::getObjIDs	(	std::list< ObjID > &	rRetValList,
		unsigned long	ulClassID )

Returns all object IDs from the table of the class with passed class ID.

Parameters

[in,out]	rRetValList	Found object IDs are returned here. The list is cleared before.
[in]	ulClassID	The class ID.

Returns: A return value < 0 indicates an error.

See also: getObjIDs(std::map< ObjID, ObjID, std::less<ObjID> >&,unsigned long)

◆ getObjIDs() [2/3]

int glo::TableReaderInterface::getObjIDs	(	std::list< ObjID > *	pRetValList,
		std::map< ObjID, ObjID, std::less< ObjID > > *	pRetValMap,
		unsigned long	ulClassID )

protected

Returns all object IDs from the table of the class with passed class ID.

Parameters

[in,out]	pRetValList	Found object IDs are returned here if passed. The list is cleared before.
[in,out]	pRetValMap	Found object IDs, sorted by these, are placed here if passed. The map is cleared before.
[in]	ulClassID	The class ID.

Returns: A return value < 0 indicates an error.

◆ getObjIDs() [3/3]

int glo::TableReaderInterface::getObjIDs	(	std::map< ObjID, ObjID, std::less< ObjID > > &	rRetValMap,
		unsigned long	ulClassID )

Returns all object IDs from the table of the class with passed class ID.

Parameters

[in,out]	rRetValMap	Found object IDs, sorted by these, are returned here. The map is cleared before.
[in]	ulClassID	The class ID.

Returns: A return value < 0 indicates an error.

See also: getObjIDs(std::list<ObjID>&,unsigned long)

◆ getRealIndexPool()

RealIndexPool * glo::TableReaderInterface::getRealIndexPool ( ) const

Returns the m_pRealIndexPool or nullptr if none exists.

Returns: The referenced RealIndexPool or nullptr.

Attention: If returned, the returned object only lives as long as the returning object, so it must not be removed from memory by the calling instance.

◆ getRecord() [1/3]

int glo::TableReaderInterface::getRecord	(	Record *&	prRetVal,
		const ObjID &	rObjID,
		ClassInfo &	rClassInfo,
		bool	bOnlyClassIDTable = false )

protected

Returns a record of the object with passed object ID from a table.

Parameters

[in,out]	prRetVal	The generated data set.
[in]	rObjID	The requested object ID.
[in]	rClassInfo	The ClassInfo with the class ID and the table name.
[in]	bOnlyClassIDTable	If true, only the data set attributes are read from the table of the object with passed class ID.

Returns: A return value < 0 indicates an error.

Attention: The returned record must be removed from memory by the calling instance with Record::forget().

◆ getRecord() [2/3]

int glo::TableReaderInterface::getRecord	(	Record *&	prRetVal,
		const ObjID &	rObjID,
		ReaderInfo *	pReaderInfo )

Returns all record attributes in a record from the table of the object with passed object ID.

Parameters

[in,out]	prRetVal	The generated record.
[in]	rObjID	The requested object ID.
[in]	pReaderInfo	An info, e.g. to inform about locked records, which naturally must not be delivered. In addition, the class ID is set, from whose table is read.

Returns: A return value < 0 indicates an error.

Attention: The delivered record must be removed from memory by the calling instance with Record::forget().

◆ getRecord() [3/3]

int glo::TableReaderInterface::getRecord	(	Record *&	prRetVal,
		const std::string &	sTableName,
		const ObjID &	rObjID,
		unsigned long	ulClassID,
		bool	bOnlyClassIDTable = false )

protected

Returns a record of the object with passed object ID from a table.

Parameters

[in,out]	prRetVal	The generated data set.
[in]	sTableName	The table file name.
[in]	rObjID	The requested object ID.
[in]	ulClassID	The class ID.
[in]	bOnlyClassIDTable	If true, only the data set attributes are read from the table of the object with passed class ID.

Returns: A return value < 0 indicates an error.

Attention: The returned record must be removed from memory by the calling instance with Record::forget().

◆ getSizeFromAllSet()

int glo::TableReaderInterface::getSizeFromAllSet	(	std::size_t &	rnSize,
		NUM_PTR	ipClientAllSetAddress ) const

Returns the number of elements of an AllSet.

Parameters

[in,out]	rnSize	The number of elements of the AllSet.
[in]	ipClientAllSetAddress	The client AllSet address.

Returns: A return value < 0 indicates an error.

Note: The AllSet must be open.

◆ getTransactionIndexPool()

TransactionIndexPool * glo::TableReaderInterface::getTransactionIndexPool ( const TransactionOwner & rCommunicatorWithTreadID ) const

Returns the TransactionIndexPool of the passed TransactionOwner or nullptr if none exists.

Parameters

[in] rCommunicatorWithTreadID The communicator with thread ID.

Returns: The referenced TransactionIndexPool or nullptr.

Attention: If returned, the returned object only lives as long as the returning object, so it must not be removed from memory by the calling instance.

◆ isAllSetOpen()

int glo::TableReaderInterface::isAllSetOpen ( NUM_PTR ipClientAllSetAddress ) const

Checks if a IndexPool::TableObjIdIndexIterator from an IndexPool is in m_pAllSetTableObjIdIndexIteratorMap, or a IndexPool::ObjectStrIndexIterator from an IndexPool is in m_pAllSetTableObjIdIndexIteratorMap from an AllSet; i.e. the AllSet is open.

Parameters

[in] ipClientAllSetAddress The unique client AllSet address.

Returns: If true, the AllSet of the given ipClientAllSetAddress is open.

◆ objIDInAllSet()

int glo::TableReaderInterface::objIDInAllSet	(	const ObjID &	rObjID,
		NUM_PTR	ipClientAllSetAddress ) const

Checks whether an object with the object ID passed occurs in the AllSet.

Parameters

[in]	rObjID	The requested object ID.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.

Returns: If the return value > 0, an object with the passed object ID exists in the AllSet. If the return value == 0, it does not.
A return value < 0 indicates an error.

Note: The AllSet must be open.

◆ openAllSet() [1/4]

int glo::TableReaderInterface::openAllSet	(	const TransactionOwner &	rCommunicatorWithTreadID,
		NUM_PTR	ipClientAllSetAddress,
		unsigned long	ulClassID,
		bool	bWithSubClasses )

Opens an AllSet. This means that a IndexPool::TableObjIdIndexIterator from an IndexPool is inserted in m_pAllSetTableObjIdIndexIteratorMap.

Parameters

[in]	rCommunicatorWithTreadID	The communicator with thread ID for which the AllSet is opened.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	ulClassID	The class ID for which an AllSet should be opened.
[in]	bWithSubClasses	If true, the IndexIterator will also iterate over the objects of the subclasses of the class with passed class ID, otherwise if false, the IndexIterator will only iterate over the objects of the class with passed class ID.

Returns: A return value < 0 indicates an error.

See also: IndexPool
RealIndexPool
TransactionIndexPool
IndexPool::TableObjIdIndexIterator

◆ openAllSet() [2/4]

int glo::TableReaderInterface::openAllSet	(	const TransactionOwner &	rCommunicatorWithTreadID,
		NUM_PTR	ipClientAllSetAddress,
		unsigned long	ulClassID,
		const std::string &	rsIndexName )

Opens an AllSet with an string index. This means that a IndexPool::ObjectStrIndexIterator from an IndexPool is inserted in m_pAllSetTableObjIdIndexIteratorMap.

Parameters

[in]	rCommunicatorWithTreadID	The communicator with thread ID for which the AllSet is opened.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	ulClassID	The class ID for which an AllSet should be opened.
[in]	rsIndexName	The index name of the index to iterate over.

Returns: A return value < 0 indicates an error.

See also: IndexPool
RealIndexPool
TransactionIndexPool
IndexPool::TableObjIdIndexIterator

◆ openAllSet() [3/4]

IndexPool::TableObjIdIndexIterator * glo::TableReaderInterface::openAllSet	(	int &	riErr,
		const TransactionOwner &	rCommunicatorWithTreadID,
		NUM_PTR	ipClientAllSetAddress,
		unsigned long	ulClassID,
		bool	bWithSubClasses = true )

protected

Opens an AllSet. This means that a IndexPool::TableObjIdIndexIterator from an IndexPool is inserted in m_pAllSetTableObjIdIndexIteratorMap.

Parameters

[in,out]	riErr	A return value < 0 indicates an error.
[in]	rCommunicatorWithTreadID	The communicator with thread ID for which the AllSet is opened.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	ulClassID	The class ID for which an AllSet should be opened.
[in]	bWithSubClasses	If true, the IndexIterator will also iterate over the objects of the subclasses of the class with passed class ID, otherwise if false, the IndexIterator will only iterate over the objects of the class with passed class ID

Returns: The IndexIterator which was also added to m_pAllSetTableObjIdIndexIteratorMap.

Attention: If returned, the returned object only lives as long as the returning object; therefore, it must not be removed from memory by the calling instance.

See also: IndexPool
RealIndexPool
TransactionIndexPool
IndexPool::TableObjIdIndexIterator

◆ openAllSet() [4/4]

IndexPool::ObjectStrIndexIterator * glo::TableReaderInterface::openAllSet	(	int &	riErr,
		const TransactionOwner &	rCommunicatorWithTreadID,
		NUM_PTR	ipClientAllSetAddress,
		unsigned long	ulClassID,
		const std::string &	rsIndexName )

protected

Opens an AllSet. This means that a IndexPool::ObjectStrIndexIterator from an IndexPool is inserted into m_pAllSetObjectStrIndexIteratorMap.

Parameters

[in,out]	riErr	A return value < 0 indicates an error.
[in]	rCommunicatorWithTreadID	The communicator with thread ID for which the AllSet is opened.
[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	ulClassID	The class ID for which an AllSet should be opened.
[in]	rsIndexName	The index name of the index to iterate over.

Returns: The IndexIterator which was also added to m_pAllSetObjectStrIndexIteratorMap.

Attention: When an IndexIterator is returned, the returned object lives only as long as the returning object, so it must not be removed from memory by the calling instance.

See also: IndexPool
RealIndexPool
TransactionIndexPool
IndexPool::TableObjIdIndexIterator

◆ openTable()

virtual int glo::TableReaderInterface::openTable ( const std::string & sTableName )

virtual

Opens a table file and adds it to the list of opened table files if successful.

Parameters

[in] sTableName The table file name.

Returns: A return value < 0 indicates an error.

Implements glo::TableInterface.

◆ operator=()

TableInterface & glo::TableReaderInterface::operator= ( const TableInterface & )

private

The assignment operator is not available.

◆ refreshAllTables()

void glo::TableReaderInterface::refreshAllTables ( )

Refreshes the contents of the table files from the list of opened table files.

◆ removeFilterInAllSet()

int glo::TableReaderInterface::removeFilterInAllSet ( NUM_PTR ipClientAllSetAddress ) const

Removes a filter in an AllSet.

Parameters

[in] ipClientAllSetAddress The client AllSet address.

Returns: A return value < 0 indicates an error.

◆ setCurrentObjectInAllSet()

int glo::TableReaderInterface::setCurrentObjectInAllSet	(	const ObjID &	rObjID,
		NUM_PTR	ipClientAllSetAddress ) const

Sets the IndexIterator of an AllSet to the position of the object with the object ID passed.

Parameters

[in]	rObjID	The object ID.
[in]	ipClientAllSetAddress	The unique client AllSet address.

Returns: A return value < 0 indicates an error.

Note: The AllSet must be open.

◆ setFilterInAllSet() [1/3]

int glo::TableReaderInterface::setFilterInAllSet	(	NUM_PTR	ipClientAllSetAddress,
		const std::string &	rsIndexFilterValue ) const

Sets a filter in an AllSet in relation to the passed parameters.

Parameters

[in]	ipClientAllSetAddress	The unique client AllSet address.
[in]	rsIndexFilterValue	The index expression can contain the placeholders '*' and '?', which are taken into account in the evaluation.

Returns: A return value < 0 indicates an error.

◆ setFilterInAllSet() [2/3]

int glo::TableReaderInterface::setFilterInAllSet	(	NUM_PTR	ipClientAllSetAddress,
		const std::string &	rsIndexFilterValue,
		EnComparisionOp	eComparisionOp ) const

Sets a filter in an AllSet in relation to the passed parameters. The filter can be defined in more detail using the parameter eComparisionOp. For example, if parameter rsIndexFilterValue has the value "123" and parameter eComparisionOp has the value LESS, all objects with an index greater than/equal to "123" are filtered out during iteration.

Parameters

[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	rsIndexFilterValue	The index value.
[in]	eComparisionOp	The comparison operator.

Returns: A return value < 0 indicates an error.

◆ setFilterInAllSet() [3/3]

int glo::TableReaderInterface::setFilterInAllSet	(	NUM_PTR	ipClientAllSetAddress,
		const std::string &	rsRangeStartIndex,
		const std::string &	rsRangeEndIndex ) const

Sets a filter in an AllSet in relation to the passed parameters. Results can be defined using a range specification. For example, if parameter rsRangeStartIndex has the value "123" and parameter rsRangeEndIndex has the value "155", all objects with an index smaller than "123" and larger than "155" are filtered out during iteration.

Parameters

[in]	ipClientAllSetAddress	The unique Client-AllSet address.
[in]	rsRangeStartIndex	The start index value.
[in]	rsRangeEndIndex	The end index value.

Returns: A return value < 0 indicates an error.

◆ setPositionInAllSet()

int glo::TableReaderInterface::setPositionInAllSet	(	std::size_t	nPosition,
		NUM_PTR	ipClientAllSetAddress ) const

Sets the IndexIterator of an AllSet to the specified position.

Parameters

[in]	nPosition	The desired iterator position.
[in]	ipClientAllSetAddress	The unique client AllSet address.

Returns: A return value < 0 indicates an error.

Note: The AllSet must be open.

◆ setTransactionIndexPool()

int glo::TableReaderInterface::setTransactionIndexPool	(	const TransactionOwner &	rCommunicatorWithTreadID,
		TransactionIndexPool *	pTransactionIndexPool )

Takes over the transferred TransactionIndexPool, if none has been taken over yet.
Any previously referenced TransactionIndexPool of the communicator with thread ID is removed from memory.

Parameters

[in]	rCommunicatorWithTreadID	The communicator with thread ID.
[in]	pTransactionIndexPool	The TransactionIndexPool.

Returns: A return value < 0 indicates an error.

Attention: If a TransactionIndexPool was passed, the calling instance must not remove it from memory, this already handles the object of this class.

Member Data Documentation

◆ m_pAllSetObjectStrIndexIteratorMap

std::unordered_map< NUM_PTR, AllSetObjectStrIndexIteratorItem * >* glo::TableReaderInterface::m_pAllSetObjectStrIndexIteratorMap

private

List of iterators on a IndexPool::ObjectStrIndex with its name for an AllSet (see also: TAllSet and GenericAllSet)

The Client-AllSet address is the Map-Index (since a TableReaderInterface always belongs to a CommunicaterThread, this address is unique with the client)

◆ m_pAllSetTableObjIdIndexIteratorMap

std::unordered_map< NUM_PTR, IndexPool::TableObjIdIndexIterator * >* glo::TableReaderInterface::m_pAllSetTableObjIdIndexIteratorMap

private

List of iterators on a IndexPool::TableObjIdIndex for an AllSet (see also: TAllSet and GenericAllSet).

The Client-AllSet address is the Map-Index (since a TableReaderInterface always belongs to a CommunicaterThread, this address is unique with the client)

◆ m_pTransactionIndexPools

std::unordered_map< TransactionOwner, TransactionIndexPool *, glo::TransactionOwner::HashFunction > glo::TableReaderInterface::m_pTransactionIndexPools

private

If a TransactionIndexPool of a TransactionOwner exists, then the AllSet iterators are bent to this index, for example, because everything for the TransactionOwner now runs in a transaction and, for example, changes made in the transaction should not be in the real index.

In the transaction index, however, the changes for the TransactionOwner are made.

◆ m_RecursionRecordMap

std::unordered_map< ObjID, Record *, glo::ObjID::HashFunction > glo::TableReaderInterface::m_RecursionRecordMap

private

If records are read recursively, the already read records come in here.

The documentation for this class was generated from the following file:

GloTableReaderInterface.h

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TableReaderInterface() [1/3]

◆ TableReaderInterface() [2/3]

◆ ~TableReaderInterface()

◆ TableReaderInterface() [3/3]

Member Function Documentation

◆ closeAllSet()

◆ deleteAllSetObjectStrIndexIteratorMap()

◆ deleteAllSetTableObjIdIndexIteratorMap()

◆ generateRecord() [1/2]

◆ generateRecord() [2/2]

◆ getAllObjIDs()

◆ getAllTransactionIndexPools()

◆ getIndexedObjIdListFromAllSet() [1/3]

◆ getIndexedObjIdListFromAllSet() [2/3]

◆ getIndexedObjIdListFromAllSet() [3/3]

◆ getObjectData() [1/2]

◆ getObjectData() [2/2]

◆ getObjectDataFromDataRow() [1/2]

◆ getObjectDataFromDataRow() [2/2]

◆ getObjIdFromAllSet()

◆ getObjIDs() [1/3]

◆ getObjIDs() [2/3]

◆ getObjIDs() [3/3]

◆ getRealIndexPool()

◆ getRecord() [1/3]

◆ getRecord() [2/3]

◆ getRecord() [3/3]

◆ getSizeFromAllSet()

◆ getTransactionIndexPool()

◆ isAllSetOpen()

◆ objIDInAllSet()

◆ openAllSet() [1/4]

◆ openAllSet() [2/4]

◆ openAllSet() [3/4]

◆ openAllSet() [4/4]

◆ openTable()

◆ operator=()

◆ refreshAllTables()

◆ removeFilterInAllSet()

◆ setCurrentObjectInAllSet()

◆ setFilterInAllSet() [1/3]

◆ setFilterInAllSet() [2/3]

◆ setFilterInAllSet() [3/3]

◆ setPositionInAllSet()

◆ setTransactionIndexPool()

Member Data Documentation

◆ m_pAllSetObjectStrIndexIteratorMap

◆ m_pAllSetTableObjIdIndexIteratorMap

◆ m_pTransactionIndexPools

◆ m_RecursionRecordMap