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

Interface EquivalenceClassesMap<V>

Type Parameters:

V - the class of the elements in the mapped sets.

All Known Implementing Classes:

EquivalenceClassesMapImpl

public interface EquivalenceClassesMap<V>

A mechanism to map sets 1:1 to other sets. All sets do not intersect. The mapping is symmetric, allowing

   map(getRepresentative(a))=getRepresentative(b)
   map(getRepresentative(b))=getRepresentative(a)
 

Author:

Rusi Popov (popovr@mdatools.net)

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)
default Set<V>	getMappedRepresentatives(Collection<V> elements)
V	getRepresentative(V element)
default Set<V>	getRepresentatives(Collection<V> elements)
default Set<V>	getRepresentativesOrSelf(Collection<V> elements)
Collection<V>	getXKeys()
V	map(V element)

Method Detail

add

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.

Parameters:

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

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

add

void add(V x,
         V y)
  throws IllegalArgumentException

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.

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

getXKeys

Collection<V> getXKeys()

Returns:

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

getEquivalents

Collection<V> getEquivalents(V element)

Parameters:

element - is non-null

Returns:

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

getRepresentative

V getRepresentative(V element)

Parameters:

element -

Returns:

the element that represents the equivalence class this element pertains to

map

V map(V element)

Parameters:

element -

Returns:

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

getRepresentativesOrSelf

default Set<V> getRepresentativesOrSelf(Collection<V> elements)

Parameters:

elements - non null collection

Returns:

a collection of their representatives or the objects themselves, if they have not been matched in the target model and therefore have no representatives

getMappedRepresentatives

default Set<V> getMappedRepresentatives(Collection<V> elements)

Parameters:

elements - not null

Returns:

a non-null set of the elements are mapped on. Mapped nulls are skipped.

getRepresentatives

default Set<V> getRepresentatives(Collection<V> elements)

Parameters:

elements - non null collection

Returns:

a collection of their representatives. null representatives are skipped