org.sbml.jsbml.ext.distrib

Class DrawFromDistribution

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.distrib.DrawFromDistribution

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SBase, IdManager, TreeNodeWithChangeSupport

public class DrawFromDistribution
extends AbstractSBase
implements IdManager

Since:

1.1

Version:

$Rev$

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Last modified:

26.03.2015

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	accept(SBase sbase)
boolean	addDistribInput(DistribInput DistribInput) Adds a new DistribInput to the listOfDistribInputs.
DrawFromDistribution	clone() clones this class
DistribInput	createDistribInput() Creates a new DistribInput element and adds it to the ListOfDistribInputs list.
DistribInput	createDistribInput(String id) Creates a new DistribInput element and adds it to the ListOfDistribInputs list.
boolean	equals(Object obj)
boolean	getAllowsChildren()
TreeNode	getChildAt(int index)
int	getChildCount()
DistribInput	getDistribInput(int i) Gets an element from the listOfDistribInputs at the given index.
DistribInput	getDistribInput(String distribInputId) Gets an element from the listOfDistribInputs, with the given id.
int	getDistribInputCount() Returns the number of DistribInputs in this DrawFromDistribution.
ListOf<DistribInput>	getListOfDistribInputs() Returns the listOfDistribInputs.
int	getNumDistribInputs() Returns the number of DistribInputs in this DrawFromDistribution.
XMLNode	getUncertML() Returns the value of uncertML
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetListOfDistribInputs() Returns true, if listOfDistribInputs contains at least one element.
boolean	isSetUncertML() Returns whether uncertML is set
boolean	register(SBase sbase)
boolean	removeDistribInput(DistribInput DistribInput) Removes an element from the listOfDistribInputs.
DistribInput	removeDistribInput(int i) Removes an element from the listOfDistribInputs at the given index.
DistribInput	removeDistribInput(String DistribInputId) Removes an element from the listOfDistribInputs.
void	setListOfDistribInputs(ListOf<DistribInput> listOfDistribInputs) Sets the given ListOf<DistribInput>.
void	setUncertML(XMLNode uncertML) Sets the value of uncertML
boolean	unregister(SBase sbase)
boolean	unsetListOfDistribInputs() Returns true, if listOfDistribInputs contain at least one element, otherwise false.
boolean	unsetUncertML() Unsets the variable uncertML

Methods inherited from class org.sbml.jsbml.AbstractSBase

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

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, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, 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

Constructor Detail

DrawFromDistribution

public DrawFromDistribution()

Creates a DrawFromDistribution instance

DrawFromDistribution

public DrawFromDistribution(int level,
                            int version)

Creates a DrawFromDistribution instance with a level and version.

Parameters:

level -

version -

DrawFromDistribution

public DrawFromDistribution(DrawFromDistribution obj)

Clone constructor

Parameters:

obj -

Method Detail

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

equals

public boolean equals(Object obj)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

clone

public DrawFromDistribution clone()

clones this class

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

getUncertML

public XMLNode getUncertML()

Returns the value of uncertML

Returns:

the value of uncertML

isSetUncertML

public boolean isSetUncertML()

Returns whether uncertML is set

Returns:

whether uncertML is set

setUncertML

public void setUncertML(XMLNode uncertML)

Sets the value of uncertML

Parameters:

uncertML -

unsetUncertML

public boolean unsetUncertML()

Unsets the variable uncertML

Returns:

true, if uncertML was set before, otherwise false

isSetListOfDistribInputs

public boolean isSetListOfDistribInputs()

Returns true, if listOfDistribInputs contains at least one element.

Returns:

true, if listOfDistribInputs contains at least one element, otherwise false.

getListOfDistribInputs

public ListOf<DistribInput> getListOfDistribInputs()

Returns the listOfDistribInputs. Creates it if it is not already existing.

Returns:

the listOfDistribInputs.

setListOfDistribInputs

public void setListOfDistribInputs(ListOf<DistribInput> listOfDistribInputs)

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

Parameters:

listOfDistribInputs -

unsetListOfDistribInputs

public boolean unsetListOfDistribInputs()

Returns true, if listOfDistribInputs contain at least one element, otherwise false.

Returns:

true, if listOfDistribInputs contain at least one element, otherwise false.

addDistribInput

public boolean addDistribInput(DistribInput DistribInput)

Adds a new DistribInput to the listOfDistribInputs.

The listOfDistribInputs is initialized if necessary.

Parameters:

DistribInput - the element to add to the list

Returns:

true (as specified by Collection#add(Object))

removeDistribInput

public boolean removeDistribInput(DistribInput DistribInput)

Removes an element from the listOfDistribInputs.

Parameters:

DistribInput - 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)

removeDistribInput

public DistribInput removeDistribInput(String DistribInputId)

Removes an element from the listOfDistribInputs.

Parameters:

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

Returns:

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

removeDistribInput

public DistribInput removeDistribInput(int i)

Removes an element from the listOfDistribInputs at the given index.

Parameters:

i - the index where to remove the DistribInput.

Returns:

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

Throws:

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

createDistribInput

public DistribInput createDistribInput()

Creates a new DistribInput element and adds it to the ListOfDistribInputs list.

Returns:

createDistribInput

public DistribInput createDistribInput(String id)

Creates a new DistribInput element and adds it to the ListOfDistribInputs list.

Parameters:

id - the id to be set on the new DistribInput element.

Returns:

a new DistribInput element.

getDistribInput

public DistribInput getDistribInput(int i)

Gets an element from the listOfDistribInputs at the given index.

Parameters:

i - the index of the DistribInput element to get.

Returns:

an element from the listOfDistribInputs at the given index.

Throws:

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

getDistribInput

public DistribInput getDistribInput(String distribInputId)

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

Parameters:

distribInputId - the id of the DistribInput element to get.

Returns:

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

getDistribInputCount

public int getDistribInputCount()

Returns the number of DistribInputs in this DrawFromDistribution.

Returns:

the number of DistribInputs in this DrawFromDistribution.

getNumDistribInputs

public int getNumDistribInputs()

Returns the number of DistribInputs in this DrawFromDistribution.

Returns:

the number of DistribInputs in this DrawFromDistribution.

Note: this method is kept here as it exist in libSBML.

same as getDistribInputCount()

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSBase

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSBase

accept

public boolean accept(SBase sbase)

Specified by:

accept in interface IdManager

register

public boolean register(SBase sbase)

Specified by:

register in interface IdManager

unregister

public boolean unregister(SBase sbase)

Specified by:

unregister in interface IdManager