Package de.unirostock.sems.bives.cellml.parser

Class CellMLHierarchyNetwork

java.lang.Object

de.unirostock.sems.bives.cellml.parser.CellMLHierarchyNetwork

public class CellMLHierarchyNetwork
extends Object

The Class CellMLHierarchyNetwork representing a hirarchical network of CellML components.

Author:

Martin Scharm

Constructor Summary

Constructors

Constructor	Description
CellMLHierarchyNetwork(String relationship, String name)	Instantiates a new CellML hierarchy network.

Method Summary

Modifier and Type	Method	Description
void	connectHierarchically(CellMLComponent parent, CellMLComponent kid)	Connect a parent component and its child hierarchically.
String	getName()	Gets the name of this network.
CellMLHierarchyNode	getNode(CellMLComponent component)	Gets the node that corresponds to a certain CellML component.
Collection<CellMLHierarchyNode>	getNodes()	Gets all nodes of this network.
String	getRelationship()	Gets the relationship type.
CellMLHierarchyNode	putNode(CellMLComponent component)	Install a new hierarchy node if it doesn't exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

CellMLHierarchyNetwork

public CellMLHierarchyNetwork(String relationship,
                              String name)

Instantiates a new CellML hierarchy network.

Parameters:

relationship - the name of the relationship

name - the name of the hierarchy

Method Detail

getNode

public CellMLHierarchyNode getNode(CellMLComponent component)

Gets the node that corresponds to a certain CellML component.

Parameters:

component - the component

Returns:

the node

getNodes

public Collection<CellMLHierarchyNode> getNodes()

Gets all nodes of this network.

Returns:

the nodes

putNode

public CellMLHierarchyNode putNode(CellMLComponent component)

Install a new hierarchy node if it doesn't exist. Will return a new node if there is no node for this component, or the corresponding node if it exists.

Parameters:

component - the component

Returns:

the corresponding CellML hierarchy node

connectHierarchically

public void connectHierarchically(CellMLComponent parent,
                                  CellMLComponent kid)
                           throws de.unirostock.sems.bives.exception.BivesLogicalException

Connect a parent component and its child hierarchically.

Parameters:

parent - the parent component

kid - the child component

Throws:

de.unirostock.sems.bives.exception.BivesLogicalException - the bives logical exception

getRelationship

public String getRelationship()

Gets the relationship type.

Returns:

the relationship type

getName

public String getName()

Gets the name of this network.

Returns:

the name