Package org.sbml.jsbml.ext.comp

Class ReplacedBy

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.comp.SBaseRef

org.sbml.jsbml.ext.comp.ReplacedBy

All Implemented Interfaces:

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

public class ReplacedBy
extends SBaseRef

Indicates when the parent object is to be replaced by another object.

Since:

1.0

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

JSBML_WRONG_SBO_TERM

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ReplacedBy	clone()	clones this class
boolean	equals(java.lang.Object obj)	Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
java.lang.String	getSubmodelRef()	Returns the value of submodelRef
int	hashCode()	Returns a hash code value for this SBase instance.
void	initDefaults()	Initializes the default values using the namespace.
boolean	isSetSubmodelRef()	Returns whether submodelRef is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)	Sets the given attribute in this SBase.
boolean	removeFromParent()	This method is designed to be overridden for non-independent child nodes
void	setSubmodelRef(java.lang.String submodelRef)	Sets the value of the required submodelRef attribute.
boolean	unsetSubmodelRef()	Unsets the variable submodelRef
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, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, 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, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

Methods inherited from class org.sbml.jsbml.ext.comp.SBaseRef

createSBaseRef, getAllowsChildren, getChildAt, getChildCount, getIdRef, getMetaIdRef, getPortRef, getSBaseRef, getUnitRef, isSetIdRef, isSetMetaIdRef, isSetPortRef, isSetSBaseRef, isSetUnitRef, setIdRef, setMetaIdRef, setPortRef, setSBaseRef, setUnitRef, unsetIdRef, unsetMetaIdRef, unsetPortRef, unsetSBaseRef, unsetUnitRef

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

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, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Constructor Detail

ReplacedBy

public ReplacedBy()

Creates a ReplacedBy instance

ReplacedBy

public ReplacedBy(int level,
                  int version)

Creates a ReplacedBy instance with a level and version.

Parameters:

level - the SBML level

version - the SBML version

ReplacedBy

public ReplacedBy(ReplacedBy obj)

Clone constructor

Parameters:

obj - the instance to clone

Method Detail

clone

public ReplacedBy clone()

clones this class

Specified by:

clone in interface SBase

Overrides:

clone in class SBaseRef

Returns:

a copy of this object

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

Overrides:

initDefaults in class SBaseRef

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 SBaseRef

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 SBaseRef

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.

getSubmodelRef

public java.lang.String getSubmodelRef()

Returns the value of submodelRef

Returns:

the value of submodelRef

isSetSubmodelRef

public boolean isSetSubmodelRef()

Returns whether submodelRef is set

Returns:

whether submodelRef is set

setSubmodelRef

public void setSubmodelRef(java.lang.String submodelRef)

Sets the value of the required submodelRef attribute.

The required attribute submodelRef takes a value which must be the identifier of a Submodel object in the containing model. This attribute is analogous to the corresponding attribute on ReplacedElement; that is, the model referenced by the Submodel object establishes the object namespaces for the portRef, idRef, unitRef and metaIdRef attributes: only objects within the Model object may be referenced by those attributes.

Parameters:

submodelRef - the value of submodelRef

unsetSubmodelRef

public boolean unsetSubmodelRef()

Unsets the variable submodelRef

Returns:

true, if submodelRef was set before, otherwise false

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 SBaseRef

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 SBaseRef

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.

removeFromParent

public boolean removeFromParent()

Description copied from class: AbstractTreeNode

This method is designed to be overridden for non-independent child nodes

Specified by:

removeFromParent in interface TreeNodeWithChangeSupport

Overrides:

removeFromParent in class AbstractTreeNode

Returns:

false if this element is a root node, true otherwise.

See Also:

TreeNodeWithChangeSupport.removeFromParent()