All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
HSEPData::QueryUniqueCycle Class Reference

Particular Cycle for usage when a query will only return one row. More...

#include <DBBase.h>

+ Inheritance diagram for HSEPData::QueryUniqueCycle:
+ Collaboration diagram for HSEPData::QueryUniqueCycle:

Public Member Functions

virtual ~QueryUniqueCycle ()
 
virtual bool execute (DBResultSet *pResultSetPtr, bool pIsFirst, bool pIsLast)
 Receives a row from a data operation to populate the internal state information.
 
string & getValueRef (string &pKeyRef)
 Provided a particular key, will return the associated value.
 
StringDictionary & getValuesRef ()
 Returns a reference to the internal String dictionary (key,value).
 
- Public Member Functions inherited from HSEPData::CycleBase
virtual ~CycleBase ()
 

Detailed Description

Particular Cycle for usage when a query will only return one row.

If the operation returns more than one row, the getValueRef and getValuesRef operations will only return information about the last row in the data set.

Definition at line 128 of file DBBase.h.

Constructor & Destructor Documentation

virtual HSEPData::QueryUniqueCycle::~QueryUniqueCycle ( )
inlinevirtual

Definition at line 131 of file DBBase.h.

Member Function Documentation

bool HSEPData::QueryUniqueCycle::execute ( DBResultSet *  pResultSetPtr,
bool  pIsFirst,
bool  pIsLast 
)
virtual

Receives a row from a data operation to populate the internal state information.

Parameters
pResultSetPtrThe received row
pIsFirstit is expected always will be true.
pIsLastit is expected always will be true.
Returns
the current implementation will only return true.

Implements HSEPData::CycleBase.

Definition at line 46 of file DBBase.cpp.

References HSEPData::DBMetadataField::aColumnName, HSEPData::DBResultSet::destroyMetadata(), HSEP::Array< T >::forEach(), HSEPData::DBResultSet::getMetadata(), HSEPData::DBResultSet::getString(), and HSEP::Dictionary< T >::put().

+ Here is the call graph for this function:

string & HSEPData::QueryUniqueCycle::getValueRef ( string &  pKeyRef)

Provided a particular key, will return the associated value.

Parameters
pKeyRefcorresponds to the field name in a database query.
Returns
a reference to the internally stored value.

Definition at line 63 of file DBBase.cpp.

References HSEP::Dictionary< T >::ref().

+ Here is the call graph for this function:

StringDictionary& HSEPData::QueryUniqueCycle::getValuesRef ( )
inline

Returns a reference to the internal String dictionary (key,value).

Returns

Definition at line 156 of file DBBase.h.

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