org.sbml.jsbml.util.IdManagerpublic class ArraysSBasePlugin
extends org.sbml.jsbml.ext.AbstractSBasePlugin
implements org.sbml.jsbml.util.IdManager
ArraysSBasePlugin class extends the SBase class by adding
an optional ListOfDimensions child and a single optional
Index child.
The ArraysSBasePlugin class codifies the extensions to the
SBase class defined in the 'Arrays' package. These extensions allows
the modeler to define one or more Dimension elements to indicate the
parent SBase object is arrayed. In addition, these extensions allows
the definition of one or more Index elements to reference the parent
SBase that has one or more array dimensions.
Dimension,
Index,
Serialized Form| Constructor | Description |
|---|---|
ArraysSBasePlugin() |
Creates an new
ArraysSBasePlugin instance. |
ArraysSBasePlugin(ArraysSBasePlugin obj) |
Clone constructor
|
ArraysSBasePlugin(org.sbml.jsbml.SBase extendedSBase) |
Creates an new
ArraysSBasePlugin instance. |
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
accept(org.sbml.jsbml.SBase sbase) |
|
boolean |
addDimension(Dimension field) |
Adds a new
Dimension to the listOfDimensions. |
boolean |
addIndex(Index field) |
Adds a new
Index to the listOfIndices. |
ArraysSBasePlugin |
clone() |
|
Dimension |
createDimension() |
Creates a new Dimension element and adds it to the ListOfDimensions list.
|
Dimension |
createDimension(java.lang.String id) |
Creates a new
Dimension element and adds it to the ListOfDimensions list. |
Index |
createIndex() |
Creates a new Index element and adds it to the listOfIndices list.
|
boolean |
equals(java.lang.Object obj) |
|
boolean |
getAllowsChildren() |
|
javax.swing.tree.TreeNode |
getChildAt(int childIndex) |
|
int |
getChildCount() |
|
Dimension |
getDimension(int i) |
Gets an element from the listOfDimensions at the given index.
|
Dimension |
getDimension(java.lang.String fieldId) |
Gets an element from the listOfDimensions, with the given id.
|
Dimension |
getDimensionByArrayDimension(int i) |
Gets an element from the listOfDimensions at the given arrayDimension.
|
int |
getDimensionCount() |
Returns the number of
Dimensions in this ArraysSBasePlugin. |
java.lang.String |
getElementNamespace() |
|
Index |
getIndex(int i) |
Gets an element from the listOfIndices at the given index.
|
Index |
getIndex(int dim,
java.lang.String attribute) |
Gets an element from the listOfIndices based on array dimension
and referenced attribute.
|
int |
getIndexCount() |
Returns the number of
Indexs in this ArraysSBasePlugin. |
org.sbml.jsbml.ListOf<Dimension> |
getListOfDimensions() |
Returns the listOfDimensions.
|
org.sbml.jsbml.ListOf<Index> |
getListOfIndices() |
Returns the listOfIndices.
|
int |
getNumDimensions() |
Returns the number of
Dimensions in this ArraysSBasePlugin. |
int |
getNumIndices() |
Returns the number of
Indexs in this ArraysSBasePlugin. |
java.lang.String |
getPackageName() |
|
java.lang.String |
getPrefix() |
|
java.lang.String |
getURI() |
|
int |
hashCode() |
|
void |
initDefaults() |
Initializes the default values using the namespace.
|
boolean |
isSetListOfDimensions() |
Returns
true, if listOfDimensions contains at least one element. |
boolean |
isSetListOfIndices() |
Returns
true, if listOfIndices contains at least one element. |
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value) |
|
boolean |
register(org.sbml.jsbml.SBase sbase) |
|
Dimension |
removeDimension(int i) |
Removes an element from the listOfDimensions at the given index.
|
Dimension |
removeDimension(java.lang.String fieldId) |
Removes an element from the listOfDimensions.
|
boolean |
removeDimension(Dimension field) |
Removes an element from the listOfDimensions.
|
Dimension |
removeDimensionByArrayDimension(int arrayDim) |
Removes an element from the listOfDimensions by array dimension.
|
Index |
removeIndex(int i) |
Removes an element from the listOfIndices at the given index.
|
boolean |
removeIndex(Index field) |
Removes an element from the listOfIndices.
|
boolean |
removeIndexByArrayDimension(int arrayDim) |
Removes an element from the listOfIndices based on array dimension.
|
void |
setListOfDimensions(org.sbml.jsbml.ListOf<Dimension> listOfDimensions) |
Sets the given
ListOf<Dimension>. |
void |
setListOfIndices(org.sbml.jsbml.ListOf<Index> listOfIndices) |
Sets the given
ListOf<Index>. |
boolean |
unregister(org.sbml.jsbml.SBase sbase) |
|
boolean |
unsetListOfDimensions() |
Returns
true, if listOfDimensions contain at least one element,
otherwise false. |
boolean |
unsetListOfIndices() |
Returns
true, if listOfIndices contain at least one element,
otherwise false. |
java.util.Map<java.lang.String,java.lang.String> |
writeXMLAttributes() |
fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getExtendedSBase, getLevel, getPackageVersion, getParentSBMLObject, getSBMLDocument, getVersion, isSetExtendedSBase, isSetPackageVersion, removeFromParent, setExtendedSBase, setNamespace, setPackageVersionaddAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getParent, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, userObjectKeySetfinalize, getClass, notify, notifyAll, wait, wait, waitaddAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, userObjectKeySetpublic ArraysSBasePlugin()
ArraysSBasePlugin instance.public ArraysSBasePlugin(org.sbml.jsbml.SBase extendedSBase)
ArraysSBasePlugin instance.extendedSBase - the core SBase that is extendedpublic ArraysSBasePlugin(ArraysSBasePlugin obj)
obj - the instance to clonepublic ArraysSBasePlugin clone()
clone in class org.sbml.jsbml.ext.AbstractSBasePluginpublic void initDefaults()
public boolean isSetListOfIndices()
true, if listOfIndices contains at least one element.true, if listOfIndices contains at least one element,
otherwise false.public org.sbml.jsbml.ListOf<Index> getListOfIndices()
public void setListOfIndices(org.sbml.jsbml.ListOf<Index> listOfIndices)
ListOf<Index>. If listOfIndices
was defined before and contains some elements, they are all unset.listOfIndices - the list of Indexpublic boolean unsetListOfIndices()
true, if listOfIndices contain at least one element,
otherwise false.true, if listOfIndices contain at least one element,
otherwise false.public boolean addIndex(Index field)
Index to the listOfIndices.
The listOfIndices is initialized if necessary.
field - the element to add to the listtrue (as specified by Collection.add(E))public boolean removeIndex(Index field)
field - the element to be removed from the list.true if the list contained the specified element and it was removed.List.remove(Object)public boolean removeIndexByArrayDimension(int arrayDim)
arrayDim - the element with given array dimension to be removed from the list.true if the list contained the specified element with given array
dimension and it was removed.List.remove(Object)public Index removeIndex(int i)
i - the index where to remove the Index.java.lang.IndexOutOfBoundsException - if the listOf is not set or
if the index is out of bound (index < 0 || index > list.size)public Index createIndex()
Index instance.public Index getIndex(int i)
i - the index of the Index element to get.java.lang.IndexOutOfBoundsException - if the listOf is not set or
if the index is out of bound (index < 0 || index > list.size)public Index getIndex(int dim, java.lang.String attribute)
dim - the index of the Index element to get.attribute - the referenced attributepublic int getIndexCount()
Indexs in this ArraysSBasePlugin.Indexs in this ArraysSBasePlugin.public int getNumIndices()
Indexs in this ArraysSBasePlugin.Indexs in this ArraysSBasePlugin.getIndexCount()public boolean isSetListOfDimensions()
true, if listOfDimensions contains at least one element.true, if listOfDimensions contains at least one element,
otherwise false.public org.sbml.jsbml.ListOf<Dimension> getListOfDimensions()
public void setListOfDimensions(org.sbml.jsbml.ListOf<Dimension> listOfDimensions)
ListOf<Dimension>. If listOfDimensions
was defined before and contains some elements, they are all unset.listOfDimensions - the list of Dimensionspublic boolean unsetListOfDimensions()
true, if listOfDimensions contain at least one element,
otherwise false.true, if listOfDimensions contain at least one element,
otherwise false.public boolean addDimension(Dimension field)
Dimension to the listOfDimensions.
The listOfDimensions is initialized if necessary.
field - the element to add to the listtrue (as specified by Collection.add(E))public boolean removeDimension(Dimension field)
field - the element to be removed from the list.true if the list contained the specified element and it was removed.List.remove(Object)public Dimension removeDimension(java.lang.String fieldId)
fieldId - the id of the element to be removed from the list.public Dimension removeDimensionByArrayDimension(int arrayDim)
arrayDim - the array dimension of the element to be removed from the list.public Dimension removeDimension(int i)
i - the index where to remove the Dimension.java.lang.IndexOutOfBoundsException - if the listOf is not set or
if the index is out of bound (index < 0 || index > list.size)public Dimension createDimension()
Dimension element.public Dimension createDimension(java.lang.String id)
Dimension element and adds it to the ListOfDimensions list.id - the idDimension element.public Dimension getDimension(int i)
i - the dimension of the Dimension element to get.java.lang.IndexOutOfBoundsException - if the listOf is not set or
if the index is out of bound (index < 0 || index > 2)public Dimension getDimensionByArrayDimension(int i)
i - the dimension of the Dimension element to get.public Dimension getDimension(java.lang.String fieldId)
fieldId - the id of the Dimension element to get.null.public int getDimensionCount()
Dimensions in this ArraysSBasePlugin.Dimensions in this ArraysSBasePlugin.public int getNumDimensions()
Dimensions in this ArraysSBasePlugin.Dimensions in this ArraysSBasePlugin.getDimensionCount()public java.lang.String getElementNamespace()
getElementNamespace in class org.sbml.jsbml.ext.AbstractSBasePluginpublic java.lang.String getPackageName()
public java.lang.String getPrefix()
public java.lang.String getURI()
public boolean getAllowsChildren()
public javax.swing.tree.TreeNode getChildAt(int childIndex)
public int getChildCount()
public boolean readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value)
public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
writeXMLAttributes in class org.sbml.jsbml.ext.AbstractSBasePluginpublic boolean accept(org.sbml.jsbml.SBase sbase)
accept in interface org.sbml.jsbml.util.IdManagerpublic boolean register(org.sbml.jsbml.SBase sbase)
register in interface org.sbml.jsbml.util.IdManagerpublic boolean unregister(org.sbml.jsbml.SBase sbase)
unregister in interface org.sbml.jsbml.util.IdManagerpublic int hashCode()
hashCode in class org.sbml.jsbml.ext.AbstractSBasePluginpublic boolean equals(java.lang.Object obj)
equals in class org.sbml.jsbml.ext.AbstractSBasePluginCopyright © 2009–2022. All rights reserved.