Interface DMIterator

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, DMExpression, DMNElement, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject, ELUUIDAble, ELValueContainerAble, MEModelElement, MMAttachmentAble, MMLabelAble, MMLabelTextAttachmentAble, MMTextAble

public interface DMIterator
extends DMExpression

An DMIterator is the abstract class for all boxed iteration.

See Also:

• DMIteratorHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	DMIterator.VAttr

Method Summary

Modifier and Type	Method	Description
DMTypedChildExpression	getInTypedExpression()	The DMTypedChildExpression which holds the instance of DMExpression that is evaluated as the collection to be processed.
K_DM_ITERATOR	getIteratorKind()	The kind of this DMIterator.
CLClassifier	getIteratorType()	The CLPrimitiveType or CLStructureDefinition which is used as type of the in expression of this DMIterator.
String	getIteratorVariable()	The name of the iterator variable that will be populated at each iteration.
DMChildExpression	getResultChildExpression()	The DMChildExpression which holds the instance of DMExpression that describes the result collection.
DMChildExpression	getReturnChildExpression()	The DMChildExpression which holds the instance of DMExpression that is evaluated to create the new collection that will be returned.
DMChildExpression	getSatisfiesChildExpression()	The DMChildExpression which holds the instance of DMExpression that is evaluated to determine if the current item satisfies a condition.
void	setIteratorKind(K_DM_ITERATOR value)	Set the value of Attribut IteratorKind.
void	setIteratorType(CLClassifier value)	Set the value of View IteratorType.
void	setIteratorVariable(String value)	Set the value of Attribut IteratorVariable.

Methods inherited from interface ADClientAble

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

Methods inherited from interface ADHistoryAble

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

Methods inherited from interface ADM2AttrModifyAble

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

Methods inherited from interface DMExpression

getCallingInvocation

Methods inherited from interface DMNElement

getBoxedExpressionClient

Methods inherited from interface ELContainerAble

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

Methods inherited from interface ELContAsgnAble

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

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface 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 ELObject

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

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface MEModelElement

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

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMLabelAble

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

Methods inherited from interface MMTextAble

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

Method Details

getIteratorKind

K_DM_ITERATOR getIteratorKind()
                       throws InoNetException,
SrvErrorException

The kind of this DMIterator.

Throws:

InoNetException

SrvErrorException

setIteratorKind

void setIteratorKind(K_DM_ITERATOR value)
              throws InoNetException,
SrvErrorException

Set the value of Attribut IteratorKind.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getIteratorVariable

String getIteratorVariable()
                    throws InoNetException,
SrvErrorException

The name of the iterator variable that will be populated at each iteration.

Throws:

InoNetException

SrvErrorException

setIteratorVariable

void setIteratorVariable(String value)
                  throws InoNetException,
SrvErrorException

Set the value of Attribut IteratorVariable.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getIteratorType

CLClassifier getIteratorType()
                      throws InoNetException,
SrvErrorException

The CLPrimitiveType or CLStructureDefinition which is used as type of the in expression of this DMIterator.

Throws:

InoNetException

SrvErrorException

setIteratorType

void setIteratorType(CLClassifier value)
              throws InoNetException,
SrvErrorException

Set the value of View IteratorType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getReturnChildExpression

DMChildExpression getReturnChildExpression()
                                    throws InoNetException,
SrvErrorException

The DMChildExpression which holds the instance of DMExpression that is evaluated to create the new collection that will be returned.

Throws:

InoNetException

SrvErrorException

getSatisfiesChildExpression

DMChildExpression getSatisfiesChildExpression()
                                       throws InoNetException,
SrvErrorException

The DMChildExpression which holds the instance of DMExpression that is evaluated to determine if the current item satisfies a condition.

Throws:

InoNetException

SrvErrorException

getInTypedExpression

DMTypedChildExpression getInTypedExpression()
                                     throws InoNetException,
SrvErrorException

The DMTypedChildExpression which holds the instance of DMExpression that is evaluated as the collection to be processed.

Throws:

InoNetException

SrvErrorException

getResultChildExpression

DMChildExpression getResultChildExpression()
                                    throws InoNetException,
SrvErrorException

The DMChildExpression which holds the instance of DMExpression that describes the result collection.

Throws:

InoNetException

SrvErrorException