org.semanticweb.owlapi.util

Class MultiMap<Key,Value>

java.lang.Object

org.semanticweb.owlapi.util.MultiMap<Key,Value>

Type Parameters:

Key - key type

Value - value type

All Implemented Interfaces:

Serializable

public class MultiMap<Key,Value>
extends Object
implements Serializable

Author:

ignazio palmisano

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultiMap() default constructor
MultiMap(boolean threadsafe)
MultiMap(boolean threadsafe, boolean usesets)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() clear map
boolean	contains(Key k, Value v)
boolean	containsKey(Key k)
boolean	containsValue(Value v)
protected Collection<Value>	createCollection()
Collection<Value>	get(Key key) returns a mutable set of values connected to the key; if no value is connected, returns an immutable empty set.
Set<Value>	getAllValues()
boolean	isValueSetsEqual()
Set<Key>	keySet()
boolean	put(Key key, Value value)
void	putAll(Key k, Collection<Value> v)
void	putAll(MultiMap<Key,Value> otherMap) add all entries from other map.
boolean	remove(Key key) removes the set of values connected to the key.
boolean	remove(Key key, Value value) removes the value connected to the key; if there is more than one value connected to the key, only one is removed.
void	setEntry(Key key, Collection<Value> values) set an entry to a set of values
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiMap

public MultiMap()

default constructor

MultiMap

public MultiMap(boolean threadsafe)

Parameters:

threadsafe - true if threadsafe collections should be used

MultiMap

public MultiMap(boolean threadsafe,
        boolean usesets)

Parameters:

threadsafe - true if threadsafe collections should be used

usesets - true if sets should be used

Method Detail

put

public boolean put(Key key,
          Value value)

Parameters:

key - key

value - value

Returns:

true if an insertion occurs

createCollection

protected Collection<Value> createCollection()

setEntry

public void setEntry(Key key,
            Collection<Value> values)

set an entry to a set of values

Parameters:

key - key

values - values

get

public Collection<Value> get(Key key)

returns a mutable set of values connected to the key; if no value is connected, returns an immutable empty set.

Parameters:

key - key

Returns:

the set of values connected with the key

keySet

public Set<Key> keySet()

Returns:

the set of keys

getAllValues

public Set<Value> getAllValues()

Returns:

all values in the map

remove

public boolean remove(Key key)

removes the set of values connected to the key.

Parameters:

key - key

Returns:

true if removal occurs

remove

public boolean remove(Key key,
             Value value)

removes the value connected to the key; if there is more than one value connected to the key, only one is removed.

Parameters:

key - key

value - value

Returns:

true if removal occurs

size

public int size()

Returns:

the size of the multimap (sum of all the sizes of the sets)

contains

public boolean contains(Key k,
               Value v)

Parameters:

k - key

v - value

Returns:

true if the pairing (k, v) is in the map (set equality for v)

containsKey

public boolean containsKey(Key k)

Parameters:

k - the key

Returns:

true if k is a key for the map

containsValue

public boolean containsValue(Value v)

Parameters:

v - value

Returns:

true if v is a value for a key in the map

clear

public void clear()

clear map

toString

public String toString()

Overrides:

toString in class Object

putAll

public void putAll(MultiMap<Key,Value> otherMap)

add all entries from other map.

Parameters:

otherMap - map to add

putAll

public void putAll(Key k,
          Collection<Value> v)

Parameters:

k - key

v - all entries to add

isValueSetsEqual

public boolean isValueSetsEqual()

Returns:

true if all value collections are equal