Package org.bigraphs.framework.core

Class BigraphDelegator<S extends Signature<?>>

java.lang.Object

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

Type Parameters:

S - the signature type

All Implemented Interfaces:

Bigraph<S>, HasSignature<S>

Direct Known Subclasses:

AbstractDynamicMatchAdapter, BigraphCompositeSupport, ElementaryBigraph

public abstract class BigraphDelegator<S extends Signature<?>>
extends Object
implements Bigraph<S>

Delegator base class for bigraphs.

Currently supports only pure bigraphs.

Wraps a Bigraph instance and forwards all calls to it. Subclasses can extend or adapt behavior by overriding selected methods while reusing the delegate for the core implementation.

Author:

Dominik Grzelak

Field Summary

Fields

Modifier and Type	Field	Description
protected Bigraph<S>	bigraphDelegate

Constructor Summary

Constructors

Constructor	Description
BigraphDelegator(Bigraph<S> bigraphDelegate)

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.
Collection<BigraphEntity.Link>	getAllLinks()
Collection<BigraphEntity<?>>	getAllPlaces()	Returns all places of the bigraph, i.e., roots, nodes and sites.
protected <B extends Bigraph<S>> B	getBigraphDelegate()
Collection<BigraphEntity<?>>	getChildrenOf(BigraphEntity<?> node)	Returns the set of children of a given node (including sites).
Collection<BigraphEntity.Edge>	getEdges()
Collection<BigraphEntity.InnerName>	getInnerNames()
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.
<C extends Control<?, ?>> BigraphEntity.NodeEntity<C>	getNodeOfPort(BigraphEntity.Port port)
<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.
Collection<BigraphEntity<?>>	getSiblingsOfNode(BigraphEntity<?> node)	Returns all siblings of the given node of the current bigraph.
S	getSignature()	Get the corresponding signature of the underlying bigraph
Collection<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

Field Details

bigraphDelegate

protected Bigraph<S extends Signature<?>> bigraphDelegate

Constructor Details

BigraphDelegator

public BigraphDelegator(Bigraph<S> bigraphDelegate)

Method Details

getBigraphDelegate

protected <B extends Bigraph<S>> B getBigraphDelegate()

getSignature

public S getSignature()

Description copied from interface: HasSignature

Get the corresponding signature of the underlying bigraph

Specified by:

getSignature in interface Bigraph<S extends Signature<?>>

Specified by:

getSignature in interface HasSignature<S extends Signature<?>>

Returns:

the signature of the bigraph

getRoots

public Collection<BigraphEntity.RootEntity> getRoots()

Specified by:

getRoots in interface Bigraph<S extends Signature<?>>

getSites

public Collection<BigraphEntity.SiteEntity> getSites()

Specified by:

getSites in interface Bigraph<S extends Signature<?>>

getOuterNames

public Collection<BigraphEntity.OuterName> getOuterNames()

Specified by:

getOuterNames in interface Bigraph<S extends Signature<?>>

getInnerNames

public Collection<BigraphEntity.InnerName> getInnerNames()

Specified by:

getInnerNames in interface Bigraph<S extends Signature<?>>

getEdges

public Collection<BigraphEntity.Edge> getEdges()

Specified by:

getEdges in interface Bigraph<S extends Signature<?>>

getNodes

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

Specified by:

getNodes in interface Bigraph<S extends Signature<?>>

getChildrenOf

public Collection<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 Signature<?>>

Parameters:

node - the node whose children should be returned

Returns:

a set of children of the given node

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<S extends Signature<?>>

Parameters:

place1 - left node

place2 - right node

Returns:

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

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 Signature<?>>

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 Signature<?>>

Parameters:

point - a point of the bigraph

Returns:

returns the link that connects the point a null

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 Signature<?>>

Parameters:

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

Returns:

collection of points connected to the link entity

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 Signature<?>>

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 Signature<?>>

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 Signature<?>>

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

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 Signature<?>>

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)

Specified by:

getNodeOfPort in interface Bigraph<S extends Signature<?>>

getSiblingsOfNode

public Collection<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 Signature<?>>

Parameters:

node - the node whoms sibling should be returned

Returns:

siblings of node

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 Signature<?>>

Parameters:

place - the place node in question to compute its depth

Returns:

the depth of the given place entity of this bigraph

getAllPlaces

public Collection<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 Signature<?>>

Returns:

all places of the bigraph

getAllLinks

public Collection<BigraphEntity.Link> getAllLinks()

Specified by:

getAllLinks in interface Bigraph<S extends Signature<?>>

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 Signature<?>>

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<S extends Signature<?>>

Parameters:

node - the node

Returns:

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