net.sf.farrago.cwm.keysindexes
Interface CwmIndex

All Superinterfaces:

CwmElement, CwmModelElement, RefBaseObject, RefFeatured, RefObject

All Known Subinterfaces:

CwmSqlindex, FemLocalIndex

All Known Implementing Classes:

CwmIndex$Hib, CwmSqlindex$Hib, FemLocalIndex$Hib

public interface CwmIndex
extends CwmModelElement

Index object instance interface. Instances of the Index class represent the ordering of the instances of some other Class, and the Index is said to "span" the Class. Indexes normally have an ordered set of attributes of the Class instance they span that make up the "key" of the index; this set of relationships is represented by the IndexedFeature class that indicates how the attributes are used by the Index instance. The Index class is intended primarily as a starting point for tools that require the notion of an index.

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

List<CwmIndexedFeature>	getIndexedFeature() Returns the value of reference indexedFeature.
CwmClass	getSpannedClass() Returns the value of reference spannedClass.
boolean	isPartitioning() Returns the value of attribute isPartitioning.
boolean	isSorted() Returns the value of attribute isSorted.
boolean	isUnique() Returns the value of attribute isUnique.
void	setPartitioning(boolean newValue) Sets the value of isPartitioning attribute.
void	setSorted(boolean newValue) Sets the value of isSorted attribute.
void	setSpannedClass(CwmClass newValue) Sets the value of spannedClass reference.
void	setUnique(boolean newValue) Sets the value of isUnique attribute.

Methods inherited from interface net.sf.farrago.cwm.core.CwmModelElement

getClientDependency, getConstraint, getImporter, getName, getNamespace, getVisibility, setName, setNamespace, setVisibility

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

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

Method Detail

isPartitioning

boolean isPartitioning()

Returns the value of attribute isPartitioning. If True, this Index instance is used as a partitioning index.

Returns:

Value of attribute isPartitioning.

setPartitioning

void setPartitioning(boolean newValue)

Sets the value of isPartitioning attribute. See isPartitioning() for description on the attribute.

Parameters:

newValue - New value to be set.

isSorted

boolean isSorted()

Returns the value of attribute isSorted. If True, the Index instance is maintained in a sorted order.

Returns:

Value of attribute isSorted.

setSorted

void setSorted(boolean newValue)

Sets the value of isSorted attribute. See isSorted() for description on the attribute.

Parameters:

newValue - New value to be set.

isUnique

boolean isUnique()

Returns the value of attribute isUnique. The isUnique attribute is True if the Index instance guarantees all of its instances have a unique key value.

Returns:

Value of attribute isUnique.

setUnique

void setUnique(boolean newValue)

Sets the value of isUnique attribute. See isUnique() for description on the attribute.

Parameters:

newValue - New value to be set.

getIndexedFeature

List<CwmIndexedFeature> getIndexedFeature()

Returns the value of reference indexedFeature.

Returns:

Value of reference indexedFeature. Element type: CwmIndexedFeature

getSpannedClass

CwmClass getSpannedClass()

Returns the value of reference spannedClass.

Returns:

Value of reference spannedClass.

setSpannedClass

void setSpannedClass(CwmClass newValue)

Sets the value of spannedClass reference. See getSpannedClass() for description on the attribute.

Parameters:

newValue - New value to be set.