Package de.mid.innovator.srv2api.icw2pres

Interface PRAnalysisDia

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELPictureAble, ELUUIDAble, ELValueContainerAble, MMAttachmentAble, MMCommentContainerAble, MMFormatAble, MMLabelAble, MMLabelTextAttachmentAble, MMMenuAble, MMStereotypeAble, MMTextAble, PRDia, PRPresContext, PRPresElement, PRVersionAbleDia

public interface PRAnalysisDia
extends PRVersionAbleDia

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PRAnalysisDia.VAttr

Method Summary

Modifier and Type	Method	Description
ARG_GetAnalysisDiaProperties	getAnalysisDiaProperties()	Returns all properties of this PRAnalysisDia.
String	getAnalysisValue()	The analysis value of this PRAnalysisDia.
MEStereotypeAble	getApplicableStartElement()	The start element of this PRAnalysisDia.
String	getConfigValue()	The local configuration value of this PRAnalysisDia.
String	getContentConfig()	The name of the content ADApplicationConfiguration used on creation of a new PRAnalysisDia or the name of the user-defined content configuration of an existing diagram.
ADApplicationConfiguration	getContentConfiguration()	The content ADApplicationConfiguration used by this PRAnalysisDia.
String	getDisplayConfig()	The name of the display ADApplicationConfiguration used on creation of a new PRAnalysisDia or the name of the user-defined display configuration of an existing diagram.
ADApplicationConfiguration	getDisplayConfiguration()	The display ADApplicationConfiguration used by this PRAnalysisDia.
<T extends ADClientAble> List<T>	getEndElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All end elements of this PRAnalysisDia.
K_GRAPH_DIRECTION	getGraphDirection()	Defines how the graph is structured.
int	getMaxPathLength()	Only nodes are shown which can be reached from a start element on a path with not more than the given number of edges.
String	getPurposeContent()	The purpose to specify the content ADApplicationConfiguration of this PRAnalysisDia.
String	getPurposeDisplay()	The purpose to specify the display ADApplicationConfiguration of this PRAnalysisDia.
boolean	getShowAllEdges()	Show all edges between displayed nodes.
boolean	getShowShortestPathOnly()	Show the shortest path between start and end elements only.
<T extends ADClientAble> List<T>	getStartElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All start elements of this PRAnalysisDia.
boolean	getTraceNodes()	Colour of the node, depending if it is for the selected node or edge a source node (blue), target node (green) or both (red).
boolean	getUseApplicationConfiguration()	true, if the ADApplicationConfiguration is used, the local configuration value is used otherwise.
boolean	isDirectionConsidered()	If activated the direction of edges is considered when finding the shortest path to any node starting from the selection.
boolean	isSmooth()	true, if the represented graph is smooth.
void	setAnalysisValue(String value)	Set the value of Attribut AnalysisValue.
void	setConfigValue(String value)	Set the value of Attribut ConfigValue.
void	setContentConfig(String value)	Set the value of Attribut ContentConfig.
void	setContentConfiguration(ADApplicationConfiguration value)	Set the value of Foreign Key ContentConfiguration.
void	setDirectionConsidered(boolean value)	Set the value of Attribut IsDirectionConsidered.
void	setDisplayConfig(String value)	Set the value of Attribut DisplayConfig.
void	setDisplayConfiguration(ADApplicationConfiguration value)	Set the value of Foreign Key DisplayConfiguration.
void	setEndElement(List<? extends ADClientAble> values)	Set the value of Foreign Key EndElement.
void	setGraphDirection(K_GRAPH_DIRECTION value)	Set the value of Attribut GraphDirection.
void	setMaxPathLength(int value)	Set the value of Attribut MaxPathLength.
void	setPurposeContent(String value)	Set the value of Attribut PurposeContent.
void	setPurposeDisplay(String value)	Set the value of Attribut PurposeDisplay.
void	setShowAllEdges(boolean value)	Set the value of Attribut ShowAllEdges.
void	setShowShortestPathOnly(boolean value)	Set the value of Attribut ShowShortestPathOnly.
void	setSmooth(boolean value)	Set the value of Attribut IsSmooth.
void	setStartElement(List<? extends ADClientAble> values)	Set the value of Foreign Key StartElement.
void	setTraceNodes(boolean value)	Set the value of Attribut TraceNodes.
void	setUseApplicationConfiguration(boolean value)	Set the value of Attribut UseApplicationConfiguration.

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

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

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.ADLockAble

getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock

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.icw2meta.ADOptionAble

getOwnedOption, modifyOptionDlg

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

getReferenceContainer, setReferenceContainer

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

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

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.ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

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

getOwnedPicture, getOwnedPictures, getPictureRawData, pictureSetRawData

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.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.MMFormatAble

copyFormatDlg, copyFormatRule, getCopyFormatDlgInit, getFormat

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.MMMenuAble

getMenu, getMenuItem, getMenuItemsForTransform

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

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRDia

addAbleDiaEdge, addEdgeAndTargetNode, addEdgesAndTargetNodes, getAddAbleDiaEdge, getAddEdgeAndTargetNodeList, getDiaWhiteboardNode, getOwnedAnnotations, getOwnedCalloutNode, getOwnedDiaAttachmentNode, getOwnedDiaNote, getOwnedFrameNode, getSVGPictureRawData, getXClientForSVG, setDiaFilterCriteria, setSVGPictureRawData

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRPresContext

getContextFormat, getContextValue, getCopy, getCopyToFile, getHorPage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginUnit, getModelElementOfTransitiveOwnedPresentationElement, getModelElementOfTransitiveOwnedPresentationElement, getOrientation, getOwnedFooterText, getOwnedHeaderText, getOwnedPresContent, getPageBreakX, getPageBreakY, getPageOrder, getPageView, getVerPage, getXClient, getXClientContentModelElementList, getXClientContentModelElementList, getXClientHash, isPageViewActive, pageView, paste, pasteFromFile, setContextFormat, setContextValue, setHorPage, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setOrientation, setPageViewActive, setVerPage

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRPresElement

getDiagramTagValue, getOpacity, getOwnedDiagramTags, getOwnedPresContentElement, getPresColor, getPresentationOfLogic, setDiagramTagValue, setOpacity, setPresColor

Methods inherited from interface de.mid.innovator.srv2api.icw2pres.PRVersionAbleDia

getMEModelName, getVersionAbleDiaClientDependency, getVersionAbleDiaSupplierDependency, isMapped, setMapped

Method Details

getPurposeContent

String getPurposeContent()
                  throws InoNetException,
SrvErrorException

The purpose to specify the content ADApplicationConfiguration of this PRAnalysisDia.

Throws:

InoNetException

SrvErrorException

setPurposeContent

void setPurposeContent(String value)
                throws InoNetException,
SrvErrorException

Set the value of Attribut PurposeContent.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getPurposeDisplay

String getPurposeDisplay()
                  throws InoNetException,
SrvErrorException

The purpose to specify the display ADApplicationConfiguration of this PRAnalysisDia.

Throws:

InoNetException

SrvErrorException

setPurposeDisplay

void setPurposeDisplay(String value)
                throws InoNetException,
SrvErrorException

Set the value of Attribut PurposeDisplay.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getAnalysisValue

String getAnalysisValue()
                 throws InoNetException,
SrvErrorException

The analysis value of this PRAnalysisDia.

Throws:

InoNetException

SrvErrorException

setAnalysisValue

void setAnalysisValue(String value)
               throws InoNetException,
SrvErrorException

Set the value of Attribut AnalysisValue.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getConfigValue

String getConfigValue()
               throws InoNetException,
SrvErrorException

The local configuration value of this PRAnalysisDia.

Throws:

InoNetException

SrvErrorException

setConfigValue

void setConfigValue(String value)
             throws InoNetException,
SrvErrorException

Set the value of Attribut ConfigValue.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getUseApplicationConfiguration

boolean getUseApplicationConfiguration()
                                throws InoNetException,
SrvErrorException

true, if the ADApplicationConfiguration is used, the local configuration value is used otherwise.

Throws:

InoNetException

SrvErrorException

setUseApplicationConfiguration

void setUseApplicationConfiguration(boolean value)
                             throws InoNetException,
SrvErrorException

Set the value of Attribut UseApplicationConfiguration.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getGraphDirection

K_GRAPH_DIRECTION getGraphDirection()
                             throws InoNetException,
SrvErrorException

Defines how the graph is structured.

Throws:

InoNetException

SrvErrorException

setGraphDirection

void setGraphDirection(K_GRAPH_DIRECTION value)
                throws InoNetException,
SrvErrorException

Set the value of Attribut GraphDirection.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMaxPathLength

int getMaxPathLength()
              throws InoNetException,
SrvErrorException

Only nodes are shown which can be reached from a start element on a path with not more than the given number of edges. If end elements are set, the node has to be on a path from start to end with a complete length not more than the given number.

Throws:

InoNetException

SrvErrorException

setMaxPathLength

void setMaxPathLength(int value)
               throws InoNetException,
SrvErrorException

Set the value of Attribut MaxPathLength.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getTraceNodes

boolean getTraceNodes()
               throws InoNetException,
SrvErrorException

Colour of the node, depending if it is for the selected node or edge a source node (blue), target node (green) or both (red).

Throws:

InoNetException

SrvErrorException

setTraceNodes

void setTraceNodes(boolean value)
            throws InoNetException,
SrvErrorException

Set the value of Attribut TraceNodes.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isDirectionConsidered

boolean isDirectionConsidered()
                       throws InoNetException,
SrvErrorException

If activated the direction of edges is considered when finding the shortest path to any node starting from the selection.

Throws:

InoNetException

SrvErrorException

setDirectionConsidered

void setDirectionConsidered(boolean value)
                     throws InoNetException,
SrvErrorException

Set the value of Attribut IsDirectionConsidered.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getShowAllEdges

boolean getShowAllEdges()
                 throws InoNetException,
SrvErrorException

Show all edges between displayed nodes.

Throws:

InoNetException

SrvErrorException

setShowAllEdges

void setShowAllEdges(boolean value)
              throws InoNetException,
SrvErrorException

Set the value of Attribut ShowAllEdges.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getShowShortestPathOnly

boolean getShowShortestPathOnly()
                         throws InoNetException,
SrvErrorException

Show the shortest path between start and end elements only.

Throws:

InoNetException

SrvErrorException

setShowShortestPathOnly

void setShowShortestPathOnly(boolean value)
                      throws InoNetException,
SrvErrorException

Set the value of Attribut ShowShortestPathOnly.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getContentConfig

String getContentConfig()
                 throws InoNetException,
SrvErrorException

The name of the content ADApplicationConfiguration used on creation of a new PRAnalysisDia or the name of the user-defined content configuration of an existing diagram.

Throws:

InoNetException

SrvErrorException

setContentConfig

void setContentConfig(String value)
               throws InoNetException,
SrvErrorException

Set the value of Attribut ContentConfig.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getDisplayConfig

String getDisplayConfig()
                 throws InoNetException,
SrvErrorException

The name of the display ADApplicationConfiguration used on creation of a new PRAnalysisDia or the name of the user-defined display configuration of an existing diagram.

Throws:

InoNetException

SrvErrorException

setDisplayConfig

void setDisplayConfig(String value)
               throws InoNetException,
SrvErrorException

Set the value of Attribut DisplayConfig.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isSmooth

boolean isSmooth()
          throws InoNetException,
SrvErrorException

true, if the represented graph is smooth.

Throws:

InoNetException

SrvErrorException

setSmooth

void setSmooth(boolean value)
        throws InoNetException,
SrvErrorException

Set the value of Attribut IsSmooth.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getAnalysisDiaProperties

ARG_GetAnalysisDiaProperties getAnalysisDiaProperties()
                                               throws InoNetException,
SrvErrorException

Returns all properties of this PRAnalysisDia.

Throws:

InoNetException

SrvErrorException

getContentConfiguration

ADApplicationConfiguration getContentConfiguration()
                                            throws InoNetException,
SrvErrorException

The content ADApplicationConfiguration used by this PRAnalysisDia.

Throws:

InoNetException

SrvErrorException

setContentConfiguration

void setContentConfiguration(ADApplicationConfiguration value)
                      throws InoNetException,
SrvErrorException

Set the value of Foreign Key ContentConfiguration.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getStartElement

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

All start elements of this PRAnalysisDia.

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.

setStartElement

void setStartElement(List<? extends ADClientAble> values)
              throws InoNetException,
SrvErrorException

Set the value of Foreign Key StartElement.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getEndElement

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

All end elements of this PRAnalysisDia.

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.

setEndElement

void setEndElement(List<? extends ADClientAble> values)
            throws InoNetException,
SrvErrorException

Set the value of Foreign Key EndElement.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getDisplayConfiguration

ADApplicationConfiguration getDisplayConfiguration()
                                            throws InoNetException,
SrvErrorException

The display ADApplicationConfiguration used by this PRAnalysisDia.

Throws:

InoNetException

SrvErrorException

setDisplayConfiguration

void setDisplayConfiguration(ADApplicationConfiguration value)
                      throws InoNetException,
SrvErrorException

Set the value of Foreign Key DisplayConfiguration.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getApplicableStartElement

MEStereotypeAble getApplicableStartElement()
                                    throws InoNetException,
SrvErrorException

The start element of this PRAnalysisDia.

Throws:

InoNetException

SrvErrorException