Package de.mid.innovator.srv2api.icw2im

Interface IMIndex

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

DBIndex

public interface IMIndex
extends ADHistoryAble, MEStereotypeAble, MECommentAble, MENamespaceAsgnAble, MMLabelTextAttachmentAble

This is a utility class for IMIndex that provides static methods for creation or other purposes.

Note:

The interface IMIndex describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IMIndex.VAttr

Method Summary

Modifier and Type	Method	Description
<T extends IMProperty> List<T>	getAddableProperty(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of all addable properties.
<T extends IMProperty> List<T>	getAddableProperty(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getAddableProperty and filters its return values according to the given stereotype value.
String	getFeatureNames()	Returns the names of the features of this IMIndex as a comma separated string.
<T extends IMIndexedFeature> List<T>	getOwnedIndexedFeature(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of indexed features of this IMIndex.
<T extends IMIndexedFeature> List<T>	getOwnedIndexedFeatureIncluded(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of included indexed features of this IMIndex.
<T extends IMIndexedFeature> List<T>	getOwnedIndexedFeatureIncluded(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getOwnedIndexedFeatureIncluded and filters its return values according to the given stereotype value.
<T extends IMIndexedFeature> List<T>	getOwnedIndexedFeatureRegular(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of regular indexed features of this IMIndex.
<T extends IMIndexedFeature> List<T>	getOwnedIndexedFeatureRegular(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getOwnedIndexedFeatureRegular and filters its return values according to the given stereotype value.
<T extends IMProperty> List<T>	getProperty(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Gets all features of this IMIndex.
<T extends IMProperty> List<T>	getProperty(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getProperty and filters its return values according to the given stereotype value.
boolean	hasNullProperty()	If true, a nullable IMProperty is part of this index.
boolean	isUnique()	If true, the index instance guarantees all of its instances have a unique key value.
void	setFeatureNames(String value)	Set the value of Info FeatureNames.
void	setUnique(boolean value)	Set the value of Attribut IsUnique.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface de.mid.innovator.srv2api.icw2model.METermAble

getTerm, setTerm

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

isUnique

boolean isUnique()
          throws InoNetException,
SrvErrorException

If true, the index instance guarantees all of its instances have a unique key value.

Throws:

InoNetException

SrvErrorException

setUnique

void setUnique(boolean value)
        throws InoNetException,
SrvErrorException

Set the value of Attribut IsUnique.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasNullProperty

boolean hasNullProperty()
                 throws InoNetException,
SrvErrorException

If true, a nullable IMProperty is part of this index.

Throws:

InoNetException

SrvErrorException

getFeatureNames

String getFeatureNames()
                throws InoNetException,
SrvErrorException

Returns the names of the features of this IMIndex as a comma separated string.

Throws:

InoNetException

SrvErrorException

setFeatureNames

void setFeatureNames(String value)
              throws InoNetException,
SrvErrorException

Set the value of Info FeatureNames.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getAddableProperty

<T extends IMProperty> List<T> getAddableProperty(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                           throws InoNetException,
SrvErrorException

List of all addable properties. These are all properties of the owning classifier which are not yet part of the index.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted according to the property order in the classifier.

getAddableProperty

<T extends IMProperty> List<T> getAddableProperty(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                           throws InoNetException,
SrvErrorException

The method calls getAddableProperty and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getProperty

<T extends IMProperty> List<T> getProperty(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
SrvErrorException

Gets all features of this IMIndex. In DB context, these features are table columns,

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the list is sorted according to appropriate feature order in the index.

getProperty

<T extends IMProperty> List<T> getProperty(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
SrvErrorException

The method calls getProperty and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOwnedIndexedFeatureRegular

<T extends IMIndexedFeature> List<T> getOwnedIndexedFeatureRegular(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                            throws InoNetException,
SrvErrorException

List of regular indexed features of this IMIndex.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the list is sorted according to appropriate indexed feature order in the index.

getOwnedIndexedFeatureRegular

<T extends IMIndexedFeature> List<T> getOwnedIndexedFeatureRegular(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                                            throws InoNetException,
SrvErrorException

The method calls getOwnedIndexedFeatureRegular and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOwnedIndexedFeatureIncluded

<T extends IMIndexedFeature> List<T> getOwnedIndexedFeatureIncluded(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                             throws InoNetException,
SrvErrorException

List of included indexed features of this IMIndex.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the list is sorted according to appropriate indexed feature order in the index.

getOwnedIndexedFeatureIncluded

<T extends IMIndexedFeature> List<T> getOwnedIndexedFeatureIncluded(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                                             throws InoNetException,
SrvErrorException

The method calls getOwnedIndexedFeatureIncluded and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOwnedIndexedFeature

<T extends IMIndexedFeature> List<T> getOwnedIndexedFeature(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                     throws InoNetException,
SrvErrorException

List of indexed features of this IMIndex.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the list is sorted according to appropriate feature order in the index.