cz.vutbr.web.domassign

Class MultiMap<E,P,D>

java.lang.Object

cz.vutbr.web.domassign.MultiMap<E,P,D>

Direct Known Subclasses:

DeclarationMap, StyleMap

public abstract class MultiMap<E,P,D>
extends Object

This is a general map that assigns the data D to two keys E (Element) and P (Pseudo element). The element is mandatory, the PseudoElement key value may be null. When P is null, the structure behaves as a simple map called a main map. Other values of PseudoElement create so-called pseudo maps. The map is optimized to provide the best performance for the main map.

Author:

burgetr

Constructor Summary

Constructors

Constructor and Description
MultiMap() Creates an empty map
MultiMap(int initialSize) Creates an empty map

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract D	createDataInstance() Creates a new instance of the data value.
D	get(E el) Gets the data for the given element and no pseudo-element
D	get(E el, P pseudo) Gets the data for the given element and pseudo-element.
D	getOrCreate(E el, P pseudo) Gets the data or creates an empty list if it does not exist yet.
boolean	hasPseudo(E el, P pseudo) Checks if the given pseudo element is available for the given element
Set<E>	keySet() Gets all the keys (elements) of the main map.
Set<P>	pseudoSet(E el) Gets all the pseudo elements that are available for the given element.
void	put(E el, P pseudo, D data) Sets the data for the specified element and pseudo-element.
int	size() Obtains the size of the main map (where P is null)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiMap

public MultiMap()

Creates an empty map

MultiMap

public MultiMap(int initialSize)

Creates an empty map

Method Detail

createDataInstance

protected abstract D createDataInstance()

Creates a new instance of the data value. This is only used by getOrCreate(Object, Object).

size

public int size()

Obtains the size of the main map (where P is null)

Returns:

the number of elements in the main map.

get

public D get(E el,
    P pseudo)

Gets the data for the given element and pseudo-element.

Parameters:

el - the element

pseudo - a pseudo-element or null, if no pseudo-element is required

Returns:

the stored data

get

public D get(E el)

Gets the data for the given element and no pseudo-element

Parameters:

el - the element

Returns:

the stored data

getOrCreate

public D getOrCreate(E el,
            P pseudo)

Gets the data or creates an empty list if it does not exist yet.

Parameters:

el - the element

pseudo - a pseudo-element or null, if no pseudo-element is required

Returns:

the stored data

put

public void put(E el,
       P pseudo,
       D data)

Sets the data for the specified element and pseudo-element.

Parameters:

el - the element to which the data belongs

pseudo - a pseudo-element or null of none is required

data - data to be set

keySet

public Set<E> keySet()

Gets all the keys (elements) of the main map.

Returns:

A set of elements contained in the map.

pseudoSet

public Set<P> pseudoSet(E el)

Gets all the pseudo elements that are available for the given element.

Parameters:

el - The given element

Returns:

A set of all pseudo elements available for the element

hasPseudo

public boolean hasPseudo(E el,
                P pseudo)

Checks if the given pseudo element is available for the given element

Parameters:

el - The element

pseudo - The tested pseudo element

Returns:

true when there is some value associated with the given pair