Package org.apache.uima.cas.admin
Interface FSIndexRepositoryMgr
- All Superinterfaces:
FSIndexRepository
- All Known Implementing Classes:
FSIndexRepositoryImpl
Repository of indexes. Indexes are defined via
FSIndexComparators.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidcommit()Commit this repository instance.Create a new comparator to define a new index.booleancreateIndex(FSIndexComparator comp, String label) Create a new sorted index.booleancreateIndex(FSIndexComparator comp, String label, int indexingStrategy) Create a new index.Currently not useful.Get the default type order builder.Get the default type order.booleanCheck if this instance has been committed.Methods inherited from interface org.apache.uima.cas.FSIndexRepository
addFS, getAllIndexedFS, getAllIndexedFS, getIndex, getIndex, getIndexedFSs, getIndexedFSs, getIndexedFSs, getIndexes, getLabels, ll_getIndexes, removeAllExcludingSubtypes, removeAllExcludingSubtypes, removeAllIncludingSubtypes, removeAllIncludingSubtypes, removeFS
-
Method Details
-
createComparator
FSIndexComparator createComparator()Create a new comparator to define a new index.- Returns:
- A new comparator instance.
-
createIndex
boolean createIndex(FSIndexComparator comp, String label, int indexingStrategy) throws CASAdminException Create a new index. Note: if you creata a BAG_INDEX, the comparator will be ignored.- Parameters:
comp- The comparator for the new index.label- The name of the new index.indexingStrategy- The kind of index (sorted, set, bag).- Returns:
falseiff an index with the samelabelalready exists.- Throws:
CASAdminException- If the repository is locked (after callingcommit()).
-
createIndex
Create a new sorted index.- Parameters:
comp- The comparator for the new index.label- The name of the new index.- Returns:
falseiff an index with the samelabelalready exists.- Throws:
CASAdminException- If the repository is locked (after callingcommit()).
-
commit
void commit()Commit this repository instance. No more additions will be allowed. -
isCommitted
boolean isCommitted()Check if this instance has been committed.- Returns:
trueiff this instance has been committed.
-
getDefaultOrderBuilder
LinearTypeOrderBuilder getDefaultOrderBuilder()Get the default type order builder.- Returns:
- The default type order builder.
-
getDefaultTypeOrder
LinearTypeOrder getDefaultTypeOrder()Get the default type order.- Returns:
- The default type order.
-
createTypeSortOrder
LinearTypeOrderBuilder createTypeSortOrder()Currently not useful.- Returns:
- A new type order builder.
-