de.cau.cs.kieler.core.kgraph
Interface KEdge

All Superinterfaces:
EObject, KGraphElement, KLabeledGraphElement, Notifier
All Known Subinterfaces:
Edge
All Known Implementing Classes:
EdgeImpl, KEdgeImpl

public interface KEdge
extends KLabeledGraphElement

A representation of the model object 'Edge'. An edge must be assigned a source and a target node, but the source and target ports are optional.

The following features are supported:

See Also:
KGraphPackage.getKEdge()
Rating yellow
(2011-02-01) reviewed by cmot, soh
Generated:
This code was automatically generated.
Model element

Method Summary
 KNode getSource()
          Returns the value of the 'Source' container reference.
 KPort getSourcePort()
          Returns the value of the 'Source Port' reference.
 KNode getTarget()
          Returns the value of the 'Target' reference.
 KPort getTargetPort()
          Returns the value of the 'Target Port' reference.
 void setSource(KNode value)
          Sets the value of the 'Source' container reference.
 void setSourcePort(KPort value)
          Sets the value of the 'Source Port' reference.
 void setTarget(KNode value)
          Sets the value of the 'Target' reference.
 void setTargetPort(KPort value)
          Sets the value of the 'Target Port' reference.
 
Methods inherited from interface de.cau.cs.kieler.core.kgraph.KLabeledGraphElement
getLabels
 
Methods inherited from interface de.cau.cs.kieler.core.kgraph.KGraphElement
getData, getData, getData
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getSource

KNode getSource()
Returns the value of the 'Source' container reference. It is bidirectional and its opposite is 'Outgoing Edges'. The source node is expected to be set for each edge. This is especially important because the source node is defined to be the container of the edge, which is relevant for many EMF features such as XML storage or copying.

Returns:
the value of the 'Source' container reference.
See Also:
setSource(KNode), KGraphPackage.getKEdge_Source(), KNode.getOutgoingEdges()
Generated:
This code was automatically generated.
Model element:
opposite=outgoingEdges
required=true
transient=false

setSource

void setSource(KNode value)
Sets the value of the 'Source' container reference. This automatically adds the edge to the the source node's list of outgoing edges.

Parameters:
value - the new value of the 'Source' container reference.
See Also:
getSource()
Generated:
This code was automatically generated.

getTarget

KNode getTarget()
Returns the value of the 'Target' reference. It is bidirectional and its opposite is 'Incoming Edges'. The target node is expected to be set for each edge.

Returns:
the value of the 'Target' reference.
See Also:
setTarget(KNode), KGraphPackage.getKEdge_Target(), KNode.getIncomingEdges()
Generated:
This code was automatically generated.
Model element:
opposite=incomingEdges
required=true

setTarget

void setTarget(KNode value)
Sets the value of the 'Target' reference. This automatically adds the edge to the target node's list of incoming edges.

Parameters:
value - the new value of the 'Target' reference.
See Also:
getTarget()
Generated:
This code was automatically generated.

getSourcePort

KPort getSourcePort()
Returns the value of the 'Source Port' reference. This reference is optional, as a node may have no ports.

Returns:
the value of the 'Source Port' reference.
See Also:
setSourcePort(KPort), KGraphPackage.getKEdge_SourcePort()
Generated:
This code was automatically generated.
Model element

setSourcePort

void setSourcePort(KPort value)
Sets the value of the 'Source Port' reference. As this reference is not bidirectional, the edge must be added to the list obtained with the getEdges method of the given port.

The node related to the source port must be equal to the source node of this edge.

Parameters:
value - the new value of the 'Source Port' reference.
See Also:
getSourcePort()
Generated:
This code was automatically generated.

getTargetPort

KPort getTargetPort()
Returns the value of the 'Target Port' reference. This reference is optional, as a node may have no ports.

Returns:
the value of the 'Target Port' reference.
See Also:
setTargetPort(KPort), KGraphPackage.getKEdge_TargetPort()
Generated:
This code was automatically generated.
Model element

setTargetPort

void setTargetPort(KPort value)
Sets the value of the 'Target Port' reference. As this reference is not bidirectional, the edge must be added to the list obtained with the getEdges method of the given port.the given port.

The node related to the target port must be equal to the target node of this edge.

Parameters:
value - the new value of the 'Target Port' reference.
See Also:
getTargetPort()
Generated:
This code was automatically generated.