Use this interface to access previously defined indexes.
Public Member Functions | |
FSIndex | getIndex (icu::UnicodeString const &crLabel) const |
Retrieve an index according to a label. | |
FSIndex | getIndex (icu::UnicodeString const &crLabel, Type const &crType) const |
Retrieve an index according to a label and a type. | |
int | getIndexSize (Type const &crType) const |
Return the number of feature structures of type in the repository. | |
std::vector< icu::UnicodeString > | getAllIndexIDs () const |
Get all index names available in the system. | |
Type | getTypeForIndex (icu::UnicodeString const &) const |
get the most general type where the index is defined. | |
bool | isValidIndexID (icu::UnicodeString const &crID) const |
check if there exists an index with ID crID . | |
bool | isValidIndexID (icu::UnicodeString const &crID, Type const &crType) const |
check if there exists an index with ID id for type crType . | |
void | addFS (FeatureStructure const &crFS) |
add the feature structure crFS to all indexes appropriate for its type. | |
void | removeFS (uima::FeatureStructure const &crFS) |
remove the feature structure crFS from all indexes appropriate for its type. | |
Protected Member Functions | |
virtual uima::lowlevel::IndexRepository & | getLowlevelIndexRepository ()=0 |
virtual uima::lowlevel::IndexRepository const & | getLowlevelIndexRepository () const =0 |
FSIndexRepository () | |
virtual | ~FSIndexRepository () |
uima::FSIndexRepository::FSIndexRepository | ( | ) | [protected] |
virtual uima::FSIndexRepository::~FSIndexRepository | ( | ) | [protected, virtual] |
virtual uima::lowlevel::IndexRepository& uima::FSIndexRepository::getLowlevelIndexRepository | ( | ) | [protected, pure virtual] |
virtual uima::lowlevel::IndexRepository const& uima::FSIndexRepository::getLowlevelIndexRepository | ( | ) | const [protected, pure virtual] |
FSIndex uima::FSIndexRepository::getIndex | ( | icu::UnicodeString const & | crLabel | ) | const |
Retrieve an index according to a label.
crLabel | The name of the index. |
label
, or null
if no such index is defined. FSIndex uima::FSIndexRepository::getIndex | ( | icu::UnicodeString const & | crLabel, | |
Type const & | crType | |||
) | const |
Retrieve an index according to a label and a type.
The type is used to narrow down the index of a more general type to a more specific one.
crLabel | The name of the index. | |
crType | A subtype of the type of the index. |
null
if an index with that name doesn't exist, or it exists but type
is not a subtype of the index's type. WrongFSTypeForIndexException |
int uima::FSIndexRepository::getIndexSize | ( | Type const & | crType | ) | const |
Return the number of feature structures of type
in the repository.
crType | The type of feature structures we're interested in. |
std::vector<icu::UnicodeString> uima::FSIndexRepository::getAllIndexIDs | ( | ) | const |
Get all index names available in the system.
Type uima::FSIndexRepository::getTypeForIndex | ( | icu::UnicodeString const & | ) | const |
get the most general type where the index is defined.
bool uima::FSIndexRepository::isValidIndexID | ( | icu::UnicodeString const & | crID | ) | const |
check if there exists an index with ID crID
.
bool uima::FSIndexRepository::isValidIndexID | ( | icu::UnicodeString const & | crID, | |
Type const & | crType | |||
) | const |
check if there exists an index with ID id
for type crType
.
void uima::FSIndexRepository::addFS | ( | FeatureStructure const & | crFS | ) |
add the feature structure crFS
to all indexes appropriate for its type.
InvalidFSObjectException |
void uima::FSIndexRepository::removeFS | ( | uima::FeatureStructure const & | crFS | ) |
remove the feature structure crFS
from all indexes appropriate for its type.
InvalidFSObjectException |