Java Doc for JMLObjectToEqualsRelation.java in  » Testing » KeY » org » jmlspecs » models » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Testing » KeY » org.jmlspecs.models 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

All known Subclasses:   org.jmlspecs.models.JMLObjectToEqualsMap,
JMLObjectToEqualsRelation
public class JMLObjectToEqualsRelation implements JMLCollection(Code)
Binary relations (or set-valued functions) from non-null elements of Object to non-null elements of Object . The first type, Object, is called the domain type of the relation; the second type, Object, is called the range type of the relation. A relation 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 set-valued function that relates each element of the domain type to some set of elements of the range type (a JMLEqualsSet ).

This type considers elements val and dv of the domain type, to be distinct just when val != dv. It considers elements of r and rv of the range type to be distinct just when !r.equals(rv). Cloning takes place for the domain or range elements if the corresponding domain or range type is JMLType .
version:
   $Revision: 1.1.1.1 $
author:
   Gary T. Leavens
author:
   Clyde Ruby
See Also:   JMLCollection
See Also:   JMLType
See Also:   JMLObjectToEqualsMap
See Also:   JMLObjectToEqualsRelationEnumerator
See Also:   JMLObjectToEqualsRelationImageEnumerator
See Also:   JMLValueSet
See Also:   JMLObjectSet
See Also:   JMLObjectToObjectRelation
See Also:   JMLValueToObjectRelation
See Also:   JMLObjectToValueRelation
See Also:   JMLValueToValueRelation



Field Summary
final public static  JMLObjectToEqualsRelationEMPTY
     The empty JMLObjectToEqualsRelation.
final protected static  StringTOO_BIG_TO_UNION
    
final protected  JMLObjectSetdomain_
     The set of elements in the domain of this relation.
final protected  JMLValueSetimagePairSet_
     The set representing the image pairs in the relation.
final protected  intsize_
     The size (number of pairs) of this relation.

Constructor Summary
public  JMLObjectToEqualsRelation()
     Initialize this to be an empty relation.
public  JMLObjectToEqualsRelation(Object dv, Object rv)
     Initialize this to be a relation containing a single association between the given domain and range elements.
public  JMLObjectToEqualsRelation(JMLObjectEqualsPair pair)
     Initialize this to be a relation containing a single association given by the pair.
protected  JMLObjectToEqualsRelation(JMLValueSet ipset, JMLObjectSet dom, int sz)
     Initialize this using the given representation.

Method Summary
public  JMLObjectToEqualsRelationadd(Object dv, Object rv)
     Return a relation that is just like this relation, except that it also associates the given domain element to the given range element.
public  JMLObjectToEqualsRelationEnumeratorassociations()
     Return a enumerator for the set of associations that conceptually make up this relation.
public  Objectclone()
     Return a clone of this object.
public  JMLValueToEqualsRelationcompose(JMLValueToObjectRelation othRel)
     Return a relation that is the composition of the given relation and this relation.
public  JMLObjectToEqualsRelationcompose(JMLObjectToObjectRelation othRel)
     Return a relation that is the composition of the given relation and this relation.
public  JMLObjectToEqualsRelationdifference(JMLObjectToEqualsRelation othRel)
     Return a relation that is the difference between this and the given relation.
public  JMLObjectSetdomain()
     Returns a set containing the domain of this relation.
public  JMLObjectSetEnumeratordomainElements()
     Return a enumerator for the set that is the domain of this relation.
public  JMLEqualsSetelementImage(Object dv)
     Returns a set containing all the range elements that this relation relates to the given domain element.
public  JMLObjectToEqualsRelationEnumeratorelements()
     Return a enumerator for the set of associations that conceptually make up this relation.
public  booleanequals(Object obj)
     Test whether this object's value is equal to the given argument.
public  booleanhas(Object dv, Object rv)
     Tells whether this associates the given key to the given value.
public  booleanhas(JMLObjectEqualsPair pair)
     Tells whether this associates the given key to the given value.
public  booleanhas(Object obj)
     Tells whether this associates the given key to the given value.
public  inthashCode()
     Return a hash code for this object.
public  JMLEqualsSetimage(JMLObjectSet dom)
     Returns a set containing all the range elements that this relation relates to the elements of the given set of domain elements.
public  JMLValueSetimagePairSet()
     Return the set of image set pairs that make up this relation.
public  JMLObjectToEqualsRelationImageEnumeratorimagePairs()
     Return the set of domain image set pairs that make up this relation.
public  JMLObjectToEqualsRelationinsert(JMLObjectEqualsPair pair)
     Return a relation that is just like this relation, except that it also includes the association described by the given pair.
public  intint_size()
     Return the number of associations in this relation.
public  JMLObjectToEqualsRelationintersection(JMLObjectToEqualsRelation othRel)
     Return a relation that is the intersection of this and the given relation.
public  JMLEqualsToObjectRelationinverse()
     Returns the inverse of this relation.
public  JMLObjectSetinverseElementImage(Object rv)
     Return a set of all the domain elements that relate to the given range element.
public  JMLObjectSetinverseImage(JMLEqualsSet rng)
     Return a set of all the domain elements that relate to some element in the given set of range elements.
public  booleanisDefinedAt(Object dv)
     Tells whether this relation associates any range element to the given domain element.
public  booleanisEmpty()
     Tells whether the relation is empty.
public  booleanisaFunction()
     Tells whether this relation is a function.
public  JMLIteratoriterator()
     Returns an Iterator over the set of pairs conceptually contained in this relation..
public  JMLEqualsSetrange()
     Returns a set containing the range of this relation.
public  JMLEqualsSetEnumeratorrangeElements()
     Return a enumerator for the set that is the range of this relation.
public  JMLObjectToEqualsRelationremove(Object dv, Object rv)
     Return a relation that is just like this relation, except that it does not contain the association, if any, between the given domain and range elements.
public  JMLObjectToEqualsRelationremove(JMLObjectEqualsPair pair)
     Return a relation that is just like this relation, except that it does not contain association described by the given pair.
public  JMLObjectToEqualsRelationremoveFromDomain(Object dv)
     Return a relation that is just like this relation, except that it does not contain any association with the given domain element.
public  JMLObjectToEqualsRelationrestrictDomainTo(JMLObjectSet dom)
     Return a relation that is like this relation except that its domain is limited to just the elements of the given set.
public  JMLObjectToEqualsRelationrestrictRangeTo(JMLEqualsSet rng)
     Return a relation that is like this relation except that its range is limited to just the elements of the given set.
public static  JMLObjectToEqualsRelationsingleton(Object dv, Object rv)
     Return the singleton relation containing the given association.
public static  JMLObjectToEqualsRelationsingleton(JMLObjectEqualsPair pair)
     Return the singleton relation containing the association described by the given pair.
public  JMLValueBagtoBag()
     Return the bag of all associations in this relation.
public  JMLObjectToEqualsMaptoFunction()
     Return a map that is contained in this relation.
public  JMLValueSequencetoSequence()
     Return a sequence containing all associations in this relation.
public  JMLValueSettoSet()
     Return the set of all associations in this relation.
public  StringtoString()
     Return a string representation of this object.
public  JMLObjectToEqualsRelationunion(JMLObjectToEqualsRelation othRel)
     Return a relation that union of the this and the given relation.

Field Detail
EMPTY
final public static JMLObjectToEqualsRelation EMPTY(Code)
The empty JMLObjectToEqualsRelation.
See Also:   JMLObjectToEqualsRelation.JMLObjectToEqualsRelation()



TOO_BIG_TO_UNION
final protected static String TOO_BIG_TO_UNION(Code)



domain_
final protected JMLObjectSet domain_(Code)
The set of elements in the domain of this relation.



imagePairSet_
final protected JMLValueSet imagePairSet_(Code)
The set representing the image pairs in the relation. The elements of this set are JMLObjectValuePairs, which are all non-null. Each such pair has a key which is an element in domain_ and a value which is a JMLEqualsSet containing all of the elements that the key of the pair is related to.



size_
final protected int size_(Code)
The size (number of pairs) of this relation.




Constructor Detail
JMLObjectToEqualsRelation
public JMLObjectToEqualsRelation()(Code)
Initialize this to be an empty relation. That is, the value is an empty set of pairs.
See Also:   JMLObjectToEqualsRelation.EMPTY



JMLObjectToEqualsRelation
public JMLObjectToEqualsRelation(Object dv, Object rv)(Code)
Initialize this to be a relation containing a single association between the given domain and range elements.
See Also:   JMLObjectToEqualsRelation.singleton(Object,Object)
See Also:   JMLObjectToEqualsRelation.JMLObjectToEqualsRelation(JMLObjectEqualsPair)



JMLObjectToEqualsRelation
public JMLObjectToEqualsRelation(JMLObjectEqualsPair pair)(Code)
Initialize this to be a relation containing a single association given by the pair.
See Also:   JMLObjectToEqualsRelation.singleton(JMLObjectEqualsPair)
See Also:   JMLObjectToEqualsRelation.JMLObjectToEqualsRelation(Object,Object)



JMLObjectToEqualsRelation
protected JMLObjectToEqualsRelation(JMLValueSet ipset, JMLObjectSet dom, int sz)(Code)
Initialize this using the given representation.




Method Detail
add
public JMLObjectToEqualsRelation add(Object dv, Object rv) throws NullPointerException, IllegalStateException(Code)
Return a relation that is just like this relation, except that it also associates the given domain element to the given range element.
See Also:   JMLObjectToEqualsRelation.insert



associations
public JMLObjectToEqualsRelationEnumerator associations()(Code)
Return a enumerator for the set of associations that conceptually make up this relation.
See Also:   JMLObjectToEqualsRelation.elements()
See Also:   JMLObjectToEqualsRelation.iterator()
See Also:   JMLObjectToEqualsRelation.toSet()
See Also:   JMLObjectToEqualsRelation.imagePairs()



clone
public Object clone()(Code)
Return a clone of this object.



compose
public JMLValueToEqualsRelation compose(JMLValueToObjectRelation othRel)(Code)
Return a relation that is the composition of the given relation and this relation. The composition is done in the "usual" order, so that if the given relation relates x to y, and this relation relates y to z, then the result relates x to z.
See Also:   JMLObjectToEqualsRelation.compose(JMLObjectToObjectRelation)



compose
public JMLObjectToEqualsRelation compose(JMLObjectToObjectRelation othRel)(Code)
Return a relation that is the composition of the given relation and this relation. The composition is done in the "usual" order, so that if the given relation relates x to y, and this relation relates y to z, then the result relates x to z.
See Also:   JMLObjectToEqualsRelation.compose(JMLValueToObjectRelation)



difference
public JMLObjectToEqualsRelation difference(JMLObjectToEqualsRelation othRel)(Code)
Return a relation that is the difference between this and the given relation. This is the difference between the sets of associations.
See Also:   JMLObjectToEqualsRelation.difference
See Also:   JMLObjectToEqualsRelation.intersection



domain
public JMLObjectSet domain()(Code)
Returns a set containing the domain of this relation.
See Also:   JMLObjectToEqualsRelation.domainElements()
See Also:   JMLObjectToEqualsRelation.associations()
See Also:   JMLObjectToEqualsRelation.isDefinedAt
See Also:   JMLObjectToEqualsRelation.image
See Also:   JMLObjectToEqualsRelation.range()
See Also:   JMLObjectToEqualsRelation.inverse()



domainElements
public JMLObjectSetEnumerator domainElements()(Code)
Return a enumerator for the set that is the domain of this relation.
See Also:   JMLObjectToEqualsRelation.domain()
See Also:   JMLObjectToEqualsRelation.rangeElements()



elementImage
public JMLEqualsSet elementImage(Object dv)(Code)
Returns a set containing all the range elements that this relation relates to the given domain element.
See Also:   JMLObjectToEqualsRelation.image
See Also:   JMLObjectToEqualsMap.apply



elements
public JMLObjectToEqualsRelationEnumerator elements()(Code)
Return a enumerator for the set of associations that conceptually make up this relation. This is a synonym for associations.
See Also:   JMLObjectToEqualsRelation.associations()
See Also:   JMLObjectToEqualsRelation.iterator()



equals
public boolean equals(Object obj)(Code)
Test whether this object's value is equal to the given argument.



has
public boolean has(Object dv, Object rv)(Code)
Tells whether this associates the given key to the given value.
See Also:   JMLObjectToEqualsRelation.isDefinedAt
See Also:   JMLObjectToEqualsRelation.has(JMLObjectEqualsPair)



has
public boolean has(JMLObjectEqualsPair pair)(Code)
Tells whether this associates the given key to the given value.
See Also:   JMLObjectToEqualsRelation.isDefinedAt
See Also:   JMLObjectToEqualsRelation.has(Object,Object)



has
public boolean has(Object obj)(Code)
Tells whether this associates the given key to the given value.
See Also:   JMLObjectToEqualsRelation.isDefinedAt
See Also:   JMLObjectToEqualsRelation.has(JMLObjectEqualsPair)



hashCode
public int hashCode()(Code)
Return a hash code for this object.



image
public JMLEqualsSet image(JMLObjectSet dom)(Code)
Returns a set containing all the range elements that this relation relates to the elements of the given set of domain elements.
See Also:   JMLObjectToEqualsRelation.elementImage
See Also:   JMLObjectToEqualsRelation.inverseImage
See Also:   JMLObjectToEqualsMap.apply



imagePairSet
public JMLValueSet imagePairSet()(Code)
Return the set of image set pairs that make up this relation.
See Also:   JMLObjectToEqualsRelation.imagePairs()
See Also:   JMLObjectToEqualsRelation.toSet()



imagePairs
public JMLObjectToEqualsRelationImageEnumerator imagePairs()(Code)
Return the set of domain image set pairs that make up this relation.
See Also:   JMLObjectToEqualsRelation.imagePairSet()
See Also:   JMLObjectToEqualsRelation.associations()
See Also:   JMLObjectToEqualsRelation.toSet()



insert
public JMLObjectToEqualsRelation insert(JMLObjectEqualsPair pair) throws IllegalStateException(Code)
Return a relation that is just like this relation, except that it also includes the association described by the given pair.
See Also:   JMLObjectToEqualsRelation.add



int_size
public int int_size()(Code)
Return the number of associations in this relation.



intersection
public JMLObjectToEqualsRelation intersection(JMLObjectToEqualsRelation othRel)(Code)
Return a relation that is the intersection of this and the given relation. This is the intersection of the sets of associations.
See Also:   JMLObjectToEqualsRelation.difference
See Also:   JMLObjectToEqualsRelation.union



inverse
public JMLEqualsToObjectRelation inverse()(Code)
Returns the inverse of this relation. The inverse is the relation that relates each range element to the corresponding domain element.
See Also:   JMLObjectToEqualsRelation.inverseImage
See Also:   JMLObjectToEqualsRelation.inverseElementImage



inverseElementImage
public JMLObjectSet inverseElementImage(Object rv)(Code)
Return a set of all the domain elements that relate to the given range element.
See Also:   JMLObjectToEqualsRelation.inverseImage
See Also:   JMLObjectToEqualsRelation.inverse
See Also:   JMLObjectToEqualsRelation.elementImage



inverseImage
public JMLObjectSet inverseImage(JMLEqualsSet rng)(Code)
Return a set of all the domain elements that relate to some element in the given set of range elements.
See Also:   JMLObjectToEqualsRelation.inverseElementImage
See Also:   JMLObjectToEqualsRelation.inverse
See Also:   JMLObjectToEqualsRelation.image



isDefinedAt
public boolean isDefinedAt(Object dv)(Code)
Tells whether this relation associates any range element to the given domain element.
See Also:   JMLObjectToEqualsRelation.domain()



isEmpty
public boolean isEmpty()(Code)
Tells whether the relation is empty.
See Also:   JMLObjectToEqualsRelation.int_size()



isaFunction
public boolean isaFunction()(Code)
Tells whether this relation is a function.
See Also:   JMLObjectToEqualsMap



iterator
public JMLIterator iterator()(Code)
Returns an Iterator over the set of pairs conceptually contained in this relation..
See Also:   JMLObjectToEqualsRelation.associations()
See Also:   JMLObjectToEqualsRelation.elements()



range
public JMLEqualsSet range()(Code)
Returns a set containing the range of this relation.
See Also:   JMLObjectToEqualsRelation.rangeElements()
See Also:   JMLObjectToEqualsRelation.associations()
See Also:   JMLObjectToEqualsRelation.inverseElementImage
See Also:   JMLObjectToEqualsRelation.domain()
See Also:   JMLObjectToEqualsRelation.inverse()



rangeElements
public JMLEqualsSetEnumerator rangeElements()(Code)
Return a enumerator for the set that is the range of this relation. (This was formerly called "elements").
See Also:   JMLObjectToEqualsRelation.range()
See Also:   JMLObjectToEqualsRelation.domainElements()



remove
public JMLObjectToEqualsRelation remove(Object dv, Object rv)(Code)
Return a relation that is just like this relation, except that it does not contain the association, if any, between the given domain and range elements.
See Also:   JMLObjectToEqualsRelation.removeFromDomain
See Also:   JMLObjectToEqualsRelation.remove(Object,Object)
See Also:   JMLObjectToEqualsRelation.remove(JMLObjectEqualsPair)



remove
public JMLObjectToEqualsRelation remove(JMLObjectEqualsPair pair)(Code)
Return a relation that is just like this relation, except that it does not contain association described by the given pair.
See Also:   JMLObjectToEqualsRelation.remove(Object,Object)
See Also:   JMLObjectToEqualsRelation.removeFromDomain



removeFromDomain
public JMLObjectToEqualsRelation removeFromDomain(Object dv)(Code)
Return a relation that is just like this relation, except that it does not contain any association with the given domain element.
See Also:   JMLObjectToEqualsRelation.remove(JMLObjectEqualsPair)
See Also:   JMLObjectToEqualsRelation.removeFromDomain



restrictDomainTo
public JMLObjectToEqualsRelation restrictDomainTo(JMLObjectSet dom)(Code)
Return a relation that is like this relation except that its domain is limited to just the elements of the given set.
See Also:   JMLObjectToEqualsRelation.restrictRangeTo



restrictRangeTo
public JMLObjectToEqualsRelation restrictRangeTo(JMLEqualsSet rng)(Code)
Return a relation that is like this relation except that its range is limited to just the elements of the given set.
See Also:   JMLObjectToEqualsRelation.restrictDomainTo



singleton
public static JMLObjectToEqualsRelation singleton(Object dv, Object rv)(Code)
Return the singleton relation containing the given association.
See Also:   JMLObjectToEqualsRelation.singleton(JMLObjectEqualsPair)
See Also:   JMLObjectToEqualsRelation.JMLObjectToEqualsRelation(Object,Object)



singleton
public static JMLObjectToEqualsRelation singleton(JMLObjectEqualsPair pair)(Code)
Return the singleton relation containing the association described by the given pair.
See Also:   JMLObjectToEqualsRelation.singleton(Object,Object)
See Also:   JMLObjectToEqualsRelation.JMLObjectToEqualsRelation(JMLObjectEqualsPair)



toBag
public JMLValueBag toBag()(Code)
Return the bag of all associations in this relation.
See Also:   JMLObjectToEqualsRelation.toSet()
See Also:   JMLObjectToEqualsRelation.toSequence()



toFunction
public JMLObjectToEqualsMap toFunction()(Code)
Return a map that is contained in this relation. If this relation is a function, then this method can be seen as a type conversion which does not make a change to the abstract value. However, if this relation is not a function, then this method chooses a function contained in this relation from among the possibilities available.
See Also:   JMLObjectToEqualsRelation.isaFunction
See Also:   JMLObjectToEqualsMap



toSequence
public JMLValueSequence toSequence()(Code)
Return a sequence containing all associations in this relation.
See Also:   JMLObjectToEqualsRelation.toSet()
See Also:   JMLObjectToEqualsRelation.toBag()



toSet
public JMLValueSet toSet()(Code)
Return the set of all associations in this relation.
See Also:   JMLObjectToEqualsRelation.associations()
See Also:   JMLObjectToEqualsRelation.toBag()
See Also:   JMLObjectToEqualsRelation.toSequence()



toString
public String toString()(Code)
Return a string representation of this object.



union
public JMLObjectToEqualsRelation union(JMLObjectToEqualsRelation othRel) throws IllegalStateException(Code)
Return a relation that union of the this and the given relation. This is the union of the sets of associations.
See Also:   JMLObjectToEqualsRelation.difference
See Also:   JMLObjectToEqualsRelation.intersection



Methods inherited from java.lang.Object
protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object o)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
final public void notify() throws IllegalMonitorStateException(Code)(Java Doc)
final public void notifyAll() throws IllegalMonitorStateException(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final public void wait() throws IllegalMonitorStateException, InterruptedException(Code)(Java Doc)
final public void wait(long ms) throws IllegalMonitorStateException, InterruptedException(Code)(Java Doc)
final public void wait(long ms, int ns) throws IllegalMonitorStateException, InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.