org.sbml.jsbml.ext.comp

Class SBaseRef

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.comp.SBaseRef

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, SBase, TreeNodeWithChangeSupport

Direct Known Subclasses:

AbstractNamedSBaseRef, ReplacedBy, ReplacedElement

public class SBaseRef
extends AbstractSBase

Contains the machinery for constructing references to specific components within enclosed models or even within external models located in other files.

The four different attributes on SBaseRef are mutually exclusive: only one of the attributes can have a value at any given time, and exactly one must have a value in a given SBaseRef object instance.

Since:

1.0

Version:

$Rev: 1725 $

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	idRef This attribute is used to refer to a regular identifier (i.e., the value of an id attribute on some other object), in the case when the reference being constructed with the SBaseRef is intended to refer to an object that does not have a port identifier.
private java.lang.String	metaIdRef This attribute is used to refer to a metaid attribute value on some other object, in the case when the reference being constructed with the SBaseRef is intended to refer to an object that does not have a port identifier.
private java.lang.String	portRef This attribute is used to refer to a port identifier, in the case when the reference being constructed with the SBaseRef is intended to refer to a port on a submodel.
private SBaseRef	sBaseRef An SBaseRef object may have up to one subcomponent named sBaseRef.
private static long	serialVersionUID Generated serial version identifier.
private java.lang.String	unitRef This attribute is used to refer to the identifier of a UnitDefinition object.

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
SBaseRef() Creates a SBaseRef instance.
SBaseRef(int level, int version) Creates a SBaseRef instance with a level and version.
SBaseRef(SBaseRef obj) Clone constructor

Method Summary

Methods

Modifier and Type	Method and Description
SBaseRef	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
SBaseRef	createSBaseRef() Creates a new SBaseRef instance and add it to this SBaseRef
boolean	equals(java.lang.Object obj) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
java.lang.String	getIdRef() Returns the value of idRef
java.lang.String	getMetaIdRef() Returns the value of metaIdRef
java.lang.String	getPortRef() Returns the value of portRef
SBaseRef	getSBaseRef() Returns the value of sBaseRef
java.lang.String	getUnitRef() Returns the value of unitRef
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetIdRef() Returns whether idRef is set
boolean	isSetMetaIdRef() Returns whether metaIdRef is set
boolean	isSetPortRef() Returns whether portRef is set
boolean	isSetSBaseRef() Returns whether sBaseRef is set
boolean	isSetUnitRef() Returns whether unitRef is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setIdRef(java.lang.String idRef) Sets the value of the optional idRef attribute.
void	setMetaIdRef(java.lang.String metaIdRef) Sets the value of the optional metaIdRef attribute.
void	setPortRef(java.lang.String portRef) Sets the value of the optional portRef attribute.
void	setSBaseRef(SBaseRef sBaseRef) Sets the value of the optional sBaseRef element.
void	setUnitRef(java.lang.String unitRef) Sets the value of the optional unitRef attribute This attribute is used to refer to the identifier of a UnitDefinition object.
java.lang.String	toString()
boolean	unsetIdRef() Unsets the variable idRef
boolean	unsetMetaIdRef() Unsets the variable metaIdRef
boolean	unsetPortRef() Unsets the variable portRef
boolean	unsetSBaseRef() Unsets the variable sBaseRef
boolean	unsetUnitRef() Unsets the variable unitRef
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a map with all the attributes of this SBase that need to be written out in XML.

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

portRef

private java.lang.String portRef

This attribute is used to refer to a port identifier, in the case when the reference being constructed with the SBaseRef is intended to refer to a port on a submodel. The namespace of the PortSIdRef value is the set of identifiers of type PortSId defined in the submodel, not the parent model.

idRef

private java.lang.String idRef

This attribute is used to refer to a regular identifier (i.e., the value of an id attribute on some other object), in the case when the reference being constructed with the SBaseRef is intended to refer to an object that does not have a port identifier. The namespace of the SIdRef value is the set of identifiers of type SId defined in the submodel, not the parent model.

unitRef

private java.lang.String unitRef

This attribute is used to refer to the identifier of a UnitDefinition object. The namespace of the UnitSIdRef value is the set of unit identifiers defined in the submodel, not the parent model.

metaIdRef

private java.lang.String metaIdRef

This attribute is used to refer to a metaid attribute value on some other object, in the case when the reference being constructed with the SBaseRef is intended to refer to an object that does not have a port identifier. The namespace of the metaIdRef value is the entire document in which the referenced model resides

sBaseRef

private SBaseRef sBaseRef

An SBaseRef object may have up to one subcomponent named sBaseRef. This permits recursive structures to be constructed so that objects inside submodels can be referenced.

Constructor Detail

SBaseRef

public SBaseRef()

Creates a SBaseRef instance.

Parameters:

level -

version -

SBaseRef

public SBaseRef(int level,
        int version)

Creates a SBaseRef instance with a level and version.

Parameters:

level -

version -

SBaseRef

public SBaseRef(SBaseRef obj)

Clone constructor

Method Detail

clone

public SBaseRef clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractSBase

Returns:

a copy of this object

getPortRef

public java.lang.String getPortRef()

Returns the value of portRef

Returns:

the value of portRef

isSetPortRef

public boolean isSetPortRef()

Returns whether portRef is set

Returns:

whether portRef is set

setPortRef

public void setPortRef(java.lang.String portRef)

Sets the value of the optional portRef attribute. As its name implies, this attribute is used to refer to a port identifier, in the case when the reference being constructed with the SBaseRef is intended to refer to a port on a submodel.

unsetPortRef

public boolean unsetPortRef()

Unsets the variable portRef

Returns:

true, if portRef was set before, otherwise false

getIdRef

public java.lang.String getIdRef()

Returns the value of idRef

Returns:

the value of idRef

isSetIdRef

public boolean isSetIdRef()

Returns whether idRef is set

Returns:

whether idRef is set

setIdRef

public void setIdRef(java.lang.String idRef)

Sets the value of the optional idRef attribute. As its name implies, this attribute is used to refer to a regular identifier (i.e., the value of an id attribute on some other object), in the case when the reference being constructed with the SBaseRef is intended to refer to an object that does not have a port identifier.

unsetIdRef

public boolean unsetIdRef()

Unsets the variable idRef

Returns:

true, if idRef was set before, otherwise false

getUnitRef

public java.lang.String getUnitRef()

Returns the value of unitRef

Returns:

the value of unitRef

isSetUnitRef

public boolean isSetUnitRef()

Returns whether unitRef is set

Returns:

whether unitRef is set

setUnitRef

public void setUnitRef(java.lang.String unitRef)

Sets the value of the optional unitRef attribute This attribute is used to refer to the identifier of a UnitDefinition object. The namespace of the UnitSIdRef value is the set of unit identifiers defined in the submodel, not the parent model. Note that even though this attribute is of type UnitSIdRef, the reserved unit identifiers that are defined by SBML Level 3 are not permitted as values of unitRef. Reserved unit identifiers may not be replaced or deleted.

unsetUnitRef

public boolean unsetUnitRef()

Unsets the variable unitRef

Returns:

true, if unitRef was set before, otherwise false

getMetaIdRef

public java.lang.String getMetaIdRef()

Returns the value of metaIdRef

Returns:

the value of metaIdRef

isSetMetaIdRef

public boolean isSetMetaIdRef()

Returns whether metaIdRef is set

Returns:

whether metaIdRef is set

setMetaIdRef

public void setMetaIdRef(java.lang.String metaIdRef)

Sets the value of the optional metaIdRef attribute. This attribute is used to refer to a metaid attribute value on some other object, in the case when the reference being constructed with the SBaseRef is intended to refer to an object that does not have a port identifier. The namespace of the metaIdRef value is the entire document in which the referenced model resides, but must refer to a subelement of the referenced model. Since meta identifiers are optional attributes of SBase, all SBML objects have the potential to have a meta identifier value.

unsetMetaIdRef

public boolean unsetMetaIdRef()

Unsets the variable metaIdRef

Returns:

true, if metaIdRef was set before, otherwise false

createSBaseRef

public SBaseRef createSBaseRef()

Creates a new SBaseRef instance and add it to this SBaseRef

Returns:

a new SBaseRef instance (added to this SBaseRef)

getSBaseRef

public SBaseRef getSBaseRef()

Returns the value of sBaseRef

Returns:

the value of sBaseRef

isSetSBaseRef

public boolean isSetSBaseRef()

Returns whether sBaseRef is set

Returns:

whether sBaseRef is set

setSBaseRef

public void setSBaseRef(SBaseRef sBaseRef)

Sets the value of the optional sBaseRef element. An SBaseRef object may have up to one subcomponent named sBaseRef, of type SBaseRef. This permits recursive structures to be constructed so that objects inside submodels can be referenced.

unsetSBaseRef

public boolean unsetSBaseRef()

Unsets the variable sBaseRef

Returns:

true, if sBaseRef was set before, otherwise false

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSBase

getChildAt

public javax.swing.tree.TreeNode getChildAt(int index)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractSBase

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Description copied from interface: SBase

Returns a map with all the attributes of this SBase that need to be written out in XML.

The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase

Returns:

a Map containing the XML attributes of this object.

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                    java.lang.String prefix,
                    java.lang.String value)

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

toString

public java.lang.String toString()

Specified by:

toString in class AbstractSBase

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

Parameters:

obj - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.