sbrt.kernel.fba
Class AbstractExchangeRxn

java.lang.Object
  extended by sbrt.kernel.fba.AbstractExchangeRxn
All Implemented Interfaces:
ChemRxn, ExchangeRxn
Direct Known Subclasses:
RevExchRxn, SinkRxn, SourceRxn

public abstract class AbstractExchangeRxn
extends java.lang.Object
implements ChemRxn, ExchangeRxn

This class is a skeleton implementation of ExchangeRxn.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Constructor Summary
AbstractExchangeRxn(java.lang.String chemSpecies)
          Constructs a new exchange reaction for the provided chemical species.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Returns obj == this.
 LinearComb<java.lang.String> getProducts()
          Returns an empty linear combination.
 LinearComb<java.lang.String> getReactants()
          Returns an empty linear combination.
 java.lang.String getSpecies()
          Returns the chemical species associated with this exchange reaction.
 int hashCode()
          Returns a content-based hash code for this exchange reaction.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface sbrt.kernel.fba.ChemRxn
isReversible, toString
 

Constructor Detail

AbstractExchangeRxn

public AbstractExchangeRxn(java.lang.String chemSpecies)
Constructs a new exchange reaction for the provided chemical species.

Parameters:
chemSpecies - the chemical species associated with this exchange reaction.
Throws:
java.lang.IllegalArgumentException - if an empty string is provided.
Method Detail

getSpecies

public final java.lang.String getSpecies()
Returns the chemical species associated with this exchange reaction.

Specified by:
getSpecies in interface ExchangeRxn
Returns:
the chemical species associated with this exchange reaction.

getReactants

public LinearComb<java.lang.String> getReactants()
Returns an empty linear combination.

Specified by:
getReactants in interface ChemRxn
Returns:
an empty linear combination.

getProducts

public LinearComb<java.lang.String> getProducts()
Returns an empty linear combination.

Specified by:
getProducts in interface ChemRxn
Returns:
an empty linear combination.

equals

public boolean equals(java.lang.Object obj)
Returns obj == this.

Specified by:
equals in interface ChemRxn
Overrides:
equals in class java.lang.Object
Parameters:
obj - the reference object with which to compare.
Returns:
obj == this.

hashCode

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

Specified by:
hashCode in interface ChemRxn
Overrides:
hashCode in class java.lang.Object
Returns:
a content-based hash code for this exchange reaction.