Qore Programming Language Reference Manual  0.9.4.3
QC_HashListIterator.dox.h
1 namespace Qore {
4 
39 
40 public:
42 
51  constructor(hash<auto> h);
52 
53 public:
55 
61  constructor();
62 
63 public:
65 
70  copy();
71 
72 public:
74 
85 bool empty();
86 
87 public:
89 
102 bool first();
103 
104 public:
106 
126 auto getKeyValue(string key);
127 
128 public:
130 
148 hash<auto> getRow();
149 
150 public:
152 
171 hash<auto> getValue();
172 
173 public:
175 
187 int index();
188 
189 public:
191 
204 bool last();
205 
206 public:
208 
220 int max();
221 
222 public:
224 
244 auto memberGate(string key);
245 
246 public:
248 
262 bool next();
263 
264 public:
266 
280 bool prev();
281 
282 public:
284 
293  reset();
294 
295 public:
297 
309 bool set(int pos);
310 
311 public:
313 
324 bool valid();
325 };
326 }
Qore::HashListIterator::empty
bool empty()
returns True if the result list is empty; False if not
Qore::HashListIterator
This class an iterator class for hashes of lists as returned by Qore::SQL::Datasource::select() and Q...
Definition: QC_HashListIterator.dox.h:38
Qore::HashListIterator::index
int index()
returns the current iterator position in the list or -1 if not pointing at a valid element
Qore::HashListIterator::getValue
hash< auto > getValue()
returns the current row value as a hash or throws an INVALID-ITERATOR exception if the iterator is in...
Qore::HashListIterator::last
bool last()
returns True if on the last element of the list
Qore::HashListIterator::first
bool first()
returns True if on the first element of the list
Qore::HashListIterator::getRow
hash< auto > getRow()
returns the current row value as a hash or throws an INVALID-ITERATOR exception if the iterator is in...
Qore::HashListIterator::valid
bool valid()
returns True if the iterator is currently pointing at a valid element, False if not
Qore::HashListIterator::next
bool next()
Moves the current position to the next element in the result list; returns False if there are no more...
Qore::HashListIterator::prev
bool prev()
Moves the current position to the previous element in the result list; returns False if there are no ...
Qore::HashListIterator::memberGate
auto memberGate(string key)
This method allows the iterator to be dereferenced directly as a hash for the current row being itera...
Qore::HashListIterator::constructor
constructor()
Creates an empty hash list iterator object.
Qore::HashListIterator::max
int max()
returns the number of elements in the list
Qore::AbstractQuantifiedBidirectionalIterator
This class defines an abstract interface for bidirectional iterators where the size of the object is ...
Definition: QC_AbstractQuantifiedBidirectionalIterator.dox.h:6
Qore::HashListIterator::copy
copy()
Creates a copy of the HashListIterator object, iterating the same object as the original and in the s...
Qore
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
Qore::HashListIterator::set
bool set(int pos)
sets the new position in the result list; if the position is invalid then the method returns False,...
Qore::HashListIterator::getKeyValue
auto getKeyValue(string key)
Returns the current value for the column given as an argument.
Qore::HashListIterator::reset
reset()
Reset the iterator instance to its initial state.