org.corpus_tools.salt.index

Interface IndexMgr

All Superinterfaces:

Serializable

All Known Implementing Classes:

IndexMgrImpl

public interface IndexMgr
extends Serializable

The index manager provides a mechanism to register indexes. An index relates a set of nodes, relations or layers with an identifier. Each index is also identified by an identifier, which is also used to access its elements.
A new index could be created via #addIndex(String, Class, Class).

Author:

florian

Method Summary

Modifier and Type	Method and Description
void	clearIndex(String indexId) Removes all entries contained in the index with the passed identifier
boolean	containsIndex(String indexId) Checks if an index with the passed identifier is registered.
<K> boolean	containsKey(String indexId, K key) Returns whether the index having the passed identifier contains the passed key.
<K,V> void	createIndex(String indexId, Class<K> keyType, Class<V> valueType) Creates a new index which could be accessed via the passed identifier.
<K,V> void	createIndex(String indexId, Class<K> keyType, Class<V> valueType, int expectedKeys, int expectedValuesPerKey) Creates a new index which could be accessed via the passed identifier.
<K,V> V	get(String indexId, K key) Returns the value corresponding to the passed key, which is contained in the index with the passed identifier.
<K,V> List<V>	getAll(String indexId, K key) Returns the set of values corresponding to the passed key, which is contained in the index with the passed identifier.
<K,V> boolean	put(String indexId, K key, V value) Adds a new value to the index having the passed identifier under the passed key.
<K,V> boolean	putAll(String indexId, K key, Collection<V> values) Adds a collection of values to the index having the passed identifier under the passed key.
<K> boolean	remove(String indexId, K key) Removes the value or collection of values corresponding to the passed key contained in the index having the passed identifier.
<K,V> boolean	remove(String indexId, K key, V value) Removes the passed value corresponding to the passed key contained in the index having the passed identifier.
void	removeAll() Removes all index from the index manager.
boolean	removeIndex(String indexId) Removes the index with the passed identifier.
<V> boolean	removeValue(String indexId, V value) Removes the passed value from the indexes having the passed identifier.
<V> boolean	removeValue(V value) Removes the passed value from all registered indexes.

Method Detail

createIndex

<K,V> void createIndex(String indexId,
                       Class<K> keyType,
                       Class<V> valueType)

Creates a new index which could be accessed via the passed identifier. The index can handle keys and values of the passed types.

Type Parameters:

K -

V -

Parameters:

indexId - identifier to access the index or its elements

keyType - type of the keys in the index

valueType - type of the values in the index

createIndex

<K,V> void createIndex(String indexId,
                       Class<K> keyType,
                       Class<V> valueType,
                       int expectedKeys,
                       int expectedValuesPerKey)

Creates a new index which could be accessed via the passed identifier. The index can handle keys and values of the passed types.

Type Parameters:

K -

V -

Parameters:

indexId - identifier to access the index or its elements

keyType - type of the keys in the index

valueType - type of the values in the index

expectedKeys - number of expected keys of the index, this parameter is used for initialization optimization. -1 means no expected size

expectedValuesPerKey - number of expected values per key of the index, this parameter is used for initialization optimization.

containsIndex

boolean containsIndex(String indexId)

Checks if an index with the passed identifier is registered.

Parameters:

indexId - identifier of the index

Returns:

true if an index with the passed identifier exists, false otherwise

removeIndex

boolean removeIndex(String indexId)

Removes the index with the passed identifier.

Parameters:

indexId - identifier of the index

Returns:

true if the identifier could be removed successfully, false otherwise

clearIndex

void clearIndex(String indexId)

Removes all entries contained in the index with the passed identifier

Parameters:

indexId - identifier of the index

removeAll

void removeAll()

Removes all index from the index manager.

put

<K,V> boolean put(String indexId,
                  K key,
                  V value)

Adds a new value to the index having the passed identifier under the passed key. If no such index exists, nothing is added.

Type Parameters:

K -

V -

Parameters:

indexId - identifier of the index

key - the key to access the passed value

value - the value to be added to the index

Returns:

true, if the entry was successfully added, false otherwise

putAll

<K,V> boolean putAll(String indexId,
                     K key,
                     Collection<V> values)

Adds a collection of values to the index having the passed identifier under the passed key. If no such index exists, nothing is added.

Type Parameters:

K -

V -

Parameters:

indexId - identifier of the index

key - the key to access the passed value

values - the values to be added to the index

Returns:

true, if the values were added successfully, false otherwise

get

<K,V> V get(String indexId,
            K key)

Returns the value corresponding to the passed key, which is contained in the index with the passed identifier.

Type Parameters:

K -

V -

Parameters:

indexId - identifier of the index

key - corresponding key to the returned value

Returns:

value matching the passed key

getAll

<K,V> List<V> getAll(String indexId,
                     K key)

Returns the set of values corresponding to the passed key, which is contained in the index with the passed identifier.

Type Parameters:

K -

V -

Parameters:

indexId - identifier of the index

key - corresponding key to the returned set of values

Returns:

set of values matching the passed key

remove

<K> boolean remove(String indexId,
                   K key)

Removes the value or collection of values corresponding to the passed key contained in the index having the passed identifier. To remove a single value in a set of values use method remove(String, Object, Object).

Type Parameters:

K -

Parameters:

indexId - identifier of the index

key - key corresponding to the value or values to be removed

Returns:

true if the value or set of values were removed successfully, false otherwise

remove

<K,V> boolean remove(String indexId,
                     K key,
                     V value)

Removes the passed value corresponding to the passed key contained in the index having the passed identifier.

Type Parameters:

K -

V -

Parameters:

indexId - identifier of the index

key - key corresponding to the value to be removed

value -

Returns:

true if the value were removed successfully, false otherwise

containsKey

<K> boolean containsKey(String indexId,
                        K key)

Returns whether the index having the passed identifier contains the passed key.

Type Parameters:

K -

Parameters:

indexId - identifier of the index

key - key to be searched for

Returns:

true when the index contains such a key

removeValue

<V> boolean removeValue(V value)

Removes the passed value from all registered indexes.

Type Parameters:

V -

Parameters:

value - the value to be removed

Returns:

true, if the value was removed successfully

removeValue

<V> boolean removeValue(String indexId,
                        V value)

Removes the passed value from the indexes having the passed identifier.

Type Parameters:

V -

Parameters:

indexId -

value - the value to be removed

Returns:

true, if the value was removed successfully