org.jmlspecs.models
Class JMLObjectToEqualsMap

java.lang.Object
  org.jmlspecs.models.JMLObjectToEqualsRelation
      org.jmlspecs.models.JMLObjectToEqualsMap

All Implemented Interfaces:

Cloneable, JMLCollection, JMLType, Serializable

public class JMLObjectToEqualsMap

extends JMLObjectToEqualsRelation

Maps (i.e., binary relations that are functional) from non-null elements of Object to non-null elements of Object. The first type, Object, is called the domain type of the map; the second type, Object, is called the range type of the map. A map can be seen as a set of pairs, of form (dv, rv), consisting of an element of the domain type, dv, and an element of the range type, rv. Alternatively, it can be seen as a function that maps each element of the domain to some of elements of the range type.

This type is a subtype of JMLObjectToEqualsRelation, and as such as can be treated as a binary relation or a set valued function also. See the documentation for JMLObjectToEqualsRelation and for the methods inherited from this supertype for more information.

This type considers elements val and dv of the domain type, to be distinct just when _val_not_equal_to_dv_. It considers elements of r and rv of the range type to be distinct just when _r_not_equal_to_rv_. Cloning takes place for the domain or range elements if the corresponding domain or range type is JMLType.

Version:

$Revision: 1.34 $

Author:

Gary T. Leavens, Clyde Ruby

See Also:

JMLCollection, JMLType, JMLObjectToEqualsRelation, JMLObjectToEqualsRelationEnumerator, JMLObjectToEqualsRelationImageEnumerator, JMLValueSet, JMLObjectSet, JMLObjectToObjectMap, JMLValueToObjectMap, JMLObjectToValueMap, JMLValueToValueMap, JMLObjectToEqualsRelation.toFunction()

Field Summary
static JMLObjectToEqualsMap	EMPTY           The empty JMLObjectToEqualsMap.

 

Fields inherited from class org.jmlspecs.models.JMLObjectToEqualsRelation

domain_, imagePairSet_, size_, TOO_BIG_TO_UNION

 

Constructor Summary
	JMLObjectToEqualsMap()           Initialize this map to be the empty mapping.
	JMLObjectToEqualsMap(Object dv, Object rv)           Initialize this map to be a mapping that maps the given domain element to the given range element.
	JMLObjectToEqualsMap(JMLObjectEqualsPair pair)           Initialize this map to be a mapping that maps the key in the given pair to the value in that pair.
protected	JMLObjectToEqualsMap(JMLValueSet ipset, JMLObjectSet dom, int sz)           Initialize this map based on the representation values given.

 

Method Summary
Object	apply(Object dv)           Return the range element corresponding to dv, if there is one.
JMLObjectToEqualsMap	clashReplaceUnion(JMLObjectToEqualsMap othMap, Object errval)           Return a new map that is like the union of the given map and this map, except that if both define a mapping for a given domain element, then each of these clashes is replaced by a mapping from the domain element in question to the given range element.
Object	clone()           Return a clone of this object.
JMLObjectToEqualsMap	compose(JMLObjectToObjectMap othMap)           Return a new map that is the composition of this and the given map.
JMLValueToEqualsMap	compose(JMLValueToObjectMap othMap)           Return a new map that is the composition of this and the given map.
JMLObjectToEqualsMap	disjointUnion(JMLObjectToEqualsMap othMap)           Return a map that is the disjoint union of this and othMap.
JMLObjectToEqualsMap	extend(Object dv, Object rv)           Return a new map that is like this but maps the given domain element to the given range element.
JMLObjectToEqualsMap	extendUnion(JMLObjectToEqualsMap othMap)           Return a new map that is like the union of the given map and this map, except that if both define a mapping for a given domain element, then only the mapping in the given map is retained.
boolean	isaFunction()           Tells whether this relation is a function.
JMLObjectToEqualsMap	rangeRestrictedTo(JMLEqualsSet rng)           Return a new map that is like this map but only contains associations that map to range elements in the given set.
JMLObjectToEqualsMap	removeDomainElement(Object dv)           Return a new map that is like this but has no association for the given domain element.
JMLObjectToEqualsMap	restrictedTo(JMLObjectSet dom)           Return a new map that only maps elements in the given domain to the corresponding range elements in this map.
static JMLObjectToEqualsMap	singletonMap(Object dv, Object rv)           Return the singleton map containing the given association.
static JMLObjectToEqualsMap	singletonMap(JMLObjectEqualsPair pair)           Return the singleton map containing the association described by the given pair.

 

Methods inherited from class org.jmlspecs.models.JMLObjectToEqualsRelation

add, associations, compose, compose, difference, domain, domainElements, elementImage, elements, equals, has, has, has, hashCode, image, imagePairs, imagePairSet, insert, int_size, intersection, inverse, inverseElementImage, inverseImage, isDefinedAt, isEmpty, iterator, range, rangeElements, remove, remove, removeFromDomain, restrictDomainTo, restrictRangeTo, singleton, singleton, toBag, toFunction, toSequence, toSet, toString, union

 

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

EMPTY

public static final JMLObjectToEqualsMap EMPTY

The empty JMLObjectToEqualsMap.

See Also:

JMLObjectToEqualsMap()

JMLObjectToEqualsMap

public JMLObjectToEqualsMap()

Initialize this map to be the empty mapping.

See Also:

EMPTY

JMLObjectToEqualsMap

public JMLObjectToEqualsMap(Object dv,
                            Object rv)

Initialize this map to be a mapping that maps the given domain element to the given range element.

See Also:

singletonMap(Object, Object), JMLObjectToEqualsMap(JMLObjectEqualsPair)

JMLObjectToEqualsMap

public JMLObjectToEqualsMap(JMLObjectEqualsPair pair)

Initialize this map to be a mapping that maps the key in the given pair to the value in that pair.

See Also:

singletonMap(JMLObjectEqualsPair), JMLObjectToEqualsMap(Object, Object)

JMLObjectToEqualsMap

protected JMLObjectToEqualsMap(JMLValueSet ipset,
                               JMLObjectSet dom,
                               int sz)

Initialize this map based on the representation values given.

singletonMap

public static JMLObjectToEqualsMap singletonMap(Object dv,
                                                Object rv)

Return the singleton map containing the given association.

See Also:

JMLObjectToEqualsMap(Object, Object), singletonMap(JMLObjectEqualsPair)

singletonMap

public static JMLObjectToEqualsMap singletonMap(JMLObjectEqualsPair pair)

Return the singleton map containing the association described by the given pair.

See Also:

JMLObjectToEqualsMap(JMLObjectEqualsPair), singletonMap(Object, Object)

isaFunction

public boolean isaFunction()

Tells whether this relation is a function.

Overrides:

isaFunction in class JMLObjectToEqualsRelation

apply

public Object apply(Object dv)
             throws JMLNoSuchElementException

Return the range element corresponding to dv, if there is one.

Parameters:

dv - the domain element for which an association is sought (the key to the table).

Throws:

JMLNoSuchElementException - when dv is not associated to any range element by this.

See Also:

JMLObjectToEqualsRelation.isDefinedAt(java.lang.Object), JMLObjectToEqualsRelation.elementImage(java.lang.Object), JMLObjectToEqualsRelation.image(org.jmlspecs.models.JMLObjectSet)

clone

public Object clone()

Description copied from class: JMLObjectToEqualsRelation

Return a clone of this object.

Specified by:

clone in interface JMLType

Overrides:

clone in class JMLObjectToEqualsRelation

extend

public JMLObjectToEqualsMap extend(Object dv,
                                   Object rv)

Return a new map that is like this but maps the given domain element to the given range element. Any previously existing mapping for the domain element is removed first.

See Also:

JMLObjectToEqualsRelation#insert(Object, Object)

removeDomainElement

public JMLObjectToEqualsMap removeDomainElement(Object dv)

Return a new map that is like this but has no association for the given domain element.

See Also:

JMLObjectToEqualsRelation.removeFromDomain(java.lang.Object)

compose

public JMLValueToEqualsMap compose(JMLValueToObjectMap othMap)

Return a new map that is the composition of this and the given map. The composition is done in the usual order; that is, if the given map maps x to y and this maps y to z, then the result maps x to z.

See Also:

compose(JMLObjectToObjectMap)

compose

public JMLObjectToEqualsMap compose(JMLObjectToObjectMap othMap)

Return a new map that is the composition of this and the given map. The composition is done in the usual order; that is, if the given map maps x to y and this maps y to z, then the result maps x to z.

See Also:

compose(JMLValueToObjectMap)

restrictedTo

public JMLObjectToEqualsMap restrictedTo(JMLObjectSet dom)

Return a new map that only maps elements in the given domain to the corresponding range elements in this map.

See Also:

rangeRestrictedTo(org.jmlspecs.models.JMLEqualsSet), JMLObjectToEqualsRelation.restrictDomainTo(org.jmlspecs.models.JMLObjectSet)

rangeRestrictedTo

public JMLObjectToEqualsMap rangeRestrictedTo(JMLEqualsSet rng)

Return a new map that is like this map but only contains associations that map to range elements in the given set.

See Also:

restrictedTo(org.jmlspecs.models.JMLObjectSet), JMLObjectToEqualsRelation.restrictRangeTo(org.jmlspecs.models.JMLEqualsSet)

extendUnion

public JMLObjectToEqualsMap extendUnion(JMLObjectToEqualsMap othMap)
                                 throws IllegalStateException

Return a new map that is like the union of the given map and this map, except that if both define a mapping for a given domain element, then only the mapping in the given map is retained.

Throws:

IllegalStateException

See Also:

clashReplaceUnion(org.jmlspecs.models.JMLObjectToEqualsMap, java.lang.Object), disjointUnion(org.jmlspecs.models.JMLObjectToEqualsMap), JMLObjectToEqualsRelation.union(org.jmlspecs.models.JMLObjectToEqualsRelation)

clashReplaceUnion

public JMLObjectToEqualsMap clashReplaceUnion(JMLObjectToEqualsMap othMap,
                                              Object errval)
                                       throws IllegalStateException

Return a new map that is like the union of the given map and this map, except that if both define a mapping for a given domain element, then each of these clashes is replaced by a mapping from the domain element in question to the given range element.

Parameters:

othMap - the other map.

errval - the range element to use when clashes occur.

Throws:

IllegalStateException

See Also:

extendUnion(org.jmlspecs.models.JMLObjectToEqualsMap), disjointUnion(org.jmlspecs.models.JMLObjectToEqualsMap), JMLObjectToEqualsRelation.union(org.jmlspecs.models.JMLObjectToEqualsRelation)

disjointUnion

public JMLObjectToEqualsMap disjointUnion(JMLObjectToEqualsMap othMap)
                                   throws JMLMapException,
                                          IllegalStateException

Return a map that is the disjoint union of this and othMap.

Parameters:

othMap - the other mapping

Throws:

JMLMapException - the ranges of this and othMap have elements in common (i.e., when they interesect).

IllegalStateException

See Also:

extendUnion(org.jmlspecs.models.JMLObjectToEqualsMap), clashReplaceUnion(org.jmlspecs.models.JMLObjectToEqualsMap, java.lang.Object), JMLObjectToEqualsRelation.union(org.jmlspecs.models.JMLObjectToEqualsRelation)