Package org.apache.uima.cas

Interface FSIndexRepository

All Known Subinterfaces:
FSIndexRepositoryMgr
All Known Implementing Classes:
FSIndexRepositoryImpl
public interface FSIndexRepository
Repository of indexes over feature structures. Use this interface to access previously defined indexes. Generics: T is the associated Java cover class for the top type defined for this index name. If JCas is being used, it is that JCas class. Otherwise it is the standard non-JCas Java cover class.

  • Method Details

    • getIndex

      <T extends FeatureStructure> FSIndex<T> getIndex(String label)
      Retrieve an index according to a label. Generics: T is the associated Java cover class for the top type defined for this index name.
      Type Parameters:
      T - the Java class associated with the top-most type of the index
      Parameters:
      label - The name of the index.
      Returns:
      The index with the name label, or null if no such index is defined.

    • getIndex

      <T extends FeatureStructure> FSIndex<T> getIndex(String label, Type type) throws CASRuntimeException
      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. Generics: T is the associated Java cover class for the type.
      Type Parameters:
      T - The Java class associated with the type
      Parameters:
      label - The name of the index.
      type - A subtype of the type of the index.
      Returns:
      The specified, or null if an index with that name doesn't exist.
      Throws:
      CASRuntimeException - When type is not a subtype of the index's type.

    • getLabels

      Iterator<String> getLabels()
      Get all labels for all indexes.
      Returns:
      All labels.

    • getIndexes

      <T extends FeatureStructure> Iterator<FSIndex<T>> getIndexes()
      Get all indexes in this repository.
      Type Parameters:
      T - the generic type of the FeatureStructures
      Returns:
      All indexes.

    • ll_getIndexes

      <T extends FeatureStructure> Iterator<LowLevelIndex<T>> ll_getIndexes()
      Get all indexes in this repository as low level indexes
      Type Parameters:
      T - the generic type of the FeatureStructures
      Returns:
      All indexes.

    • addFS

      <T extends FeatureStructure> void addFS(T fs)
      Add a feature structure to all appropriate indexes in the repository. If no indexes exist for the type of FS that you are adding, then a bag (unsorted) index will be automatically created.

      Important: after you have called addFS() on a FS, do not change the values of any features used for indexing. If you do, the index will become corrupted and may be unusable. If you need to change an index feature value, first call removeFS() on the FS, change the feature values, then call addFS() again.

      Type Parameters:
      T - the generic type of the FeatureStructure
      Parameters:
      fs - The FS to be added.
      Throws:
      NullPointerException - If the fs parameter is null.

    • removeFS

      <T extends FeatureStructure> void removeFS(T fs)
      Remove a feature structure from all indexes in the repository.
      Type Parameters:
      T - the generic type of the FeatureStructure
      Parameters:
      fs - The FS to be removed. The fs must be the exact FS to remove, not just one which compares "equal" using the index's comparator.
      Throws:
      NullPointerException - If the fs parameter is null.

    • removeAllIncludingSubtypes

      void removeAllIncludingSubtypes(Type type)
      Remove all instances of type, including all subtypes from all indexes in the repository view.
      Parameters:
      type - the type to remove
      Throws:
      NullPointerException - if the type parameter is null.

    • removeAllIncludingSubtypes

      default <T extends TOP> void removeAllIncludingSubtypes(Class<T> clazz)
      Remove all instances of type, including all subtypes from all indexes in the repository view.
      Type Parameters:
      T - the type to remove
      Parameters:
      clazz - the JCas class of the type to remove. To remove all use TOP.class
      Throws:
      NullPointerException - if the clazz parameter is null.

    • removeAllExcludingSubtypes

      void removeAllExcludingSubtypes(Type type)
      Remove all instances of just this type, excluding subtypes, from all indexes in the repository view.
      Parameters:
      type - the type to remove
      Throws:
      NullPointerException - if the type parameter is null.

    • removeAllExcludingSubtypes

      default <T extends TOP> void removeAllExcludingSubtypes(Class<T> clazz)
      Remove all instances of just this type, excluding subtypes, from all indexes in the repository view.
      Type Parameters:
      T - the type to remove
      Parameters:
      clazz - the JCas Class of the type to remove
      Throws:
      NullPointerException - if the type parameter is null.

    • getAllIndexedFS

      <T extends FeatureStructure> FSIterator<T> getAllIndexedFS(Type aType)
      Gets an iterator over all indexed (in this View) FeatureStructures of the specified Type (and any of its subtypes). The elements are returned in arbitrary order. Generics: T is the Java class for aType.
      Type Parameters:
      T - The Java class associated with aType
      Parameters:
      aType - The type
      Returns:
      An iterator that returns all indexed FeatureStructures of type aType and its subtypes, in no particular order.

    • getAllIndexedFS

      default <T extends FeatureStructure> FSIterator<T> getAllIndexedFS(Class<T> clazz)
      Gets an FSIterator over all indexed (in this view) FeatureStructures of the specified Type (and any of its subtypes). The elements are returned in arbitrary order. Generics: T is the Java class for aType.
      Type Parameters:
      T - The Java class associated with aType
      Parameters:
      clazz - The JCas class corresponding to the type
      Returns:
      An iterator that returns all indexed FeatureStructures of the specified type and its subtypes, in no particular order.

    • getIndexedFSs

      <T extends TOP> Collection<T> getIndexedFSs(Type type)
      Returns an unmodifiable collection of all the FSs of this type and its subtypes, that are indexed in this view, in an arbitrary order. Subsequent modifications to the indexes do not affect this collection.
      Type Parameters:
      T - The Java class associated with type
      Parameters:
      type - the type of Feature Structures to include (including subtypes)
      Returns:
      an unmodifiable, unordered collection of all indexed (in this view) Feature Structures of the specified type (including subtypes)

    • getIndexedFSs

      <T extends TOP> Collection<T> getIndexedFSs(Class<T> clazz)
      Returns an unmodifiable collection of all the FSs of this type and its subtypes, that are indexed in this view, in an arbitrary order. Subsequent modifications to the indexes do not affect this collection.
      Type Parameters:
      T - The Java class associated with type
      Parameters:
      clazz - The JCas class corresponding to the type
      Returns:
      an unmodifiable, unordered collection of all indexed (in this view) Feature Structures of the specified type (including subtypes)

    • getIndexedFSs

      <T extends TOP> Collection<T> getIndexedFSs()
      Returns an unmodifiable collection of all of the FSs that are indexed in this view, in an arbitrary order. Subsequent modifications to the indexes do not affect this collection.
      Type Parameters:
      T - The Java class associated with type
      Returns:
      an unmodifiable, unordered collection of all indexed (in this view) Feature Structures of the specified type (including subtypes)