---

             

---

uima::ANIterator Class Reference

Inherits uima::FSIterator.

List of all members.

---

Detailed Description

Iterator over AnnotationFS objects in a CAS annotation index (ANIndex).

Iterators are created by calling ANIndex.iterator()

See also:

AnnotationFS

ANIndex

Public Member Functions
	ANIterator ()
	Default CTOR.
	ANIterator (FSIterator const &)
	upgrade/conversion CTOR
AnnotationFS	get () const
	retrieve the current element in the index for this iterator.
bool	isValid () const
	true iff get() can be called sucessfully
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.
Protected Member Functions
	ANIterator (uima::lowlevel::IndexIterator *, uima::CAS *)
bool	operator== (FSIterator const &) const
Protected Attributes
uima::lowlevel::IndexIterator *	iv_pIterator
CAS *	iv_cas

---

Constructor & Destructor Documentation

uima::ANIterator::ANIterator (  uima::lowlevel::IndexIterator *  , uima::CAS *  )  [inline, protected]

uima::ANIterator::ANIterator (   )  [inline]

Default CTOR.

uima::ANIterator::ANIterator (  FSIterator const &   )  [inline, explicit]

upgrade/conversion CTOR

---

Member Function Documentation

AnnotationFS uima::ANIterator::get (   )  const [inline]

retrieve the current element in the index for this iterator. Reimplemented from uima::FSIterator.

bool uima::FSIterator::operator== (  FSIterator const &   )  const [protected, inherited]

bool uima::FSIterator::isValid (   )  const [inherited]

true iff get() can be called sucessfully

void uima::FSIterator::moveToNext (   )  [inherited]

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 (   )  [inherited]

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 (   )  [inherited]

make iterator point to the first element in the index for this iterator.

void uima::FSIterator::moveToLast (   )  [inherited]

make iterator point to the last element in the index for this iterator.

void uima::FSIterator::moveTo (  FeatureStructure  fs  )  [inherited]

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 [inherited]

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 [inherited]

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.

---

Member Data Documentation

uima::lowlevel::IndexIterator* uima::FSIterator::iv_pIterator [protected, inherited]

CAS* uima::FSIterator::iv_cas [protected, inherited]

---

The documentation for this class was generated from the following file:

• cas.hpp

---