Package org.bigraphs.framework.core

Class ElementaryBigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

java.lang.Object

org.bigraphs.framework.core.BigraphDelegator<S>

org.bigraphs.framework.core.ElementaryBigraph<S>

Type Parameters:

S - the signature type

All Implemented Interfaces:

Bigraph<S>, EcoreBigraph<S>, EcoreBigraphExt, HasSignature<S>

Direct Known Subclasses:

DiscreteIon, Linkings.Closure, Linkings.IdentityEmpty, Linkings.Substitution, Placings.Barren, Placings.Join, Placings.Merge, Placings.Permutation

public abstract class ElementaryBigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>
extends BigraphDelegator<S>
implements EcoreBigraph<S>

Base class for the elementary building blocks of Ecore-based bigraphs.

Elementary bigraphs serve as units for constructing larger and more complex bigraphs via composition.

Author:

Dominik Grzelak

Nested Class Summary

Nested classes/interfaces inherited from interface org.bigraphs.framework.core.EcoreBigraph

EcoreBigraph.Stub<S extends AbstractEcoreSignature<?>>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.emf.ecore.EObject	instanceModel
protected org.eclipse.emf.ecore.EPackage	metaModelPackage

Fields inherited from class org.bigraphs.framework.core.BigraphDelegator

bigraphDelegate

Constructor Summary

Constructors

Constructor	Description
ElementaryBigraph(Bigraph<S> bigraphDelegate)

Method Summary

Modifier and Type	Method	Description
final <C extends Control<?, ?>> boolean	areConnected(BigraphEntity.NodeEntity<C> place1, BigraphEntity.NodeEntity<C> place2)	Check if two nodes are connected to each other.
Collection<BigraphEntity.Link>	getAllLinks()
List<BigraphEntity<?>>	getAllPlaces()	Returns all places of the bigraph, i.e., roots, nodes and sites.
List<BigraphEntity<?>>	getChildrenOf(BigraphEntity<?> node)	Returns the set of children of a given node (including sites).
Collection<BigraphEntity.Edge>	getEdges()
Collection<BigraphEntity.InnerName>	getInnerNames()
org.eclipse.emf.ecore.EObject	getInstanceModel()	Return the Ecore-based instance model of a bigraph object or signature object.
int	getLevelOf(BigraphEntity<?> place)	Get the depth of a place entity in the place graph (i.e., a tree).
BigraphEntity.Link	getLinkOfPoint(BigraphEntity<?> point)	Returns the link of a bigraph's point type.
org.eclipse.emf.ecore.EPackage	getMetaModel()	Return the metamodel of a bigraph object or a signature object.
<C extends Control<?, ?>> BigraphEntity.NodeEntity<C>	getNodeOfPort(BigraphEntity.Port port)	Always returns null, since elementary bigraphs are node-free bigraphs
<C extends Control<?, ?>> Collection<BigraphEntity.NodeEntity<C>>	getNodes()
List<BigraphEntity<?>>	getOpenNeighborhoodOfVertex(BigraphEntity<?> node)	Gets the neighborhood of the given node of the place graph.
Collection<BigraphEntity.OuterName>	getOuterNames()
BigraphEntity<?>	getParent(BigraphEntity<?> node)	Get the parent of a bigraph's place.
Collection<BigraphEntity<?>>	getPointsFromLink(BigraphEntity.Link linkEntity)	Get all point entities (i.e., ports and inner names) of a link entity (i.e., edges and outer names).
<C extends Control<?, ?>> int	getPortCount(BigraphEntity.NodeEntity<C> node)	Get the number of "blocked/occupied" ports by links of a node.
Collection<BigraphEntity.Port>	getPorts(BigraphEntity<?> node)	Return all ports of a node.
Collection<BigraphEntity.RootEntity>	getRoots()
Collection<BigraphEntity.InnerName>	getSiblingsOfInnerName(BigraphEntity.InnerName innerName)	Returns all siblings of an inner name.
List<BigraphEntity<?>>	getSiblingsOfNode(BigraphEntity<?> node)	Returns all siblings of the given node of the current bigraph.
Collection<BigraphEntity.SiteEntity>	getSites()
BigraphEntity.RootEntity	getTopLevelRoot(BigraphEntity node)
boolean	isLinking()
boolean	isParentOf(BigraphEntity<?> node, BigraphEntity<?> possibleParent)	A recursive function that checks, whether the given node has possibleParent as parent.
boolean	isPlacing()

Methods inherited from class org.bigraphs.framework.core.BigraphDelegator

getBigraphDelegate, getSignature

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bigraphs.framework.core.Bigraph

getIncidentLinksOf, getInnerFace, getOuterFace, getSupport, isActive, isActiveAtNode, isActiveAtSite, isDiscrete, isEpimorphic, isGround, isGuarding, isLean, isMonomorphic, isPrime

Methods inherited from interface org.bigraphs.framework.core.EcoreBigraph

getEMetaModelData, getSignature, isBEdge, isBInnerName, isBLink, isBNode, isBOuterName, isBPlace, isBPoint, isBPort, isBRoot, isBSite, isIndexable, isNameable, isOfEClass

Field Details

metaModelPackage

protected org.eclipse.emf.ecore.EPackage metaModelPackage

instanceModel

protected org.eclipse.emf.ecore.EObject instanceModel

Constructor Details

ElementaryBigraph

public ElementaryBigraph(Bigraph<S> bigraphDelegate)

Method Details

isPlacing

public boolean isPlacing()

isLinking

public boolean isLinking()

getMetaModel

public org.eclipse.emf.ecore.EPackage getMetaModel()

Description copied from interface: EcoreBigraphExt

Return the metamodel of a bigraph object or a signature object.

It is a metamodel that either extends the base bigraph metamodel or the base signature metamodel.

Specified by:

getMetaModel in interface EcoreBigraphExt

Returns:

the metamodel in Ecore format

See Also:

• BigraphBaseModelPackage
• SignatureBaseModelPackage

getInstanceModel

public org.eclipse.emf.ecore.EObject getInstanceModel()

Description copied from interface: EcoreBigraphExt

Return the Ecore-based instance model of a bigraph object or signature object.

Specified by:

getInstanceModel in interface EcoreBigraphExt

Returns:

the instance model in Ecore format

getAllPlaces

public List<BigraphEntity<?>> getAllPlaces()

Description copied from interface: Bigraph

Returns all places of the bigraph, i.e., roots, nodes and sites.

Specified by:

getAllPlaces in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getAllPlaces in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Returns:

all places of the bigraph

getAllLinks

public Collection<BigraphEntity.Link> getAllLinks()

Specified by:

getAllLinks in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getAllLinks in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

getRoots

public Collection<BigraphEntity.RootEntity> getRoots()

Specified by:

getRoots in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getRoots in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

getNodes

public <C extends Control<?,
?>>
Collection<BigraphEntity.NodeEntity<C>> getNodes()

Specified by:

getNodes in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getNodes in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

getSites

public Collection<BigraphEntity.SiteEntity> getSites()

Specified by:

getSites in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getSites in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

getOuterNames

public Collection<BigraphEntity.OuterName> getOuterNames()

Specified by:

getOuterNames in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getOuterNames in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

getInnerNames

public Collection<BigraphEntity.InnerName> getInnerNames()

Specified by:

getInnerNames in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getInnerNames in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

getEdges

public Collection<BigraphEntity.Edge> getEdges()

Specified by:

getEdges in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getEdges in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

getPortCount

public <C extends Control<?,
?>> int getPortCount(BigraphEntity.NodeEntity<C> node)

Description copied from interface: Bigraph

Get the number of "blocked/occupied" ports by links of a node. Check with the control's arity.

Specified by:

getPortCount in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getPortCount in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

node - the node

Returns:

the port count of the node which are already used by links

isParentOf

public boolean isParentOf(BigraphEntity<?> node,
 BigraphEntity<?> possibleParent)

Description copied from interface: Bigraph

A recursive function that checks, whether the given node has possibleParent as parent. This means that possibleParent must not necessarily be the direct parent, but can also be a parent higher in the hierarchy.

Specified by:

isParentOf in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

isParentOf in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

node - the node to check against the parent possibleParent

possibleParent - the possible parent to check against node

Returns:

true, if possibleParent is directly or indirectly the parent of node, otherwise false

getParent

public BigraphEntity<?> getParent(BigraphEntity<?> node)

Description copied from interface: Bigraph

Get the parent of a bigraph's place. Passing a root as argument will always return null.

Specified by:

getParent in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getParent in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

node - a place of this bigraph

Returns:

the parent of the given place, or null

getLinkOfPoint

public BigraphEntity.Link getLinkOfPoint(BigraphEntity<?> point)

Description copied from interface: Bigraph

Returns the link of a bigraph's point type.

Specified by:

getLinkOfPoint in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getLinkOfPoint in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

point - a point of the bigraph

Returns:

returns the link that connects the point a null

getLevelOf

public int getLevelOf(BigraphEntity<?> place)

Description copied from interface: Bigraph

Get the depth of a place entity in the place graph (i.e., a tree). The depth of a root node is always 0.

Specified by:

getLevelOf in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getLevelOf in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

place - the place node in question to compute its depth

Returns:

the depth of the given place entity of this bigraph

getSiblingsOfInnerName

public Collection<BigraphEntity.InnerName> getSiblingsOfInnerName(BigraphEntity.InnerName innerName)

Description copied from interface: Bigraph

Returns all siblings of an inner name. The collection will not contain any port.

Specified by:

getSiblingsOfInnerName in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getSiblingsOfInnerName in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

innerName - the inner name who's siblings should be returned

Returns:

the siblings connected to innerName

getNodeOfPort

public <C extends Control<?,
?>>
BigraphEntity.NodeEntity<C> getNodeOfPort(BigraphEntity.Port port)

Always returns null, since elementary bigraphs are node-free bigraphs

Specified by:

getNodeOfPort in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getNodeOfPort in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Type Parameters:

C - not considered

Parameters:

port - not considered

Returns:

null is returned in every case

getPointsFromLink

public Collection<BigraphEntity<?>> getPointsFromLink(BigraphEntity.Link linkEntity)

Description copied from interface: Bigraph

Get all point entities (i.e., ports and inner names) of a link entity (i.e., edges and outer names).

Specified by:

getPointsFromLink in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getPointsFromLink in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

linkEntity - the link entity who's connections shall be returned

Returns:

collection of points connected to the link entity

getSiblingsOfNode

public List<BigraphEntity<?>> getSiblingsOfNode(BigraphEntity<?> node)

Description copied from interface: Bigraph

Returns all siblings of the given node of the current bigraph. The node itself is not included.

Specified by:

getSiblingsOfNode in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getSiblingsOfNode in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

node - the node whoms sibling should be returned

Returns:

siblings of node

getChildrenOf

public List<BigraphEntity<?>> getChildrenOf(BigraphEntity<?> node)

Description copied from interface: Bigraph

Returns the set of children of a given node (including sites).
If the node has no children, then an empty set is returned.

Specified by:

getChildrenOf in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getChildrenOf in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

node - the node whose children should be returned

Returns:

a set of children of the given node

getPorts

public Collection<BigraphEntity.Port> getPorts(BigraphEntity<?> node)

Description copied from interface: Bigraph

Return all ports of a node. If the node's control has arity 0, then the list will always be empty. If no link is attached to a port, the list will also be empty.

Specified by:

getPorts in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getPorts in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

node - the node who's ports shall be returned

Returns:

all ports of a node

areConnected

public final <C extends Control<?,
?>> boolean areConnected(BigraphEntity.NodeEntity<C> place1,
 BigraphEntity.NodeEntity<C> place2)

Description copied from interface: Bigraph

Check if two nodes are connected to each other. The method considers connections by edges and outer names.

Specified by:

areConnected in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

areConnected in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

place1 - left node

place2 - right node

Returns:

true, if the two nodes are connected by an edge or outer name

getOpenNeighborhoodOfVertex

public List<BigraphEntity<?>> getOpenNeighborhoodOfVertex(BigraphEntity<?> node)

Description copied from interface: Bigraph

Gets the neighborhood of the given node of the place graph. The neighborhood is the set containing the its children and its parent (without the node in question itself).

Specified by:

getOpenNeighborhoodOfVertex in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getOpenNeighborhoodOfVertex in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Parameters:

node - the nodes who's neighborhood should be returned

Returns:

the neighborhood of the node of the place graph

getTopLevelRoot

public BigraphEntity.RootEntity getTopLevelRoot(BigraphEntity node)

Specified by:

getTopLevelRoot in interface Bigraph<S extends AbstractEcoreSignature<? extends Control<?,?>>>

Overrides:

getTopLevelRoot in class BigraphDelegator<S extends AbstractEcoreSignature<? extends Control<?,?>>>