Package org.bigraphs.framework.core.impl.pure

Class PureBigraph

java.lang.Object

org.bigraphs.framework.core.impl.pure.PureBigraph

All Implemented Interfaces:

Bigraph<DefaultDynamicSignature>, EcoreBigraph<DefaultDynamicSignature>, EcoreBigraphExt, HasSignature<DefaultDynamicSignature>

public class PureBigraph
extends Object
implements Bigraph<DefaultDynamicSignature>, EcoreBigraph<DefaultDynamicSignature>

This class is an Ecore-based model implementation of a pure bigraph. A PureBigraph can be obtained by using a PureBigraphBuilder.

The class directly implements the Bigraph interface with DefaultDynamicSignature as type for the signature.

The class represents an immutable data structure providing also some operations (e.g., get parent of node). The elements are stored separately in collections for easier access. The collections cannot be modified afterwards.

Author:

Dominik Grzelak

See Also:

• BigraphBuilder

Nested Class Summary

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

EcoreBigraph.Stub<S extends AbstractEcoreSignature<?>>

Constructor Summary

Constructors

Constructor	Description
PureBigraph(BigraphBuilderSupport.InstanceParameter details)

Method Summary

Modifier and Type	Method	Description
<C extends Control<?, ?>> boolean	areConnected(BigraphEntity.NodeEntity<C> place1, BigraphEntity.NodeEntity<C> place2)	Check if two nodes are connected to each other.
List<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).
List<BigraphEntity.Edge>	getEdges()
List<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.
BigraphEntity.NodeEntity<DefaultDynamicControl>	getNodeOfPort(BigraphEntity.Port port)
List<BigraphEntity.NodeEntity<DefaultDynamicControl>>	getNodes()
List<BigraphEntity<?>>	getOpenNeighborhoodOfVertex(BigraphEntity<?> node)	Gets the neighborhood of the given node of the place graph.
List<BigraphEntity.OuterName>	getOuterNames()
BigraphEntity<?>	getParent(BigraphEntity<?> node)	Get the parent of a bigraph's place.
List<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.
List<BigraphEntity.Port>	getPorts(BigraphEntity<?> node)	Return all ports of a node.
List<BigraphEntity.RootEntity>	getRoots()
List<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.
DefaultDynamicSignature	getSignature()	Get the corresponding signature of the underlying bigraph
List<BigraphEntity.SiteEntity>	getSites()
BigraphEntity.RootEntity	getTopLevelRoot(BigraphEntity<?> node)
boolean	isParentOf(BigraphEntity<?> node, BigraphEntity<?> possibleParent)	A recursive function that checks, whether the given node has possibleParent as parent.

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, isBEdge, isBInnerName, isBLink, isBNode, isBOuterName, isBPlace, isBPoint, isBPort, isBRoot, isBSite, isIndexable, isNameable, isOfEClass

Constructor Details

PureBigraph

public PureBigraph(BigraphBuilderSupport.InstanceParameter details)

Method Details

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:

• de.tudresden.inf.st.bigraphs.models.bigraphBaseModel.BigraphBaseModelPackage

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

getSignature

public DefaultDynamicSignature getSignature()

Description copied from interface: HasSignature

Get the corresponding signature of the underlying bigraph

Specified by:

getSignature in interface Bigraph<DefaultDynamicSignature>

Specified by:

getSignature in interface EcoreBigraph<DefaultDynamicSignature>

Specified by:

getSignature in interface HasSignature<DefaultDynamicSignature>

Returns:

the signature of the bigraph

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<DefaultDynamicSignature>

Parameters:

place - the place node in question to compute its depth

Returns:

the depth of the given place entity of this bigraph

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<DefaultDynamicSignature>

Parameters:

node - the nodes who's neighborhood should be returned

Returns:

the neighborhood of the node of the place graph

getRoots

public List<BigraphEntity.RootEntity> getRoots()

Specified by:

getRoots in interface Bigraph<DefaultDynamicSignature>

getSites

public List<BigraphEntity.SiteEntity> getSites()

Specified by:

getSites in interface Bigraph<DefaultDynamicSignature>

getOuterNames

public List<BigraphEntity.OuterName> getOuterNames()

Specified by:

getOuterNames in interface Bigraph<DefaultDynamicSignature>

getInnerNames

public List<BigraphEntity.InnerName> getInnerNames()

Specified by:

getInnerNames in interface Bigraph<DefaultDynamicSignature>

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<DefaultDynamicSignature>

Returns:

all places of the bigraph

getAllLinks

public List<BigraphEntity.Link> getAllLinks()

Specified by:

getAllLinks in interface Bigraph<DefaultDynamicSignature>

getEdges

public List<BigraphEntity.Edge> getEdges()

Specified by:

getEdges in interface Bigraph<DefaultDynamicSignature>

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<DefaultDynamicSignature>

Parameters:

node - a place of this bigraph

Returns:

the parent of the given place, or null

getSiblingsOfInnerName

public List<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<DefaultDynamicSignature>

Parameters:

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

Returns:

the siblings connected to innerName

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<DefaultDynamicSignature>

Parameters:

node - the node whoms sibling should be returned

Returns:

siblings of node

getNodeOfPort

public BigraphEntity.NodeEntity<DefaultDynamicControl> getNodeOfPort(BigraphEntity.Port port)

Specified by:

getNodeOfPort in interface Bigraph<DefaultDynamicSignature>

getPorts

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

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.

The list is ordered subject to the ports indices.

Specified by:

getPorts in interface Bigraph<DefaultDynamicSignature>

Parameters:

node - the node who's ports shall be returned

Returns:

all ports of a node

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<DefaultDynamicSignature>

Parameters:

node - the node

Returns:

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

getPointsFromLink

public List<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<DefaultDynamicSignature>

Parameters:

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

Returns:

collection of points connected to the link entity

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<DefaultDynamicSignature>

Parameters:

point - a point of the bigraph

Returns:

returns the link that connects the point a null

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<DefaultDynamicSignature>

Parameters:

node - the node whose children should be returned

Returns:

a set of children of the given node

getNodes

public List<BigraphEntity.NodeEntity<DefaultDynamicControl>> getNodes()

Specified by:

getNodes in interface Bigraph<DefaultDynamicSignature>

getTopLevelRoot

public BigraphEntity.RootEntity getTopLevelRoot(BigraphEntity<?> node)

Specified by:

getTopLevelRoot in interface Bigraph<DefaultDynamicSignature>

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<DefaultDynamicSignature>

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

areConnected

public <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<DefaultDynamicSignature>

Parameters:

place1 - left node

place2 - right node

Returns:

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