Package org.biopax.paxtools.impl.level3
Class StoichiometryImpl
java.lang.Object
org.biopax.paxtools.impl.BioPAXElementImpl
org.biopax.paxtools.impl.level3.L3ElementImpl
org.biopax.paxtools.impl.level3.StoichiometryImpl
- All Implemented Interfaces:
Serializable,Cloneable,BioPAXElement,Level3Element,Stoichiometry,UtilityClass
- See Also:
-
Field Summary
Fields inherited from interface org.biopax.paxtools.model.BioPAXElement
UNKNOWN_DOUBLE, UNKNOWN_FLOAT, UNKNOWN_INT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintIf two elements are equivalent, then their equivalence code should be the same.Class<? extends Stoichiometry> This method returns the actual model interface that a class implements.floatStoichiometric coefficient of the physicalEntity specified byStoichiometry.getPhysicalEntity()in the context of the owner interaction or complex.protected booleansemanticallyEquivalent(BioPAXElement element) voidsetPhysicalEntity(PhysicalEntity PhysicalEntity) voidsetStoichiometricCoefficient(float newStoichiometricCoefficient) Sets the stoichiometric coefficient of the physicalEntity specified byStoichiometry.getPhysicalEntity()in the context of the owner interaction or complex.Methods inherited from class org.biopax.paxtools.impl.level3.L3ElementImpl
addComment, getComment, removeComment, setCommentMethods inherited from class org.biopax.paxtools.impl.BioPAXElementImpl
equals, getAnnotations, getUri, hashCode, isEquivalent, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.biopax.paxtools.model.BioPAXElement
getAnnotations, getUri, isEquivalentMethods inherited from interface org.biopax.paxtools.model.level3.Level3Element
addComment, getComment, removeComment
-
Constructor Details
-
StoichiometryImpl
public StoichiometryImpl()
-
-
Method Details
-
getModelInterface
Description copied from interface:BioPAXElementThis method returns the actual model interface that a class implements.- Specified by:
getModelInterfacein interfaceBioPAXElement- Returns:
- an interface from
org.biopax.paxtools.modelpackage corresponding to a BioPAX class.
-
semanticallyEquivalent
- Overrides:
semanticallyEquivalentin classBioPAXElementImpl
-
equivalenceCode
public int equivalenceCode()Description copied from interface:BioPAXElementIf two elements are equivalent, then their equivalence code should be the same.- Specified by:
equivalenceCodein interfaceBioPAXElement- Overrides:
equivalenceCodein classBioPAXElementImpl- Returns:
- an integer that is same across all equivalent entities.
-
getPhysicalEntity
- Specified by:
getPhysicalEntityin interfaceStoichiometry- Returns:
- the physical entity to be annotated with stoichiometry.
-
setPhysicalEntity
- Specified by:
setPhysicalEntityin interfaceStoichiometry- Parameters:
PhysicalEntity- entity to be annotated with stoichiometry.
-
getStoichiometricCoefficient
public float getStoichiometricCoefficient()Description copied from interface:StoichiometryStoichiometric coefficient of the physicalEntity specified byStoichiometry.getPhysicalEntity()in the context of the owner interaction or complex. This value can be any rational number. Generic values such as "n" or "n+1" should not be used - polymers are currently not covered.- Specified by:
getStoichiometricCoefficientin interfaceStoichiometry- Returns:
- Stoichiometric coefficient for one of the entities in an interaction or complex
-
setStoichiometricCoefficient
public void setStoichiometricCoefficient(float newStoichiometricCoefficient) Description copied from interface:StoichiometrySets the stoichiometric coefficient of the physicalEntity specified byStoichiometry.getPhysicalEntity()in the context of the owner interaction or complex. { can be any rational number. Generic values such as "n" or "n+1" should not be used - polymers are currently not covered.- Specified by:
setStoichiometricCoefficientin interfaceStoichiometry- Parameters:
newStoichiometricCoefficient- of the physical entity
-