org.openzen.zengarden.index

Class AutoIndex<K,V>

java.lang.Object

org.openzen.zengarden.index.AutoIndex<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

Index<K,V>

Direct Known Subclasses:

WatchedAutoIndex

public class AutoIndex<K,V>
extends java.lang.Object
implements Index<K,V>

Implements an Index with automatic indexing. Whenever an item is added, the indexer is called for that value and the resulting value used as key for indexing. The returned keys must be the same every time - that is, the values must be immutable in their key, and two calls to the indexer with the same value must return equivalent keys (equals() returns true).

Constructor Summary

Constructors

Constructor and Description
AutoIndex(Function<V,K> indexer) Constructs an index using the given indexer.

Method Summary

Modifier and Type	Method and Description
boolean	add(V value) Adds the given value to the index.
java.util.Set<V>	find(K key) Finds all values indexed by the given key.
void	forEachValue(Consumer<V> consumer) Iterates over each value indexed by this index.
K	getKey(V value) Calculates the key for the given value.
java.util.Set<K>	getKeys() Retrieves the set of all keys.
boolean	remove(V value) Removes the given value from the index.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoIndex

public AutoIndex(Function<V,K> indexer)

Constructs an index using the given indexer.

Parameters:

indexer - indexer to calculate keys from values

Method Detail

getKey

public K getKey(V value)

Calculates the key for the given value.

Parameters:

value - value to calculate the key for

Returns:

calculated key

add

public boolean add(V value)

Adds the given value to the index.

Parameters:

value - value to be added

Returns:

true if added, false otherwise

remove

public boolean remove(V value)

Removes the given value from the index.

Parameters:

value - value to remove

Returns:

true if the values was actually removed, false otherwise

find

public java.util.Set<V> find(K key)

Description copied from interface: Index

Finds all values indexed by the given key.

Specified by:

find in interface Index<K,V>

Parameters:

key - key to find values for

Returns:

all values matching the given key

getKeys

public java.util.Set<K> getKeys()

Description copied from interface: Index

Retrieves the set of all keys.

Specified by:

getKeys in interface Index<K,V>

Returns:

key set

forEachValue

public void forEachValue(Consumer<V> consumer)

Description copied from interface: Index

Iterates over each value indexed by this index.

Specified by:

forEachValue in interface Index<K,V>

Parameters:

consumer - value consumer