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

Class CellMLUnitDictionary

java.lang.Object

de.unirostock.sems.bives.cellml.parser.CellMLUnitDictionary

public class CellMLUnitDictionary
extends Object

The Class CellMLUnitDictionary storing all known units.

Author:

Martin Scharm

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	STANDARD_UNITS	The common standard units

Constructor Summary

Constructors

Constructor	Description
CellMLUnitDictionary(CellMLModel model)	Instantiates a new CellML unit dictionary.

Method Summary

Modifier and Type	Method	Description
void	addUnit(CellMLComponent c, CellMLUserUnit u, boolean imported)	Adds a unit.
HashMap<String,CellMLUserUnit>	getComponentUnits(CellMLComponent component)	Gets the units defined in a certain component.
HashMap<String,CellMLUserUnit>	getModelUnits()	Gets the units defined globally in the model.
CellMLUnit	getUnit(String name, CellMLComponent c)	Gets a unit by its name.

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD_UNITS

public static final String[] STANDARD_UNITS

The common standard units

Constructor Detail

CellMLUnitDictionary

public CellMLUnitDictionary(CellMLModel model)
                     throws de.unirostock.sems.bives.exception.BivesLogicalException

Instantiates a new CellML unit dictionary.

Parameters:

model - the corresponding model

Throws:

de.unirostock.sems.bives.exception.BivesLogicalException

Method Detail

getUnit

public CellMLUnit getUnit(String name,
                          CellMLComponent c)

Gets a unit by its name. Tries to first find the unit in the component and in the whole model, before it searched for this unit in the standard units.

Parameters:

name - the name of the unit

c - the component which needs the unit

Returns:

the unit

getComponentUnits

public HashMap<String,CellMLUserUnit> getComponentUnits(CellMLComponent component)

Gets the units defined in a certain component.

Parameters:

component - the component of interest

Returns:

the units defined in this component

getModelUnits

public HashMap<String,CellMLUserUnit> getModelUnits()

Gets the units defined globally in the model.

Returns:

the model units

addUnit

public void addUnit(CellMLComponent c,
                    CellMLUserUnit u,
                    boolean imported)
             throws de.unirostock.sems.bives.exception.BivesDocumentConsistencyException

Adds a unit. If import is set to true we allow for double-definition of units if they emerged from the same document.

Parameters:

c - the component which defines the unit locally, or null if it's a global unit

u - the unit

imported - is that an import?

Throws:

de.unirostock.sems.bives.exception.BivesDocumentConsistencyException - the bives document consistency exception