com.hammurapi.store

## Interface Index<ST,T extends ST,PK,V,S extends Store<ST,PK,S>>

- Type Parameters:
    `T` -
  All Superinterfaces:
    Iterable<T>
  All Known Subinterfaces:
    MultiIndex<ST,T,PK,V,S>, OrderedIndex<ST,T,PK,V,S>, UniqueIndex<ST,T,PK,V,S>
  All Known Implementing Classes:
    AbstractIndex

      public interface Index<ST,T extends ST,PK,V,S extends Store<ST,PK,S>>
      extends Iterable<T>

  Store.addIndex() returns object which implements one or more of Index sub-interfaces. Index instances are used to directly leverage index functionality without going through Store.get() methods.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static class` | `Index.Type`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Comparator<V>` | `getComparator()`
    `Extractor<T,V,S>` | `getExtractor()`
    `Predicate<ST,S>` | `getPredicate()`
    `S` | `getStore()`
    `boolean` | `isOrdered()`
    `boolean` | `isUnique()`

    - ### Methods inherited from interface java.lang.Iterable

      `iterator`

- - ### Method Detail

    - #### getStore

          S getStore()

      Returns:
        Back-link to the store.

    - #### getPredicate

          Predicate<ST,S> getPredicate()

    - #### getExtractor

          Extractor<T,V,S> getExtractor()

    - #### isUnique

          boolean isUnique()

    - #### isOrdered

          boolean isOrdered()

    - #### getComparator

          Comparator<V> getComparator()