$darkmode
Defines the abstract class for data provider iterators; the destructor releases the iterator. More...
Public Member Functions | |
| constructor (int block_size) | |
| Creates the object. More... | |
| int | getBlockSize () |
| Returns the block size. | |
| AbstractDataProviderRecordIterator | getRecordIterator () |
| Returns a standard record iterator for this bulk iterator. More... | |
| *hash< string, AbstractDataField > | getRecordType () |
| Returns the record description, if available. More... | |
| *hash< string, auto > | getValue () |
| Returns a hash of lists (or constant values) according to the block size or NOTHING if no more data is available. More... | |
| bool | valid () |
| Returns True if there are more records to return. | |
Protected Member Functions | |
| abstract hash< string, auto > | getValueImpl () |
| Returns a hash of lists (or constant values) according to the block size or NOTHING if no more data is available. More... | |
Protected Attributes | |
| int | block_size |
| The record block size. | |
| bool | valid = True |
| Valid flag. | |
Defines the abstract class for data provider iterators; the destructor releases the iterator.
| DataProvider::AbstractDataProviderBulkRecordInterface::constructor | ( | int | block_size | ) |
Creates the object.
| block_size | the record block size for the iterator |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProviderBulkRecordInterface::getRecordIterator | ( | ) |
Returns a standard record iterator for this bulk iterator.
| *hash<string, AbstractDataField> DataProvider::AbstractDataProviderBulkRecordInterface::getRecordType | ( | ) |
Returns the record description, if available.
This base class method returns NOTHING; reimplement in subclasses to provide a record type
Returns a hash of lists (or constant values) according to the block size or NOTHING if no more data is available.
| INVALID-ITERATOR | the iterator is not pointing at a valid element |
|
protectedpure virtual |
Returns a hash of lists (or constant values) according to the block size or NOTHING if no more data is available.
| INVALID-ITERATOR | the iterator is not pointing at a valid element |
Implemented in DataProvider::DefaultBulkRecordIterface.