org.odmg
Interface DSet

All Superinterfaces:

java.util.Collection, DCollection, java.lang.Iterable, java.util.Set

public interface DSet
extends DCollection, java.util.Set

The ODMG Set collection interface. A DSet object is an unordered collection that does not support multiple elements with the same value. An implementation typically is very efficient at determining whether the collection contains a particular value.

All of the operations defined by the JavaSoft Set interface are supported by an ODMG implementation of DSet, the exception UnsupportedOperationException is not thrown when a call is made to any of the Set methods.

Version:

ODMG 3.0

Author:

David Jordan (as Java Editor of the Object Data Management Group)

Method Summary

DSet	difference(DSet otherSet) Create a new DSet object that contains the elements of this collection minus the elements in otherSet.
DSet	intersection(DSet otherSet) Create a new DSet object that is the set intersection of this DSet object and the set referenced by otherSet.
boolean	properSubsetOf(DSet otherSet) Determine whether this set is a proper subset of the set referenced by otherSet.
boolean	properSupersetOf(DSet otherSet) Determine whether this set is a proper superset of the set referenced by otherSet.
boolean	subsetOf(DSet otherSet) Determine whether this set is a subset of the set referenced by otherSet.
boolean	supersetOf(DSet otherSet) Determine whether this set is a superset of the set referenced by otherSet.
DSet	union(DSet otherSet) Create a new DSet object that is the set union of this DSet object and the set referenced by otherSet.

Methods inherited from interface org.odmg.DCollection

existsElement, query, select, selectElement

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

union

DSet union(DSet otherSet)

Create a new DSet object that is the set union of this DSet object and the set referenced by otherSet.

Parameters:

otherSet - The other set to be used in the union operation.

Returns:

A newly created DSet instance that contains the union of the two sets.

intersection

DSet intersection(DSet otherSet)

Create a new DSet object that is the set intersection of this DSet object and the set referenced by otherSet.

Parameters:

otherSet - The other set to be used in the intersection operation.

Returns:

A newly created DSet instance that contains the intersection of the two sets.

difference

DSet difference(DSet otherSet)

Create a new DSet object that contains the elements of this collection minus the elements in otherSet.

Parameters:

otherSet - A set containing elements that should not be in the result set.

Returns:

A newly created DSet instance that contains the elements of this set minus those elements in otherSet.

subsetOf

boolean subsetOf(DSet otherSet)

Determine whether this set is a subset of the set referenced by otherSet.

Parameters:

otherSet - Another set.

Returns:

True if this set is a subset of the set referenced by otherSet, otherwise false.

properSubsetOf

boolean properSubsetOf(DSet otherSet)

Determine whether this set is a proper subset of the set referenced by otherSet.

Parameters:

otherSet - Another set.

Returns:

True if this set is a proper subset of the set referenced by otherSet, otherwise false.

supersetOf

boolean supersetOf(DSet otherSet)

Determine whether this set is a superset of the set referenced by otherSet.

Parameters:

otherSet - Another set.

Returns:

True if this set is a superset of the set referenced by otherSet, otherwise false.

properSupersetOf

boolean properSupersetOf(DSet otherSet)

Determine whether this set is a proper superset of the set referenced by otherSet.

Parameters:

otherSet - Another set.

Returns:

True if this set is a proper superset of the set referenced by otherSet, otherwise false.