---

             

---

uima::FSIndex Class Reference

Inherited by uima::ANIndex.

List of all members.

---

Detailed Description

This class represents a single index over feature structures of some type.

Public Member Functions
	FSIndex ()
	Default constructor.
bool	isValid () const
size_t	getSize () const
	get the number of feature structures currently in this index.
FeatureStructure	find (FeatureStructure const &anFS) const
	find the feature structure in this index which is equivalent to anFS according to the comparator for this index.
FSIterator	iterator () const
	create an iterator over all the feature structures in this index.
FSIterator	typeSetIterator (std::set< uima::Type > const &crTypes) const
	create an iterator over all the feature structures in this index with one of the specified types.
FSIterator	filteredIterator (FSFilter const *cpFilter) const
	create an iterator over this index with the filter cpFilter,
Protected Member Functions
	FSIndex (lowlevel::IndexABase const *cpIndex, uima::lowlevel::IndexRepository &)
	FSIndex (lowlevel::IndexABase const *cpIndex, uima::lowlevel::IndexRepository const &)
void	checkValidity () const
Protected Attributes
lowlevel::IndexABase const *	iv_pIndex
uima::lowlevel::IndexRepository *	iv_indexRepository

---

Constructor & Destructor Documentation

uima::FSIndex::FSIndex (  lowlevel::IndexABase const *  cpIndex, uima::lowlevel::IndexRepository &  )  [protected]

uima::FSIndex::FSIndex (  lowlevel::IndexABase const *  cpIndex, uima::lowlevel::IndexRepository const &  )  [protected]

uima::FSIndex::FSIndex (   )

Default constructor. Creates an invalid FSIndex object.

---

Member Function Documentation

void uima::FSIndex::checkValidity (   )  const [protected]

bool uima::FSIndex::isValid (   )  const

Returns: true if this index object is valid.

size_t uima::FSIndex::getSize (   )  const

get the number of feature structures currently in this index. Exceptions: InvalidIndexObjectException

FeatureStructure uima::FSIndex::find (  FeatureStructure const &  anFS  )  const

find the feature structure in this index which is equivalent to anFS according to the comparator for this index. If such an FS cannot be found an invalid feature structure is returned. Exceptions: InvalidIndexObjectException

FSIterator uima::FSIndex::iterator (   )  const

create an iterator over all the feature structures in this index. Exceptions: InvalidIndexObjectException  Reimplemented in uima::ANIndex.

FSIterator uima::FSIndex::typeSetIterator (  std::set< uima::Type > const &  crTypes  )  const

create an iterator over all the feature structures in this index with one of the specified types. Exceptions: InvalidIndexObjectException  InvalidFSTypeObjectException  IncompatibleTypeForIndexException

FSIterator uima::FSIndex::filteredIterator (  FSFilter const *  cpFilter  )  const

create an iterator over this index with the filter cpFilter, See also: FSFilter Exceptions: InvalidIndexObjectException  Reimplemented in uima::ANIndex.

---

Member Data Documentation

lowlevel::IndexABase const* uima::FSIndex::iv_pIndex [protected]

uima::lowlevel::IndexRepository* uima::FSIndex::iv_indexRepository [protected]

---

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

• fsindex.hpp

---