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

Class CellMLHierarchy

java.lang.Object

de.unirostock.sems.bives.cellml.parser.CellMLHierarchy

public class CellMLHierarchy
extends Object

The Class CellMLHierarchy representing the hierarchy of CellML components.

Author:

Martin Scharm

Field Summary

Fields

Modifier and Type	Field	Description
static int	RELATION_ENCAPSULATED	The Constant RELATION_ENCAPSULATED => component 1 is encapsulated in component 2.
static int	RELATION_HIDDEN	The Constant RELATION_HIDDEN => components cannot see each other.
static int	RELATION_PARENT	The Constant RELATION_PARENT => component 1 is parent of component 2 .
static int	RELATION_SIBLING	The Constant RELATION_SIBLING => components are siblings.

Constructor Summary

Constructors

Constructor	Description
CellMLHierarchy(CellMLModel model)	Instantiates a new CellML hierarchy object.

Method Summary

Modifier and Type	Method	Description
CellMLHierarchyNetwork	getEncapsulationHierarchyNetwork()	Gets the encapsulation hierarchy network.
int	getEncapsulationRelationship(CellMLComponent component_1, CellMLComponent component_2)	Gets the encapsulation relationship of two components.
CellMLHierarchyNetwork	getHierarchyNetwork(String relationship, String name)	Gets a specific hierarchy network.
void	parseGroup(de.unirostock.sems.xmlutils.ds.DocumentNode node)	Parses a component group.

Methods inherited from class java.lang.Object

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

Field Detail

RELATION_HIDDEN

public static final int RELATION_HIDDEN

The Constant RELATION_HIDDEN => components cannot see each other.

See Also:

Constant Field Values

RELATION_SIBLING

public static final int RELATION_SIBLING

The Constant RELATION_SIBLING => components are siblings.

See Also:

Constant Field Values

RELATION_PARENT

public static final int RELATION_PARENT

The Constant RELATION_PARENT => component 1 is parent of component 2 .

See Also:

Constant Field Values

RELATION_ENCAPSULATED

public static final int RELATION_ENCAPSULATED

The Constant RELATION_ENCAPSULATED => component 1 is encapsulated in component 2.

See Also:

Constant Field Values

Constructor Detail

CellMLHierarchy

public CellMLHierarchy(CellMLModel model)

Instantiates a new CellML hierarchy object.

Parameters:

model - the model

Method Detail

getEncapsulationHierarchyNetwork

public CellMLHierarchyNetwork getEncapsulationHierarchyNetwork()

Gets the encapsulation hierarchy network.

Returns:

the encapsulation hierarchy network

getHierarchyNetwork

public CellMLHierarchyNetwork getHierarchyNetwork(String relationship,
                                                  String name)

Gets a specific hierarchy network.

Parameters:

relationship - the name of the relationship

name - the name of the hierarchy

Returns:

the hierarchy network

parseGroup

public void parseGroup(de.unirostock.sems.xmlutils.ds.DocumentNode node)
                throws BivesCellMLParseException,
                       de.unirostock.sems.bives.exception.BivesLogicalException

Parses a component group.

Parameters:

node - the corresponding document node in the XML tree

Throws:

BivesCellMLParseException - the bives cell ml parse exception

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

getEncapsulationRelationship

public int getEncapsulationRelationship(CellMLComponent component_1,
                                        CellMLComponent component_2)
                                 throws de.unirostock.sems.bives.exception.BivesLogicalException

Gets the encapsulation relationship of two components.

Parameters:

component_1 - the first component

component_2 - the second component

Returns:

the encapsulation relationship

Throws:

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