sbrt.kernel.fba
Interface ChemRxn

All Known Subinterfaces:
ExchangeRxn
All Known Implementing Classes:
AbstractExchangeRxn, AbstractRxn, IrrevRxn, RevExchRxn, RevRxn, SinkRxn, SourceRxn

public interface ChemRxn

This interface is used to represent chemical reactions. A chemical reaction is composed of reactants and products, which are represented as linear combinations of chemical species.

Author:
This interface was written and documented by Jeremiah Wright while in the Wagner Lab.

Method Summary
 boolean equals(java.lang.Object obj)
          Indicates if the provided object is "equal to" this chemical reaction.
 LinearComb<java.lang.String> getProducts()
          Returns the products of this chemical reaction.
 LinearComb<java.lang.String> getReactants()
          Returns the reactants of this chemical reaction.
 int hashCode()
          Returns a content-based hash code for this chemical reaction.
 boolean isReversible()
          Indicates if this chemical reaction is considered reversible.
 java.lang.String toString()
          Returns an appropriate string representation of this chemical reaction.
 

Method Detail

getReactants

LinearComb<java.lang.String> getReactants()
Returns the reactants of this chemical reaction.

Returns:
the reactants of this chemical reaction.

getProducts

LinearComb<java.lang.String> getProducts()
Returns the products of this chemical reaction.

Returns:
the products of this chemical reaction.

isReversible

boolean isReversible()
Indicates if this chemical reaction is considered reversible.

Returns:
true if this reaction is reversible; false otherwise.

toString

java.lang.String toString()
Returns an appropriate string representation of this chemical reaction.

Overrides:
toString in class java.lang.Object
Returns:
an appropriate string representation of this chemical reaction.

equals

boolean equals(java.lang.Object obj)
Indicates if the provided object is "equal to" this chemical reaction.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if this reaction is equal to the provided object; false otherwise.

hashCode

int hashCode()
Returns a content-based hash code for this chemical reaction.

Overrides:
hashCode in class java.lang.Object
Returns:
a content-based hash code for this chemical reaction.