io.permazen.core

Class CoreIndex<V,T>

java.lang.Object

io.permazen.core.CoreIndex<V,T>

Type Parameters:

V - index value type

T - index target type

All Implemented Interfaces:

Index<V,T>

public class CoreIndex<V,T>
extends Object
implements Index<V,T>

Core API Index implementation representing a index on a single field.

Instances are immutable.

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.
CoreIndex<V,T>	filter(int index, KeyFilter filter) Apply key filtering to field values at the specified index.
List<FieldType<?>>	getFieldTypes() Get all of the FieldTypes associated with this instance.
CoreIndex<V,T>	withTargetBounds(Bounds<T> bounds) Impose Bounds that restrict the range of the target value.
CoreIndex<V,T>	withValueBounds(Bounds<V> bounds) Impose Bounds that restrict the range of the indexed value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

filter

public CoreIndex<V,T> filter(int index,
                             KeyFilter filter)

Apply key filtering to field values at the specified index. This method works cummulatively: the new instance filters to the intersection of the given key filter and any existing key filter on that field.

Parameters:

index - zero-based object type field offset

filter - key filtering to apply

Returns:

filtered view of this instance

asSet

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

Description copied from interface: Index

View this index as a NavigableSet of tuples.

Specified by:

asSet in interface Index<V,T>

Returns:

NavigableSet of tuples containing indexed value and target value

asMap

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

Description copied from interface: Index

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

Specified by:

asMap in interface Index<V,T>

Returns:

NavigableMap from indexed value to the corresponding set of target objects

withValueBounds

public CoreIndex<V,T> withValueBounds(Bounds<V> bounds)

Description copied from interface: Index

Impose Bounds that restrict the range of the indexed value.

Specified by:

withValueBounds in interface Index<V,T>

Parameters:

bounds - bounds to impose on the indexed value

Returns:

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

withTargetBounds

public CoreIndex<V,T> withTargetBounds(Bounds<T> bounds)

Description copied from interface: Index

Impose Bounds that restrict the range of the target value.

Specified by:

withTargetBounds in interface Index<V,T>

Parameters:

bounds - bounds to impose on the target value

Returns:

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

getFieldTypes

public List<FieldType<?>> getFieldTypes()

Get all of the FieldTypes associated with this instance. The list includes an entry for each indexed value type, followed by a final entry representing the index target type.

Returns:

unmodifiable list of field types