net.sf.farrago.cwm.keysindexes
Interface IndexSpansClass

All Superinterfaces:

RefAssociation, RefBaseObject

All Known Implementing Classes:

IndexSpansClass$Hib

public interface IndexSpansClass
extends RefAssociation

IndexSpansClass association proxy interface. Associates indexes with the classes they span. This relationship is separate from the ownership of indexes, to allow modeling of systems where an index is NOT owned by the object it spans. In most situations, however, the spanned and owning Class instances will be the same.

Note: This type should not be subclassed, implemented or directly instantiated by clients. It is generated from a MOF metamodel and implemented by Enki or MDR.

Method Summary

boolean	add(CwmClass spannedClass, CwmIndex index) Creates a link between the pair of instance objects in the associations link set.
boolean	exists(CwmClass spannedClass, CwmIndex index) Queries whether a link currently exists between a given pair of instance objects in the associations link set.
Collection<CwmIndex>	getIndex(CwmClass spannedClass) Queries the instance objects that are related to a particular instance object by a link in the current associations link set.
CwmClass	getSpannedClass(CwmIndex index) Queries the instance object that is related to a particular instance object by a link in the current associations link set.
boolean	remove(CwmClass spannedClass, CwmIndex index) Removes a link between a pair of instance objects in the current associations link set.

Methods inherited from interface javax.jmi.reflect.RefAssociation

refAddLink, refAllLinks, refLinkExists, refQuery, refQuery, refRemoveLink

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

exists

boolean exists(CwmClass spannedClass,
               CwmIndex index)

Queries whether a link currently exists between a given pair of instance objects in the associations link set.

Parameters:

spannedClass - Value of the first association end.

index - Value of the second association end.

Returns:

Returns true if the queried link exists.

getSpannedClass

CwmClass getSpannedClass(CwmIndex index)

Queries the instance object that is related to a particular instance object by a link in the current associations link set.

Parameters:

index - Required value of the second association end.

Returns:

Related object or null if none exists.

getIndex

Collection<CwmIndex> getIndex(CwmClass spannedClass)

Queries the instance objects that are related to a particular instance object by a link in the current associations link set.

Parameters:

spannedClass - Required value of the first association end.

Returns:

Collection of related objects.

add

boolean add(CwmClass spannedClass,
            CwmIndex index)

Creates a link between the pair of instance objects in the associations link set.

Parameters:

spannedClass - Value of the first association end.

index - Value of the second association end.

remove

boolean remove(CwmClass spannedClass,
               CwmIndex index)

Removes a link between a pair of instance objects in the current associations link set.

Parameters:

spannedClass - Value of the first association end.

index - Value of the second association end.