![]() |
Qore DataProvider Module Reference 3.1
|
Defines the abstract class for data provider iterators; the destructor releases the iterator. More...
#include <AbstractDataProviderRecordIterator.qc.dox.h>
Public Member Functions | |
| constructor (int block_size=DefaultBlockSize) | |
| Creates the object and optionally sets the bulk iteration block size. | |
| *AbstractDataProviderBulkRecordInterface | getBulkApi () |
| Returns the bulk data interface if supported. | |
| *hash< string, AbstractDataField > | getRecordType () |
| Returns the record description, if available. | |
| abstract hash< auto > | getValue () |
| returns a single record if the iterator is valid | |
| bool | supportsBulkApi () |
| Returns True if the iterator supports bulk operation. | |
Public Attributes | |
| const | DefaultBlockSize = 1000 |
| Default block size. | |
Protected Member Functions | |
| auto | doMemberGate (string key) |
| Returns the value of the given field in the current record, if the iterator is valid. | |
Static Protected Member Functions | |
| static bool | evalOperator (string field, hash< auto > cmd, hash< auto > op, hash< auto > record) |
| Evaluates a generic search operator on the field value and record and returns the result. | |
| static bool | matchGeneric (hash< auto > record, *hash< auto > where_cond) |
| Checks if the current record matches the search criteria. | |
| static bool | matchGeneric (hash< auto > record, hash< DataProviderExpression > where_cond) |
| Checks if the current record matches the search criteria. | |
| static bool | matchGenericValue (auto expects, auto val) |
| Match a single value. | |
Protected Attributes | |
| int | block_size = DefaultBlockSize |
| Block size for bulk iteration. | |
Defines the abstract class for data provider iterators; the destructor releases the iterator.
this class also implements generic search APIs that can be used to filter record sets for data providers that do not support native search / filtering APIs
|
protected |
Returns the value of the given field in the current record, if the iterator is valid.
| key | the name of the field |
| FIELD-ERROR | invalid or unknown field name |
| *AbstractDataProviderBulkRecordInterface DataProvider::AbstractDataProviderRecordIterator::getBulkApi | ( | ) |
Returns the bulk data interface if supported.
| *hash< string, AbstractDataField > DataProvider::AbstractDataProviderRecordIterator::getRecordType | ( | ) |
Returns the record description, if available.
This base class method returns nothing; reimplement in subclasses to provide a record type
| abstract hash< auto > DataProvider::AbstractDataProviderRecordIterator::getValue | ( | ) |
returns a single record if the iterator is valid
| INVALID-ITERATOR | the iterator is not pointing at a valid element |
|
staticprotected |
Checks if the current record matches the search criteria.
in case of a hash value, if the hash was created by a search operator function, then that search operation is applied to the input, otherwise a recursive partial match with only the keys given in the value to be checked is performed
|
staticprotected |
Checks if the current record matches the search criteria.
in case of a hash value, if the hash was created by a search operator function, then that search operation is applied to the input, otherwise a recursive partial match with only the keys given in the value to be checked is performed
|
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
| bool DataProvider::AbstractDataProviderRecordIterator::supportsBulkApi | ( | ) |
Returns True if the iterator supports bulk operation.