org.corpus_tools.salt.index

Class IndexMgrImpl

java.lang.Object

org.corpus_tools.salt.index.IndexMgrImpl

All Implemented Interfaces:

Serializable, IndexMgr

public class IndexMgrImpl
extends Object
implements IndexMgr

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexMgrImpl()
IndexMgrImpl(boolean threadSafe)

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 element) Removes the passed value from the indexes having the passed identifier.
<V> boolean	removeValue(V element) Removes the given element from all indexes.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexMgrImpl

public IndexMgrImpl()

IndexMgrImpl

public IndexMgrImpl(boolean threadSafe)

Method Detail

createIndex

public <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.

Specified by:

createIndex in interface IndexMgr

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

public <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.

Specified by:

createIndex in interface IndexMgr

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

public boolean containsIndex(String indexId)

Checks if an index with the passed identifier is registered.

Specified by:

containsIndex in interface IndexMgr

Parameters:

indexId - identifier of the index

Returns:

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

put

public <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.

Specified by:

put in interface IndexMgr

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

public <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.

Specified by:

putAll in interface IndexMgr

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

public <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.

Specified by:

get in interface IndexMgr

Parameters:

indexId - identifier of the index

key - corresponding key to the returned value

Returns:

value matching the passed key

getAll

public <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.

Specified by:

getAll in interface IndexMgr

Parameters:

indexId - identifier of the index

key - corresponding key to the returned set of values

Returns:

set of values matching the passed key

containsKey

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

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

Specified by:

containsKey in interface IndexMgr

Parameters:

indexId - identifier of the index

key - key to be searched for

Returns:

true when the index contains such a key

remove

public <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 IndexMgr.remove(String, Object, Object).

Specified by:

remove in interface IndexMgr

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

public <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.

Specified by:

remove in interface IndexMgr

Parameters:

indexId - identifier of the index

key - key corresponding to the value to be removed

Returns:

true if the value were removed successfully, false otherwise

removeIndex

public boolean removeIndex(String indexId)

Removes the index with the passed identifier.

Specified by:

removeIndex in interface IndexMgr

Parameters:

indexId - identifier of the index

Returns:

true if the identifier could be removed successfully, false otherwise

clearIndex

public void clearIndex(String indexId)

Removes all entries contained in the index with the passed identifier

Specified by:

clearIndex in interface IndexMgr

Parameters:

indexId - identifier of the index

removeAll

public void removeAll()

Removes all index from the index manager.

Specified by:

removeAll in interface IndexMgr

removeValue

public <V> boolean removeValue(V element)

Removes the given element from all indexes.

Specified by:

removeValue in interface IndexMgr

Parameters:

element - - the element which shall be removed

Returns:

true, if removing was successful

removeValue

public <V> boolean removeValue(String indexId,
                               V element)

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

Specified by:

removeValue in interface IndexMgr

element - the value to be removed

Returns:

true, if the value was removed successfully

toString

public String toString()

Overrides:

toString in class Object