Package de.unirostock.sems.bives.sbml.parser

Class SBMLGenericIdNameObject

java.lang.Object

de.unirostock.sems.bives.sbml.parser.SBMLGenericObject

de.unirostock.sems.bives.sbml.parser.SBMLSBase

de.unirostock.sems.bives.sbml.parser.SBMLGenericIdNameObject

Direct Known Subclasses:

SBMLCompartment, SBMLCompartmentType, SBMLFunctionDefinition, SBMLParameter, SBMLReaction, SBMLSpecies, SBMLSpeciesType, SBMLUnitDefinition

public abstract class SBMLGenericIdNameObject
extends SBMLSBase

The Class SBMLGenericIdNameObject representing a generic object that has an id and a name.

Author:

Martin Scharm

Field Summary

Fields

Modifier and Type	Field	Description
protected String	id	The id.
protected String	name	The name.

Fields inherited from class de.unirostock.sems.bives.sbml.parser.SBMLGenericObject

documentNode, sbmlModel

Constructor Summary

Constructors

Constructor	Description
SBMLGenericIdNameObject(de.unirostock.sems.xmlutils.ds.DocumentNode documentNode, SBMLModel sbmlModel)	Instantiates a new SBML generic id-name-object.

Method Summary

Modifier and Type	Method	Description
String	getID()	Gets the id.
String	getName()	Gets the name.
String	getNameAndId()	Gets the name (if defined) and the id as: NAME (ID).
String	getNameOrId()	Gets the name (if defined) or the id (if name undefined).

Methods inherited from class java.lang.Object

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

Methods inherited from class de.unirostock.sems.bives.sbml.parser.SBMLGenericObject

getDocumentNode, getModel

Methods inherited from class de.unirostock.sems.bives.sbml.parser.SBMLSBase

addOntologyLink, flagMetaModifcations, getAnnotation, getMetaId, getNotes, getOntologyLinks, getSBOTerm

Field Detail

id

protected String id

The id.

name

protected String name

The name.

Constructor Detail

SBMLGenericIdNameObject

public SBMLGenericIdNameObject(de.unirostock.sems.xmlutils.ds.DocumentNode documentNode,
                               SBMLModel sbmlModel)
                        throws BivesSBMLParseException

Instantiates a new SBML generic id-name-object.

Parameters:

documentNode - the document node encoding this entity in the corresponding XML tree

sbmlModel - the SBML model

Throws:

BivesSBMLParseException - the bives sbml parse exception

Method Detail

getNameOrId

public final String getNameOrId()

Gets the name (if defined) or the id (if name undefined).

Returns:

the name or id

getNameAndId

public final String getNameAndId()

Gets the name (if defined) and the id as: NAME (ID).

Returns:

the name and id

getID

public final String getID()

Gets the id.

Returns:

the id

getName

public final String getName()

Gets the name.

Returns:

the name