net.mdatools.modelant.core.operation.model.topology

Class EquivalenceClassesMapImpl<V>

java.lang.Object

net.mdatools.modelant.core.operation.model.topology.EquivalenceClassesMapImpl<V>

Type Parameters:

V - is the class of the mapped elements

All Implemented Interfaces:

EquivalenceClassesMap<V>

public class EquivalenceClassesMapImpl<V>
extends Object
implements EquivalenceClassesMap<V>

Author:

Rusi Popov (popovr@mdatools.net)

Constructor Summary

Constructors

Constructor and Description
EquivalenceClassesMapImpl()

Method Summary

Modifier and Type	Method and Description
void	add(Collection<V> xClass, Collection<V> yClass) Register the X equivalence class mapped to Y equivalence class, Any existing mappings of the equivalence classes' elements are overridden.
void	add(V x, V y) This method guarantees that each x or y objects pertain to no more than a single set and there is one-to-one mapping between these sets If there is a set containing y and there is no set containing x, then {x} is put as the set that is mapped to y; If there is a set containing x and there is no set containing y, then {y} is put as the set that is mapped to x; If there is no set containing x and there is no set containing y, then a new set {x} is created and mapped to the new set {y} If there is a set containing x A.K.A {x} and there is a set containing y A.K.A {y}, then if {x} not mapped to {y}, this method fails.
Collection<V>	getEquivalents(V element)
V	getRepresentative(V element)
Collection<V>	getXKeys()
V	map(V element)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mdatools.modelant.core.operation.model.topology.EquivalenceClassesMap

getMappedRepresentatives, getRepresentatives, getRepresentativesOrSelf

Constructor Detail

EquivalenceClassesMapImpl

public EquivalenceClassesMapImpl()

Method Detail

add

public void add(Collection<V> xClass,
                Collection<V> yClass)

Description copied from interface: EquivalenceClassesMap

Register the X equivalence class mapped to Y equivalence class, Any existing mappings of the equivalence classes' elements are overridden.

Specified by:

add in interface EquivalenceClassesMap<V>

Parameters:

xClass - not null, not empty equivalence class at x side

yClass - not null, not empty equivalence class at y side

See Also:

EquivalenceClassesMap.add(java.util.Collection, java.util.Collection)

add

public final void add(V x,
                      V y)
               throws IllegalArgumentException

Description copied from interface: EquivalenceClassesMap

This method guarantees that each x or y objects pertain to no more than a single set and there is one-to-one mapping between these sets If there is a set containing y and there is no set containing x, then {x} is put as the set that is mapped to y; If there is a set containing x and there is no set containing y, then {y} is put as the set that is mapped to x; If there is no set containing x and there is no set containing y, then a new set {x} is created and mapped to the new set {y} If there is a set containing x A.K.A {x} and there is a set containing y A.K.A {y}, then if {x} not mapped to {y}, this method fails.

Specified by:

add in interface EquivalenceClassesMap<V>

Parameters:

x - not null, conditionally named key

y - not null, conditionally named value

Throws:

IllegalArgumentException - when mapping x,y that have already mapped representatives that do not match

See Also:

EquivalenceClassesMap.add(java.lang.Object, java.lang.Object)

getXKeys

public final Collection<V> getXKeys()

Specified by:

getXKeys in interface EquivalenceClassesMap<V>

Returns:

a non-null collection the representatives for elements X add(X,y) was called with.

See Also:

EquivalenceClassesMap.getXKeys()

getEquivalents

public final Collection<V> getEquivalents(V element)

Specified by:

getEquivalents in interface EquivalenceClassesMap<V>

Parameters:

element - is non-null

Returns:

a non-null collection of objects of the same equivalence class the element pertains to

See Also:

EquivalenceClassesMap.getEquivalents(java.lang.Object)

getRepresentative

public final V getRepresentative(V element)

Specified by:

getRepresentative in interface EquivalenceClassesMap<V>

Returns:

the element that represents the equivalence class this element pertains to

See Also:

EquivalenceClassesMap.getRepresentative(java.lang.Object)

map

public final V map(V element)

Specified by:

map in interface EquivalenceClassesMap<V>

Returns:

the element this element (any element of its equivalence class) is mapped to

See Also:

EquivalenceClassesMap.map(java.lang.Object)