Iterators are created by calling FSIndex.iterator()
Public Member Functions | |
bool | isValid () const |
true iff get() can be called sucessfully | |
FeatureStructure | get () const |
retrieve the current element in the index for this iterator. | |
void | moveToNext () |
make iterator point to the next element in the index for this iterator. | |
void | moveToPrevious () |
make iterator point to the previous element in the index for this iterator. | |
void | moveToFirst () |
make iterator point to the first element in the index for this iterator. | |
void | moveToLast () |
make iterator point to the last element in the index for this iterator. | |
void | moveTo (FeatureStructure fs) |
make iterator point to the first feature structure fs2 in the index for this iterator where fs >= fs2. | |
FeatureStructure | peekNext () const |
returns the next feature structure of the iterator without moving it. | |
FeatureStructure | peekPrevious () const |
returns the previous feature structure of the iterator without moving it. | |
FSIterator () | |
Default CTOR. | |
FSIterator (FSIterator const &) | |
copy CTOR | |
FSIterator & | operator= (FSIterator const &) |
assignment operator | |
~FSIterator () | |
Protected Member Functions | |
bool | operator== (FSIterator const &) const |
FSIterator (uima::lowlevel::IndexIterator *, CAS *cas) | |
Protected Attributes | |
uima::lowlevel::IndexIterator * | iv_pIterator |
CAS * | iv_cas |
uima::FSIterator::FSIterator | ( | uima::lowlevel::IndexIterator * | , | |
CAS * | cas | |||
) | [protected] |
uima::FSIterator::FSIterator | ( | ) |
Default CTOR.
uima::FSIterator::FSIterator | ( | FSIterator const & | ) |
copy CTOR
uima::FSIterator::~FSIterator | ( | ) |
bool uima::FSIterator::operator== | ( | FSIterator const & | ) | const [protected] |
bool uima::FSIterator::isValid | ( | ) | const |
true iff get() can be called sucessfully
FeatureStructure uima::FSIterator::get | ( | ) | const |
retrieve the current element in the index for this iterator.
Reimplemented in uima::ANIterator.
Referenced by uima::ANIterator::get().
void uima::FSIterator::moveToNext | ( | ) |
make iterator point to the next element in the index for this iterator.
isValid() is false after the call if no such element exists.
void uima::FSIterator::moveToPrevious | ( | ) |
make iterator point to the previous element in the index for this iterator.
isValid() is false after the call if no such element exists.
void uima::FSIterator::moveToFirst | ( | ) |
make iterator point to the first element in the index for this iterator.
void uima::FSIterator::moveToLast | ( | ) |
make iterator point to the last element in the index for this iterator.
void uima::FSIterator::moveTo | ( | FeatureStructure | fs | ) |
make iterator point to the first feature structure fs2 in the index for this iterator where fs >= fs2.
fs must be of a type compatible with the index for this iterator.
FeatureStructure uima::FSIterator::peekNext | ( | ) | const |
returns the next feature structure of the iterator without moving it.
If there is no such feature structure (i.e. the iterator points to the first element) an invalid FS is returned.
FeatureStructure uima::FSIterator::peekPrevious | ( | ) | const |
returns the previous feature structure of the iterator without moving it.
If there is no such feature structure (i.e. the iterator points to the last element) an invalid FS is returned.
FSIterator& uima::FSIterator::operator= | ( | FSIterator const & | ) |
assignment operator
uima::lowlevel::IndexIterator* uima::FSIterator::iv_pIterator [protected] |
CAS* uima::FSIterator::iv_cas [protected] |