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

All Superinterfaces:
EObject, KGraphElement, KLabeledGraphElement, Notifier
All Known Subinterfaces:
Node
All Known Implementing Classes:
KNodeImpl, NodeImpl

public interface KNode
extends KLabeledGraphElement

A representation of the model object 'Node'. All nodes except exactly one node must have an assigned parent node. The node without parent is the top node of the graph and represents the graph itself. Each node must be assigned a label.

The parent-child relationship of nodes can be used to describe hierarchy in nested graphs.

The following features are supported:

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

Method Summary
 EList<KNode> getChildren()
          Returns the value of the 'Children' containment reference list.
 EList<KEdge> getIncomingEdges()
          Returns the value of the 'Incoming Edges' reference list.
 EList<KEdge> getOutgoingEdges()
          Returns the value of the 'Outgoing Edges' containment reference list.
 KNode getParent()
          Returns the value of the 'Parent' container reference.
 EList<KPort> getPorts()
          Returns the value of the 'Ports' containment reference list.
 void setParent(KNode value)
          Sets the value of the 'Parent' container 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

getChildren

EList<KNode> getChildren()
Returns the value of the 'Children' containment reference list. The list contents are of type KNode. It is bidirectional and its opposite is 'Parent'. The children together with their edges form a sub-graph that is contained in this parent node.

Returns:
the value of the 'Children' containment reference list.
See Also:
KGraphPackage.getKNode_Children(), getParent()
Generated:
This code was automatically generated.
Model element:
opposite=parent
containment=true

getParent

KNode getParent()
Returns the value of the 'Parent' container reference. It is bidirectional and its opposite is 'Children'. The parent node must be null if and only if this is the top node of the graph structure.

Returns:
the value of the 'Parent' container reference.
See Also:
setParent(KNode), KGraphPackage.getKNode_Parent(), getChildren()
Generated:
This code was automatically generated.
Model element:
opposite=children
transient=false

setParent

void setParent(KNode value)
Sets the value of the 'Parent' container reference. This automatically adds the node to the parent's list of children.

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

getPorts

EList<KPort> getPorts()
Returns the value of the 'Ports' containment reference list. The list contents are of type KPort. It is bidirectional and its opposite is 'Node'. Each node may have an arbitrary number of ports. Edges may or may not be connected to ports.

Returns:
the value of the 'Ports' containment reference list.
See Also:
KGraphPackage.getKNode_Ports(), KPort.getNode()
Generated:
This code was automatically generated.
Model element:
opposite=node
containment=true

getOutgoingEdges

EList<KEdge> getOutgoingEdges()
Returns the value of the 'Outgoing Edges' containment reference list. The list contents are of type KEdge. It is bidirectional and its opposite is 'Source'.

Returns:
the value of the 'Outgoing Edges' containment reference list.
See Also:
KGraphPackage.getKNode_OutgoingEdges(), KEdge.getSource()
Generated:
This code was automatically generated.
Model element:
opposite=source
containment=true

getIncomingEdges

EList<KEdge> getIncomingEdges()
Returns the value of the 'Incoming Edges' reference list. The list contents are of type KEdge. It is bidirectional and its opposite is 'Target'.

Returns:
the value of the 'Incoming Edges' reference list.
See Also:
KGraphPackage.getKNode_IncomingEdges(), KEdge.getTarget()
Generated:
This code was automatically generated.
Model element:
opposite=target