Package io.permazen.index

Interface Index<T>

Type Parameters:
T - index target type
All Known Subinterfaces:
Index1<V,T>, Index2<V1,V2,T>, Index3<V1,V2,V3,T>, Index4<V1,V2,V3,V4,T>
All Known Implementing Classes:
AbstractCoreIndex, CoreIndex1, CoreIndex2, CoreIndex3, CoreIndex4
public interface Index<T>
An index on a one or more fields in some target type.

Indexes are read-only and "live", always reflecting the current transaction state.

See Also:

  • Method Details

    • numberOfFields

      int numberOfFields()
      Get the number of fields in this index.
      Returns:
      the number of indexed fields

    • asSet

      NavigableSet<? extends Tuple> asSet()
      View this index as a NavigableSet of tuples.
      Returns:
      NavigableSet of tuples containing indexed value(s) and target value

    • asMap

      NavigableMap<?,NavigableSet<T>> asMap()
      View this index as a NavigableMap of target values keyed by indexed value(s).
      Returns:
      NavigableMap from indexed value(s) to the corresponding set of target objects