org.sbml.jsbml

Class Event

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.AbstractNamedSBaseWithUnit

org.sbml.jsbml.Event

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, NamedSBase, NamedSBaseWithDerivedUnit, SBase, SBaseWithDerivedUnit, SBaseWithUnit, UniqueNamedSBase, TreeNodeWithChangeSupport

public class Event
extends AbstractNamedSBaseWithUnit
implements UniqueNamedSBase

Represents the event XML element of a SBML file. Since Events were introduced to SBML in Level 2, this class must not be used for models in Level 1.

Since:

0.8

Version:

$Rev: 1968 $

Author:

Andreas Dräger, Marine Dumousseau

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Delay	delay Represents the delay sub-element of an event element.
private boolean	isSetUseValuesFromTriggerTime
private ListOf<EventAssignment>	listOfEventAssignments Represents the listOfEventAssignments sub-element of an event element.
private Priority	priority Represents the priority sub-element of an event.
private static long	serialVersionUID Generated serial version identifier.
private Trigger	trigger Represents the trigger sub-element of an event element.
private java.lang.Boolean	useValuesFromTriggerTime Represents the 'useValuesFromTriggerTime' XML attribute of an event element.

Fields inherited from class org.sbml.jsbml.AbstractNamedSBaseWithUnit

unitsID

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, lv

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
Event() Creates an Event instance.
Event(Event event) Creates an Event instance from a given event.
Event(int level, int version) Creates an Event from a level and version.
Event(java.lang.String id)
Event(java.lang.String id, int level, int version) Creates an Event instance from an id, level and version.
Event(java.lang.String id, java.lang.String name, int level, int version) Creates an Event instance from an id, name, level and version.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEventAssignment(EventAssignment eventass) Adds a new EventAssignment to the listOfEventAssignments.
void	clearListOfEventAssignments() Remove all the EventAssignments of the listOfEventAssignments of this Event.
Event	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	containsUndeclaredUnits() Deprecated.
Delay	createDelay() Creates a new Delay instance and sets it to this Event.
Delay	createDelay(ASTNode math) Creates a new Delay instance and sets it to this Event.
EventAssignment	createEventAssignment() Creates a new EventAssignment element and adds it to the ListOfEventAssignments list.
EventAssignment	createEventAssignment(java.lang.String variable, ASTNode math) Creates a new EventAssignment element and adds it to the ListOfEventAssignments list.
EventAssignment	createEventAssignment(Variable variable, ASTNode math) Creates a new EventAssignment element and adds it to the ListOfEventAssignments list.
Priority	createPriority() Creates a new, empty Priority, sets it to this Event and returns the Priority.
Priority	createPriority(ASTNode math) Creates a new Priority, sets it to this Event and returns it.
Trigger	createTrigger() Creates a new Trigger instance and sets it to this Event.
Trigger	createTrigger(boolean initialValue, boolean persistent) Creates a new Trigger instance and sets it to this Event.
Trigger	createTrigger(boolean initialValue, boolean persistent, ASTNode math) Creates a new Trigger instance and sets it to this Event.
boolean	equals(java.lang.Object object) 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()
Delay	getDelay()
UnitDefinition	getDerivedUnitDefinition() Deprecated.
java.lang.String	getDerivedUnits() Deprecated.
EventAssignment	getEventAssignment(int n) Gets an element from the listOfEventAssignments at the given index.
EventAssignment	getEventAssignment(java.lang.String eventAssignmentId) Gets an element from the listOfEventAssignments, with the given id.
int	getEventAssignmentCount() Returns the number of EventAssignments in this Event.
ListOf<EventAssignment>	getListOfEventAssignments() Returns the listOfEventAssignments.
int	getNumEventAssignments() Returns the number of EventAssignments in this Event.
ListOf<Event>	getParent() This is equivalent to calling AbstractSBase.getParentSBMLObject(), but this method is needed for TreeNode.
java.lang.String	getPredefinedUnitID() Returns the predefined unit identifier for this data type with the current level/version combination.
Priority	getPriority()
java.lang.String	getTimeUnits() Deprecated.
java.lang.String	getTimeUnitsID() Deprecated.
UnitDefinition	getTimeUnitsInstance() Deprecated.
Trigger	getTrigger()
java.lang.String	getUnits() Deprecated.
UnitDefinition	getUnitsInstance() Deprecated.
boolean	getUseValuesFromTriggerTime()
int	hashCode() Returns a hash code value for this SBase instance.
void	initDefaults() Initializes the default values using the current Level/Version configuration.
void	initDefaults(int level, int version) Initializes the default values of this Event.
boolean	isIdMandatory() This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.
boolean	isSetDelay()
boolean	isSetListOfEventAssignments() Returns true, if listOfEventAssignments contains at least one element.
boolean	isSetPriority()
boolean	isSetTimeUnits() Deprecated.
boolean	isSetTimeUnitsInstance() Deprecated.
boolean	isSetTrigger()
boolean	isSetUnits() Deprecated.
boolean	isSetUnitsInstance() Deprecated.
boolean	isSetUseValuesFromTriggerTime()
boolean	isUseValuesFromTriggerTime()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
boolean	removeEventAssignment(EventAssignment eventAssignment) Removes an element from the listOfEventAssignments.
EventAssignment	removeEventAssignment(int i) Removes an element from the listOfEventAssignments at the given index.
EventAssignment	removeEventAssignment(java.lang.String id) Removes an element from the listOfEventAssignments.
void	setDelay(Delay delay) Sets the delay of this Event to 'delay'.
void	setListOfEventAssignments(ListOf<EventAssignment> listOfEventAssignments) Sets the given ListOf<EventAssignment>.
void	setPriority(Priority priority)
void	setTimeUnits(java.lang.String timeUnits) Deprecated. This is only applicable for SBML Level 2, Versions 1 and 2.
void	setTimeUnits(UnitDefinition timeUnits) Deprecated.
void	setTimeUnitsID(java.lang.String timeUnitsID) Deprecated.
void	setTrigger(Trigger trigger) Sets the trigger of this Event to 'trigger'.
void	setUnits(java.lang.String timeUnits) Deprecated.
void	setUnits(Unit.Kind timeUnitKind) Deprecated.
void	setUnits(Unit timeUnit) Deprecated.
void	setUnits(UnitDefinition timeUnits) Deprecated.
void	setUseValuesFromTriggerTime(boolean useValuesFromTriggerTime) Sets the useValuesFromTriggerTime of this Event to 'useValuesFromTriggerTime'.
boolean	unsetDelay() Sets the delay of this Event to null.
boolean	unsetListOfEventAssignments() Removes the listOfEventAssignments from this Event and notifies all registered instances of TreeNodeChangeListener.
boolean	unsetPriority() Sets the Priority of this Event to null and notifies TreeNodeChangeListeners.
void	unsetTimeUnits() Sets the timeUnitsID of this Event to null.
boolean	unsetTrigger() Sets the trigger of this Event to null and notifies TreeNodeChangeListeners.
void	unsetUseValuesFromTriggerTime() Sets the useValuesFromTriggerTime of this Event to null.
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.AbstractNamedSBaseWithUnit

isPredefinedUnitsID, unsetUnits

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

checkIdentifier, getId, getName, isSetId, isSetName, isValidId, setId, setName, toString, unsetId, unsetName

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, 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, setLevelAndVersion, 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.NamedSBase

getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName

Methods inherited from interface org.sbml.jsbml.SBase

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

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

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, 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

delay

private Delay delay

Represents the delay sub-element of an event element.

isSetUseValuesFromTriggerTime

private boolean isSetUseValuesFromTriggerTime

listOfEventAssignments

private ListOf<EventAssignment> listOfEventAssignments

Represents the listOfEventAssignments sub-element of an event element.

priority

private Priority priority

Represents the priority sub-element of an event.

trigger

private Trigger trigger

Represents the trigger sub-element of an event element.

useValuesFromTriggerTime

private java.lang.Boolean useValuesFromTriggerTime

Represents the 'useValuesFromTriggerTime' XML attribute of an event element.

Constructor Detail

Event

public Event()

Creates an Event instance. By default, if the level is set and is superior or equal to 3, the trigger, delay, listOfEventAssignemnts and timeUnitsID are null.

Event

public Event(Event event)

Creates an Event instance from a given event.

Parameters:

event -

Event

public Event(int level,
     int version)

Creates an Event from a level and version. By default, if the level is set and is superior or equal to 3, the trigger, delay, listOfEventAssignments and timeUnitsID are null.

Parameters:

level -

version -

Event

public Event(java.lang.String id)

Parameters:

id -

Event

public Event(java.lang.String id,
     int level,
     int version)

Creates an Event instance from an id, level and version. By default, if the level is set and is superior or equal to 3, the trigger, delay, listOfEventAssignemnts and timeUnitsID are null.

Parameters:

id -

level -

version -

Event

public Event(java.lang.String id,
     java.lang.String name,
     int level,
     int version)

Creates an Event instance from an id, name, level and version. By default, if the level is set and is superior or equal to 3, the trigger, delay, listOfEventAssignemnts and timeUnitsID are null.

Parameters:

id -

name -

level -

version -

Method Detail

addEventAssignment

public boolean addEventAssignment(EventAssignment eventass)

Adds a new EventAssignment to the listOfEventAssignments.

The listOfEventAssignments is initialized if necessary.

Parameters:

eventass - the element to add to the list

Returns:

true if the listOfEventAssignments was changed as a result of this call.

clearListOfEventAssignments

public void clearListOfEventAssignments()

Remove all the EventAssignments of the listOfEventAssignments of this Event.

clone

public Event 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 AbstractNamedSBaseWithUnit

Returns:

a copy of this object

containsUndeclaredUnits

@Deprecated
public boolean containsUndeclaredUnits()

Deprecated.

Description copied from interface: SBaseWithDerivedUnit

Returns true or false depending on whether this SBaseWithDerivedUnit refers to elements such as parameters or numbers with undeclared units. A return value of true indicates that the UnitDefinition returned by SBaseWithDerivedUnit.getDerivedUnitDefinition() may not accurately represent the units of the expression.

Specified by:

containsUndeclaredUnits in interface SBaseWithDerivedUnit

Overrides:

containsUndeclaredUnits in class AbstractNamedSBaseWithUnit

Returns:

true if the math expression of this SBaseWithDerivedUnit includes parameters/numbers with undeclared units, false otherwise.

createDelay

public Delay createDelay()

Creates a new Delay instance and sets it to this Event.

Returns:

the new Delay instance.

createDelay

public Delay createDelay(ASTNode math)

Creates a new Delay instance and sets it to this Event.

Parameters:

math - the math expression for the new Delay

Returns:

the new Delay instance.

createEventAssignment

public EventAssignment createEventAssignment()

Creates a new EventAssignment element and adds it to the ListOfEventAssignments list.

Returns:

the new EventAssignment instance.

createEventAssignment

public EventAssignment createEventAssignment(java.lang.String variable,
                                    ASTNode math)

Creates a new EventAssignment element and adds it to the ListOfEventAssignments list.

Parameters:

variable - the target of the new EventAssignment

math - the math expression for the new EventAssignment

Returns:

the new EventAssignment instance.

createEventAssignment

public EventAssignment createEventAssignment(Variable variable,
                                    ASTNode math)

Creates a new EventAssignment element and adds it to the ListOfEventAssignments list.

Parameters:

variable - the target of the new EventAssignment

math - the math expression for the new EventAssignment

Returns:

the new EventAssignment instance.

createPriority

public Priority createPriority()

Creates a new, empty Priority, sets it to this Event and returns the Priority.

Returns:

the newly created Priority object instance

createPriority

public Priority createPriority(ASTNode math)

Creates a new Priority, sets it to this Event and returns it.

Parameters:

math - the ASTNode representing the expression to be set to the Priority

Returns:

the newly created Priority object instance

createTrigger

public Trigger createTrigger()

Creates a new Trigger instance and sets it to this Event.

Returns:

the new Trigger instance.

createTrigger

public Trigger createTrigger(boolean initialValue,
                    boolean persistent)

Creates a new Trigger instance and sets it to this Event.

Parameters:

initialValue -

persistent -

Returns:

the new Trigger instance.

createTrigger

public Trigger createTrigger(boolean initialValue,
                    boolean persistent,
                    ASTNode math)

Creates a new Trigger instance and sets it to this Event.

Parameters:

initialValue -

persistent -

math - the math expression for the new Trigger

Returns:

the new Trigger instance.

equals

public boolean equals(java.lang.Object object)

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 AbstractNamedSBaseWithUnit

Parameters:

object - 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.

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren 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

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSBase

getDelay

public Delay getDelay()

Returns:

the Delay instance of this Event.

getDerivedUnitDefinition

@Deprecated
public UnitDefinition getDerivedUnitDefinition()

Deprecated.

Description copied from interface: SBaseWithDerivedUnit

Derives the unit of this quantity and tries to identify an equivalent UnitDefinition within the corresponding Model. If no equivalent unit definition can be found, a new unit definition will be created that is not part of the model but represents the unit of this quantity. If it is not possible to derive a unit for this quantity, null will be returned.

Specified by:

getDerivedUnitDefinition in interface SBaseWithDerivedUnit

Overrides:

getDerivedUnitDefinition in class AbstractNamedSBaseWithUnit

Returns:

a UnitDefinition that represent the derived unit of this quantity, or null if it is not possible to derive a unit.

getDerivedUnits

@Deprecated
public java.lang.String getDerivedUnits()

Deprecated.

Description copied from interface: SBaseWithDerivedUnit

Derives the unit of this quantity. If the model that contains this quantity already contains a unit that is equivalent to the derived unit, the corresponding identifier will be returned. In case that the unit cannot be derived or that no equivalent unit exists within the model, or if the model has not been defined yet, null will be returned. In case that this quantity represents a basic Unit.Kind this method will return the String representation of this Unit.Kind.

Specified by:

getDerivedUnits in interface SBaseWithDerivedUnit

Overrides:

getDerivedUnits in class AbstractNamedSBaseWithUnit

Returns:

a String that represent the id of a UnitDefinition. This UnitDefinition represent the derived unit of this quantity. If it is not possible to derive a unit for this quantity or if no equivalent UnitDefinition can be found in the Model, null is returned.

getEventAssignment

public EventAssignment getEventAssignment(int n)

Gets an element from the listOfEventAssignments at the given index.

Parameters:

n - the index of the EventAssignment element to get.

Returns:

an element from the listOfEventAssignments at the given index.

Throws:

java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size).

getEventAssignment

public EventAssignment getEventAssignment(java.lang.String eventAssignmentId)

Gets an element from the listOfEventAssignments, with the given id.

Parameters:

eventAssignmentId - the id of the EventAssignment element to get.

Returns:

an element from the listOfEventAssignments with the given id or null.

getListOfEventAssignments

public ListOf<EventAssignment> getListOfEventAssignments()

Returns the listOfEventAssignments. Creates it if it is not already existing. s * @return the list of eventAssignments of this Event.

getNumEventAssignments

public int getNumEventAssignments()

Returns the number of EventAssignments in this Event.

Returns:

the number of EventAssignments in this Event.

getEventAssignmentCount

public int getEventAssignmentCount()

Returns the number of EventAssignments in this Event.

Returns:

the number of EventAssignments in this Event.

getParent

public ListOf<Event> getParent()

Description copied from class: AbstractSBase

This is equivalent to calling AbstractSBase.getParentSBMLObject(), but this method is needed for TreeNode.

Specified by:

getParent in interface javax.swing.tree.TreeNode

Overrides:

getParent in class AbstractSBase

Returns:

the parent element of this element.

See Also:

AbstractSBase.getParentSBMLObject()

getPredefinedUnitID

public java.lang.String getPredefinedUnitID()

Description copied from class: AbstractNamedSBaseWithUnit

Returns the predefined unit identifier for this data type with the current level/version combination.

Specified by:

getPredefinedUnitID in class AbstractNamedSBaseWithUnit

Returns:

an identifier of a unit in the containing Model. This can be one of the predefined unit identifiers if there are any.

getPriority

public Priority getPriority()

Returns:

the priority

getTimeUnits

@Deprecated
public java.lang.String getTimeUnits()

Deprecated.

Returns:

The timeUnitsID of this Event. Return an empty String if it is not set.

getTimeUnitsID

@Deprecated
public java.lang.String getTimeUnitsID()

Deprecated.

Returns:

the timeUnitsID

getTimeUnitsInstance

@Deprecated
public UnitDefinition getTimeUnitsInstance()

Deprecated.

Returns the UnitDefinition instance of the model which matches the timesUnitsID of this Event.

Returns:

the UnitDefinition instance of the model which matches the timesUnitsID of this Event. Returns null if there is no UnitDefinition id which matches the value of the timeUnits attribute of this Event.

getTrigger

public Trigger getTrigger()

Returns:

the Trigger instance of this Event.

getUnits

@Deprecated
public java.lang.String getUnits()

Deprecated.

Specified by:

getUnits in interface SBaseWithUnit

Overrides:

getUnits in class AbstractNamedSBaseWithUnit

Returns:

the unitsID of this SBaseWithUnit. The empty String if it is not set.

getUnitsInstance

@Deprecated
public UnitDefinition getUnitsInstance()

Deprecated.

Specified by:

getUnitsInstance in interface SBaseWithUnit

Overrides:

getUnitsInstance in class AbstractNamedSBaseWithUnit

Returns:

The UnitDefinition instance which has the unitsID of this SBaseWithUnit as id. Null if it doesn't exist. In case that the unit of this SBaseWithUnit represents a base Unit, a new UnitDefinition will be created and returned by this method. This new UnitDefinition will only contain the one unit represented by the unit identifier in this SBaseWithUnit. Note that the corresponding model will not contain this UnitDefinition. The identifier of this new UnitDefinition will be set to the same value as the name of the base Unit.

getUseValuesFromTriggerTime

public boolean getUseValuesFromTriggerTime()

Returns:

the useValuesFromTriggerTime instance of this Event. it is null if it has not been set.

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 AbstractNamedSBaseWithUnit

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

initDefaults

public void initDefaults()

Initializes the default values using the current Level/Version configuration.

initDefaults

public void initDefaults(int level,
                int version)

Initializes the default values of this Event.

isIdMandatory

public boolean isIdMandatory()

Description copied from interface: NamedSBase

This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.

Specified by:

isIdMandatory in interface NamedSBase

Returns:

true if the identifier of this element must be set in order to create a valid SBML representation. false otherwise, i.e., if the identifier can be understood as an optional attribute.

isSetDelay

public boolean isSetDelay()

Returns:

true if the delay of this Event is not null.

isSetListOfEventAssignments

public boolean isSetListOfEventAssignments()

Returns true, if listOfEventAssignments contains at least one element.

Returns:

true if the listOfEventAssignments of this Event is not null and not empty;

isSetPriority

public boolean isSetPriority()

Returns:

isSetTimeUnits

@Deprecated
public boolean isSetTimeUnits()

Deprecated.

Returns:

true if the timeUnitsID of this Event is not null.

isSetTimeUnitsInstance

@Deprecated
public boolean isSetTimeUnitsInstance()

Deprecated.

Returns:

true if the UnitDefinition which has the timeUnitsID of this Event as id is not null.

isSetTrigger

public boolean isSetTrigger()

Returns:

true if the trigger of this Event is not null.

isSetUnits

@Deprecated
public boolean isSetUnits()

Deprecated.

Specified by:

isSetUnits in interface SBaseWithUnit

Overrides:

isSetUnits in class AbstractNamedSBaseWithUnit

Returns:

true if the unitsID of this element is not null.

isSetUnitsInstance

@Deprecated
public boolean isSetUnitsInstance()

Deprecated.

Description copied from interface: SBaseWithUnit

Checks whether the element referenced by the unitsID attribute of this SBaseWithUnit is either an existing base Unit, i.e., a simple Unit that can directly be addressed via its Unit.Kind element, or the identifier of an existing UnitDefinition in the Model to which this SBaseWithUnit belongs.

Specified by:

isSetUnitsInstance in interface SBaseWithUnit

Overrides:

isSetUnitsInstance in class AbstractNamedSBaseWithUnit

Returns:

true if either a UnitDefinition, which has the unitsID of this SBaseWithUnit, can be found in the Model to which this SBaseWithUnit belongs, or if this element's unitsID as a corresponding base Unit for the given Level/Version combination.

isSetUseValuesFromTriggerTime

public boolean isSetUseValuesFromTriggerTime()

Returns:

true is the useValuesFromTriggerTime of this Event is not null.

isUseValuesFromTriggerTime

public boolean isUseValuesFromTriggerTime()

Returns:

the boolean value of the useValuesFromTriggerTime of this Event if it has been set, false otherwise.

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 AbstractNamedSBase

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.

removeEventAssignment

public EventAssignment removeEventAssignment(int i)

Removes an element from the listOfEventAssignments at the given index.

Parameters:

i - the index where to remove the EventAssignment.

Returns:

the specified element, if it was successfully found and removed.

Throws:

java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size).

removeEventAssignment

public EventAssignment removeEventAssignment(java.lang.String id)

Removes an element from the listOfEventAssignments.

Parameters:

id - the id of the element to be removed from the list.

Returns:

the removed element, if it was successfully found and removed or null.

removeEventAssignment

public boolean removeEventAssignment(EventAssignment eventAssignment)

Removes an element from the listOfEventAssignments.

Parameters:

eventAssignment - the element to be removed from the list.

Returns:

true if the list contained the specified element and it was removed.

See Also:

List.remove(Object)

setDelay

public void setDelay(Delay delay)

Sets the delay of this Event to 'delay'. It automatically sets the Delay parentSBML object to this Event instance.

Parameters:

delay -

setListOfEventAssignments

public void setListOfEventAssignments(ListOf<EventAssignment> listOfEventAssignments)

Sets the given ListOf<EventAssignment>. If listOfEventAssignments was defined before and contains some elements, they are all unset.

Parameters:

listOfEventAssignments -

setPriority

public void setPriority(Priority priority)

Parameters:

priority - the priority to set

Throws:

PropertyNotAvailableException - if Level < 3.

setTimeUnits

@Deprecated
public void setTimeUnits(java.lang.String timeUnits)

Deprecated. This is only applicable for SBML Level 2, Versions 1 and 2.

Sets the timeUnitsID of this Event to 'timeUnits'.

Parameters:

timeUnits -

setTimeUnits

@Deprecated
public void setTimeUnits(UnitDefinition timeUnits)

Deprecated.

Sets the timeUnitsID of this Event to the id of the UnitDefinition 'timeUnits'.

Parameters:

timeUnits -

setTimeUnitsID

@Deprecated
public void setTimeUnitsID(java.lang.String timeUnitsID)

Deprecated.

Parameters:

timeUnitsID - the timeUnitsID to set

setTrigger

public void setTrigger(Trigger trigger)

Sets the trigger of this Event to 'trigger'. It automatically sets the Trigger parentSBML object to this Event instance.

Parameters:

trigger -

setUnits

@Deprecated
public void setUnits(Unit.Kind timeUnitKind)

Deprecated.

Description copied from interface: SBaseWithUnit

Sets the unit of this SBaseWithUnit. A new unit will be created base on this kind.

Specified by:

setUnits in interface SBaseWithUnit

Overrides:

setUnits in class AbstractNamedSBaseWithUnit

setUnits

@Deprecated
public void setUnits(java.lang.String timeUnits)

Deprecated.

Description copied from interface: SBaseWithUnit

Sets the unitsID of this SBaseWithUnit. Only valid unit kind names or identifiers of already existing UnitDefinitions are allowed arguments of this function.

Specified by:

setUnits in interface SBaseWithUnit

Overrides:

setUnits in class AbstractNamedSBaseWithUnit

Parameters:

timeUnits - the identifier of an already existing UnitDefinition or an Unit.Kind identifier for the current level/version combination of this unit. Passing a null value to this method is equivalent to calling SBaseWithUnit.unsetUnits().

setUnits

@Deprecated
public void setUnits(Unit timeUnit)

Deprecated.

Description copied from interface: SBaseWithUnit

Sets the Unit of this SBaseWithUnit.

Specified by:

setUnits in interface SBaseWithUnit

Overrides:

setUnits in class AbstractNamedSBaseWithUnit

setUnits

@Deprecated
public void setUnits(UnitDefinition timeUnits)

Deprecated.

Description copied from interface: SBaseWithUnit

Set the unit attribute of this SBaseWithUnit to the given unit definition.

Specified by:

setUnits in interface SBaseWithUnit

Overrides:

setUnits in class AbstractNamedSBaseWithUnit

setUseValuesFromTriggerTime

public void setUseValuesFromTriggerTime(boolean useValuesFromTriggerTime)

Sets the useValuesFromTriggerTime of this Event to 'useValuesFromTriggerTime'.

Parameters:

useValuesFromTriggerTime -

Throws:

PropertyNotAvailableException - if the Level/Version combination is lower than 2.4.

unsetDelay

public boolean unsetDelay()

Sets the delay of this Event to null.

unsetListOfEventAssignments

public boolean unsetListOfEventAssignments()

Removes the listOfEventAssignments from this Event and notifies all registered instances of TreeNodeChangeListener.

Returns:

true if calling this method lead to a change in this data structure.

unsetPriority

public boolean unsetPriority()

Sets the Priority of this Event to null and notifies TreeNodeChangeListeners.

unsetTimeUnits

public void unsetTimeUnits()

Sets the timeUnitsID of this Event to null.

unsetTrigger

public boolean unsetTrigger()

Sets the trigger of this Event to null and notifies TreeNodeChangeListeners.

unsetUseValuesFromTriggerTime

public void unsetUseValuesFromTriggerTime()

Sets the useValuesFromTriggerTime of this Event to null.

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 AbstractNamedSBase

Returns:

a Map containing the XML attributes of this object.