org.sbml.jsbml.ext.multi

Class SubListOfSpeciesFeature

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ListOf<SpeciesFeature>

org.sbml.jsbml.ext.multi.SubListOfSpeciesFeature

All Implemented Interfaces:

Serializable, Cloneable, Iterable<SpeciesFeature>, Collection<SpeciesFeature>, List<SpeciesFeature>, TreeNode, ListOfSpeciesFeatureContent, NamedSBase, SBase, UniqueNamedSBase, UniqueSId, TreeNodeWithChangeSupport

public class SubListOfSpeciesFeature
extends ListOf<SpeciesFeature>
implements UniqueNamedSBase, ListOfSpeciesFeatureContent

Allows to regroup a set of SpeciesFeature that have a specific Relation between them.

This class derives from ListOf.

Author:

rodrigue

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sbml.jsbml.ListOf

ListOf.Type

Field Summary

Fields inherited from class org.sbml.jsbml.ListOf

listOf, listType, otherListName

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
SubListOfSpeciesFeature() Creates an SubListOfSpeciesFeature instance
SubListOfSpeciesFeature(int level, int version) Creates a SubListOfSpeciesFeature instance with a level and version.
SubListOfSpeciesFeature(String id) Creates a SubListOfSpeciesFeature instance with an id.
SubListOfSpeciesFeature(String id, int level, int version) Creates a SubListOfSpeciesFeature instance with an id, level, and version.
SubListOfSpeciesFeature(SubListOfSpeciesFeature obj) Clone constructor

Method Summary

Modifier and Type	Method and Description
SubListOfSpeciesFeature	clone() clones this class
boolean	equals(Object obj)
String	getComponent() Returns the value of component.
Relation	getRelation() Returns the value of relation.
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetComponent() Returns whether component is set.
boolean	isSetRelation() Returns whether relation is set.
boolean	readAttribute(String attributeName, String prefix, String value)
void	setComponent(String component) Sets the value of component
void	setRelation(Relation relation) Sets the value of relation
boolean	unsetComponent() Unsets the variable component.
boolean	unsetRelation() Unsets the variable relation.
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.ListOf

add, add, addAll, addAll, append, clear, contains, containsAll, filterList, firstHit, get, get, getAllowsChildren, getChildAt, getChildCount, getElementName, getFirst, getLast, getOtherListName, getSBaseListType, indexOf, initListOf, isDebugMode, isEmpty, iterator, lastIndexOf, listIterator, listIterator, newInstance, remove, remove, remove, remove, removeAll, removeAll, removeFirst, retainAll, set, setDebugMode, setListOf, setOtherListName, setPackageName, setSBaseListType, setSBaseListType, size, subList, toArray, toArray, unsetSBaseListType

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, 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, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, 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, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, 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, isIdMandatory, isSetId, isSetName, setId, setName, unsetId, unsetName

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, 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, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

SubListOfSpeciesFeature

public SubListOfSpeciesFeature()

Creates an SubListOfSpeciesFeature instance

SubListOfSpeciesFeature

public SubListOfSpeciesFeature(String id)

Creates a SubListOfSpeciesFeature instance with an id.

Parameters:

id - the identifier for the new element.

SubListOfSpeciesFeature

public SubListOfSpeciesFeature(int level,
                               int version)

Creates a SubListOfSpeciesFeature instance with a level and version.

Parameters:

level - SBML Level

version - SBML Version

SubListOfSpeciesFeature

public SubListOfSpeciesFeature(String id,
                               int level,
                               int version)

Creates a SubListOfSpeciesFeature instance with an id, level, and version.

Parameters:

id - the identifier for this element.

level - the SBML Level

version - the SBML Version

SubListOfSpeciesFeature

public SubListOfSpeciesFeature(SubListOfSpeciesFeature obj)

Clone constructor

Method Detail

clone

public SubListOfSpeciesFeature clone()

clones this class

Specified by:

clone in interface SBase

Overrides:

clone in class ListOf<SpeciesFeature>

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

getRelation

public Relation getRelation()

Returns the value of relation.

Returns:

the value of relation.

isSetRelation

public boolean isSetRelation()

Returns whether relation is set.

Returns:

whether relation is set.

setRelation

public void setRelation(Relation relation)

Sets the value of relation

Parameters:

relation - the value of relation to be set.

unsetRelation

public boolean unsetRelation()

Unsets the variable relation.

Returns:

true if relation was set before, otherwise false.

getComponent

public String getComponent()

Returns the value of component.

Returns:

the value of component.

isSetComponent

public boolean isSetComponent()

Returns whether component is set.

Returns:

whether component is set.

setComponent

public void setComponent(String component)

Sets the value of component

Parameters:

component - the value of component to be set.

unsetComponent

public boolean unsetComponent()

Unsets the variable component.

Returns:

true if component was set before, otherwise false.

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<SpeciesFeature>

Specified by:

hashCode in interface List<SpeciesFeature>

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<SpeciesFeature>

Specified by:

equals in interface List<SpeciesFeature>

Specified by:

equals in interface SBase

Overrides:

equals in class ListOf<SpeciesFeature>

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase