Package org.apache.uima.jcas
Interface JFSIndexRepository
-
- All Known Implementing Classes:
JFSIndexRepositoryImpl
public interface JFSIndexRepository
Provides the same function as the FSIndexRepository except that the variants that take a "type" argument take type arguments obtainable easily from the JCas type.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <T extends TOP>
FSIterator<T>getAllIndexedFS(int aType)
Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).<T extends TOP>
FSIterator<T>getAllIndexedFS(Type aType)
Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).AnnotationIndex<Annotation>
getAnnotationIndex()
Get the standard annotation index.<T extends Annotation>
AnnotationIndex<T>getAnnotationIndex(int type)
Get the standard annotation index restricted to a specific annotation type.FSIndexRepository
getFSIndexRepository()
Get the underlying FSIndexRepository associated with this JFSIndexRepository.<T extends TOP>
FSIndex<T>getIndex(String label)
Retrieve an index according to a label.<T extends TOP>
FSIndex<T>getIndex(String label, int type)
Retrieve an index according to a label and a type.Iterator<FSIndex<TOP>>
getIndexes()
Get all indexes in this repository.Iterator<String>
getLabels()
Get all labels for all indexes.
-
-
-
Method Detail
-
getIndex
<T extends TOP> FSIndex<T> getIndex(String label)
Retrieve an index according to a label.- Type Parameters:
T
- the Java class corresponding to the top most type defined by this index- Parameters:
label
- The name of the index.- Returns:
- The index with the name
label
, ornull
if no such index is defined.
-
getIndex
<T extends TOP> FSIndex<T> getIndex(String label, int type)
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.- Type Parameters:
T
- the Java class corresponding to the type- Parameters:
label
- The name of the indextype
- A subtype of the type of the index, written as Foo.type- Returns:
- The specified index, or
null
if an index with that name doesn't exist, or it exists buttype
is not a subtype of the index's type.
-
getAnnotationIndex
AnnotationIndex<Annotation> getAnnotationIndex()
Get the standard annotation index.- Returns:
- The standard annotation index.
-
getAnnotationIndex
<T extends Annotation> AnnotationIndex<T> getAnnotationIndex(int type)
Get the standard annotation index restricted to a specific annotation type.- Type Parameters:
T
- the Java class corresponding to type- Parameters:
type
- The annotation type the index is restricted to, written as Foo.type- Returns:
- The standard annotation index, restricted to
type
.
-
getIndexes
Iterator<FSIndex<TOP>> getIndexes()
Get all indexes in this repository.- Returns:
- All indexes.
-
getFSIndexRepository
FSIndexRepository getFSIndexRepository()
Get the underlying FSIndexRepository associated with this JFSIndexRepository.- Returns:
- The associated FSIndexRepository.
-
getAllIndexedFS
<T extends TOP> FSIterator<T> getAllIndexedFS(Type aType)
Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).Limitation: If there are no sorted or bag indexes defined for this type, but there is more than one set index defined, then this method will only return the contents of one of these set indexes (chosen arbitrarily). Generics: The returned Java cover class may not be a JCas one.
- Type Parameters:
T
- the Java Class corresponding to aType- Parameters:
aType
- The type- Returns:
- An iterator that returns all indexed FeatureStructures of type
aType
, in no particular order.
-
getAllIndexedFS
<T extends TOP> FSIterator<T> getAllIndexedFS(int aType)
Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).Limitation: If there are no sorted or bag indexes defined for this type, but there is more than one set index defined, then this method will only return the contents of one of these set indexes (chosen arbitrarily). Generics: The returned Java cover class may not be a JCas one.
- Type Parameters:
T
- the Java Class corresponding to aType- Parameters:
aType
- The type obtained by doing MyJCasClass.type- Returns:
- An iterator that returns all indexed FeatureStructures of type
aType
, in no particular order.
-
-