Qore DataProvider Module Reference  1.0
DataProvider::AbstractDataProviderRecordIterator Class Referenceabstract

Defines the abstract class for data provider iterators; the destructor releases the iterator. More...

Inheritance diagram for DataProvider::AbstractDataProviderRecordIterator:

Public Member Functions

abstract hash< auto > getValue ()
 returns a single record if the iterator is valid More...
 

Protected Member Functions

auto doMemberGate (string key)
 Returns the value of the given field in the current record, if the iterator is valid. More...
 

Static Protected Member Functions

static bool matchGeneric (hash< auto > record, *hash< auto > where_cond)
 Checks if the current record matches the search criteria. More...
 
static bool matchGenericValue (auto expects, auto val)
 Match a single value. More...
 

Detailed Description

Defines the abstract class for data provider iterators; the destructor releases the iterator.

Member Function Documentation

◆ doMemberGate()

auto DataProvider::AbstractDataProviderRecordIterator::doMemberGate ( string  key)
protected

Returns the value of the given field in the current record, if the iterator is valid.

Parameters
keythe name of the field
Returns
the value of the given field in the current record, if the iterator is valid
Exceptions
FIELD-ERRORinvalid or unknown field name

◆ getValue()

abstract hash<auto> DataProvider::AbstractDataProviderRecordIterator::getValue ( )
pure virtual

returns a single record if the iterator is valid

Exceptions
INVALID-ITERATORthe iterator is not pointing at a valid element

Implemented in DataProvider::DefaultRecordIterator.

◆ matchGeneric()

static bool DataProvider::AbstractDataProviderRecordIterator::matchGeneric ( hash< auto >  record,
*hash< auto >  where_cond 
)
staticprotected

Checks if the current record matches the search criteria.

in case of a hash value, a recursive partial match with only the keys given in the value to be checked is performed

◆ matchGenericValue()

static bool DataProvider::AbstractDataProviderRecordIterator::matchGenericValue ( auto  expects,
auto  val 
)
staticprotected

Match a single value.

in case of a hash value, a recursive partial match with only the keys given in the value to be checked is performed