io.permazen.index

Interface Index<V,T>

Type Parameters:

V - indexed value type

T - index target type

All Known Implementing Classes:

CoreIndex

public interface Index<V,T>

An index on a single field.

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

See Also:

io.permazen.index

Method Summary

Modifier and Type	Method and Description
NavigableMap<V,NavigableSet<T>>	asMap() View this index as a NavigableMap of target values keyed by indexed value.
NavigableSet<Tuple2<V,T>>	asSet() View this index as a NavigableSet of tuples.
Index<V,T>	withTargetBounds(Bounds<T> bounds) Impose Bounds that restrict the range of the target value.
Index<V,T>	withValueBounds(Bounds<V> bounds) Impose Bounds that restrict the range of the indexed value.

Method Detail

asSet

NavigableSet<Tuple2<V,T>> asSet()

View this index as a NavigableSet of tuples.

Returns:

NavigableSet of tuples containing indexed value and target value

asMap

NavigableMap<V,NavigableSet<T>> asMap()

View this index as a NavigableMap of target values keyed by indexed value.

Returns:

NavigableMap from indexed value to the corresponding set of target objects

withValueBounds

Index<V,T> withValueBounds(Bounds<V> bounds)

Impose Bounds that restrict the range of the indexed value.

Parameters:

bounds - bounds to impose on the indexed value

Returns:

a view of this index in which only values within bounds are visible

withTargetBounds

Index<V,T> withTargetBounds(Bounds<T> bounds)

Impose Bounds that restrict the range of the target value.

Parameters:

bounds - bounds to impose on the target value

Returns:

a view of this index in which only target values within bounds are visible