IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.notation
Interface Diagram

All Superinterfaces:
EModelElement, EObject, Notifier, View

public interface Diagram
extends View

A representation of the model object 'Diagram'.

A diagram is a view that represents the top level containment of views

The following features are supported:

See Also:
NotationPackage.getDiagram()

Method Summary
 Edge createEdge(EClass eClass)
           A utililty method to create a new Edge from the given eClass paramter and then inserts the object in the diagrams's Edges collection
 EList getEdges()
          Returns the value of the 'Edges' containment reference list.
 String getName()
          Returns the value of the 'Name' attribute.
 void setName(String value)
          Sets the value of the 'Name' attribute
 
Methods inherited from interface com.ibm.xtools.notation.View
createChild, createStyle, getChildren, getDiagram, getElement, getSourceEdges, getStyle, getStyles, getTargetEdges, getType, isVisible, setElement, setType, setVisible
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getName

public String getName()
Returns the value of the 'Name' attribute. The default value is "".

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), NotationPackage.getDiagram_Name()

setName

public void setName(String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

getEdges

public EList getEdges()
Returns the value of the 'Edges' containment reference list. The list contents are of type Edge.

Since edges are not hierarchical views, they are 'contained' by the diagram of the source and target views. However, they are 'referenced' from the source and target view's getSourceEdges() and getTargetEdges() reference collections

Returns:
the value of the 'Edges' containment reference list.
See Also:
NotationPackage.getDiagram_Edges()

createEdge

public Edge createEdge(EClass eClass)

A utililty method to create a new Edge from the given eClass paramter and then inserts the object in the diagrams's Edges collection

Parameters:
eClass - the EClass to be used in creating the Edge object

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.