org.jmlspecs.models
Class JMLObjectToValueMap

java.lang.Object
  org.jmlspecs.models.JMLObjectToValueRelation
      org.jmlspecs.models.JMLObjectToValueMap

All Implemented Interfaces:

Cloneable, JMLCollection, JMLType, Serializable

public class JMLObjectToValueMap

extends JMLObjectToValueRelation

Maps (i.e., binary relations that are functional) from non-null elements of Object to non-null elements of JMLType. The first type, Object, is called the domain type of the map; the second type, JMLType, 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 JMLObjectToValueRelation, and as such as can be treated as a binary relation or a set valued function also. See the documentation for JMLObjectToValueRelation 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, JMLObjectToValueRelation, JMLObjectToValueRelationEnumerator, JMLObjectToValueRelationImageEnumerator, JMLValueSet, JMLObjectSet, JMLObjectToObjectMap, JMLValueToObjectMap, JMLObjectToValueMap, JMLValueToValueMap, JMLObjectToValueRelation.toFunction()

Field Summary
static JMLObjectToValueMap	EMPTY           The empty JMLObjectToValueMap.

 

Fields inherited from class org.jmlspecs.models.JMLObjectToValueRelation

domain_, imagePairSet_, size_, TOO_BIG_TO_UNION

 

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

 

Method Summary
JMLType	apply(Object dv)           Return the range element corresponding to dv, if there is one.
JMLObjectToValueMap	clashReplaceUnion(JMLObjectToValueMap othMap, JMLType 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.
JMLObjectToValueMap	compose(JMLObjectToObjectMap othMap)           Return a new map that is the composition of this and the given map.
JMLValueToValueMap	compose(JMLValueToObjectMap othMap)           Return a new map that is the composition of this and the given map.
JMLObjectToValueMap	disjointUnion(JMLObjectToValueMap othMap)           Return a map that is the disjoint union of this and othMap.
JMLObjectToValueMap	extend(Object dv, JMLType rv)           Return a new map that is like this but maps the given domain element to the given range element.
JMLObjectToValueMap	extendUnion(JMLObjectToValueMap 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.
JMLObjectToValueMap	rangeRestrictedTo(JMLValueSet rng)           Return a new map that is like this map but only contains associations that map to range elements in the given set.
JMLObjectToValueMap	removeDomainElement(Object dv)           Return a new map that is like this but has no association for the given domain element.
JMLObjectToValueMap	restrictedTo(JMLObjectSet dom)           Return a new map that only maps elements in the given domain to the corresponding range elements in this map.
static JMLObjectToValueMap	singletonMap(Object dv, JMLType rv)           Return the singleton map containing the given association.
static JMLObjectToValueMap	singletonMap(JMLObjectValuePair pair)           Return the singleton map containing the association described by the given pair.

 

Methods inherited from class org.jmlspecs.models.JMLObjectToValueRelation

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 JMLObjectToValueMap EMPTY

The empty JMLObjectToValueMap.

See Also:

JMLObjectToValueMap()

JMLObjectToValueMap

public JMLObjectToValueMap()

Initialize this map to be the empty mapping.

See Also:

EMPTY

JMLObjectToValueMap

public JMLObjectToValueMap(Object dv,
                           JMLType rv)

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

See Also:

singletonMap(Object, JMLType), JMLObjectToValueMap(JMLObjectValuePair)

JMLObjectToValueMap

public JMLObjectToValueMap(JMLObjectValuePair 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(JMLObjectValuePair), JMLObjectToValueMap(Object, JMLType)

JMLObjectToValueMap

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

Initialize this map based on the representation values given.

singletonMap

public static JMLObjectToValueMap singletonMap(Object dv,
                                               JMLType rv)

Return the singleton map containing the given association.

See Also:

JMLObjectToValueMap(Object, JMLType), singletonMap(JMLObjectValuePair)

singletonMap

public static JMLObjectToValueMap singletonMap(JMLObjectValuePair pair)

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

See Also:

JMLObjectToValueMap(JMLObjectValuePair), singletonMap(Object, JMLType)

isaFunction

public boolean isaFunction()

Tells whether this relation is a function.

Overrides:

isaFunction in class JMLObjectToValueRelation

apply

public JMLType 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:

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

clone

public Object clone()

Description copied from class: JMLObjectToValueRelation

Return a clone of this object.

Specified by:

clone in interface JMLType

Overrides:

clone in class JMLObjectToValueRelation

extend

public JMLObjectToValueMap extend(Object dv,
                                  JMLType 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:

JMLObjectToValueRelation#insert(Object, JMLType)

removeDomainElement

public JMLObjectToValueMap removeDomainElement(Object dv)

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

See Also:

JMLObjectToValueRelation.removeFromDomain(java.lang.Object)

compose

public JMLValueToValueMap 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 JMLObjectToValueMap 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 JMLObjectToValueMap 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.JMLValueSet), JMLObjectToValueRelation.restrictDomainTo(org.jmlspecs.models.JMLObjectSet)

rangeRestrictedTo

public JMLObjectToValueMap rangeRestrictedTo(JMLValueSet 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), JMLObjectToValueRelation.restrictRangeTo(org.jmlspecs.models.JMLValueSet)

extendUnion

public JMLObjectToValueMap extendUnion(JMLObjectToValueMap 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.JMLObjectToValueMap, org.jmlspecs.models.JMLType), disjointUnion(org.jmlspecs.models.JMLObjectToValueMap), JMLObjectToValueRelation.union(org.jmlspecs.models.JMLObjectToValueRelation)

clashReplaceUnion

public JMLObjectToValueMap clashReplaceUnion(JMLObjectToValueMap othMap,
                                             JMLType 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.JMLObjectToValueMap), disjointUnion(org.jmlspecs.models.JMLObjectToValueMap), JMLObjectToValueRelation.union(org.jmlspecs.models.JMLObjectToValueRelation)

disjointUnion

public JMLObjectToValueMap disjointUnion(JMLObjectToValueMap 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.JMLObjectToValueMap), clashReplaceUnion(org.jmlspecs.models.JMLObjectToValueMap, org.jmlspecs.models.JMLType), JMLObjectToValueRelation.union(org.jmlspecs.models.JMLObjectToValueRelation)