com.hfg.chem

Class OrganicMatterImpl

java.lang.Object

com.hfg.chem.MatterImpl

com.hfg.chem.OrganicMatterImpl

All Implemented Interfaces:

Matter, OrganicMatter, java.lang.Cloneable, java.lang.Comparable<MatterImpl>

public class OrganicMatterImpl
extends MatterImpl
implements OrganicMatter, java.lang.Cloneable

Elemental composition and mass tracking object.

Constructor Summary

Constructors

Constructor and Description
OrganicMatterImpl()
OrganicMatterImpl(java.util.Map<Element,java.lang.Float> inMap)
OrganicMatterImpl(OrganicMatter inInitialValue)

Method Summary

Modifier and Type	Method and Description
OrganicMatterImpl	add(Matter inValue, int inCount)
protected void	calculateMassFromElementalComposition()
void	clearCalculatedProperties()
OrganicMatterImpl	clone()
boolean	equals(java.lang.Object inObj)
java.lang.Double	getOrganicAverageMass()
protected boolean	massesAreUserSet()
OrganicMatterImpl	remove(Matter inValue)
OrganicMatterImpl	remove(Matter inValue, int inCount)
OrganicMatterImpl	setOrganicAverageMass(java.lang.Double inValue) If the elemental composition is known, use setElementalComposition() and the masses will be derived automatically; this method is for use in those (hopefully) rare times when the mass is known but not the elemental composition.

Methods inherited from class com.hfg.chem.MatterImpl

add, addAtoms, addAtoms, addElementalComposition, addElementalComposition, clearElementalComposition, compareTo, fromChemicalFormula, getAverageMass, getChemicalFormula, getChemicalFormulaWithSubscripts, getElementalComposition, getMonoisotopicMass, hashCode, setAverageMass, setElementalComposition, setMonoisotopicMass

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hfg.chem.Matter

getAverageMass, getElementalComposition, getMonoisotopicMass

Constructor Detail

OrganicMatterImpl

public OrganicMatterImpl()

OrganicMatterImpl

public OrganicMatterImpl(java.util.Map<Element,java.lang.Float> inMap)

OrganicMatterImpl

public OrganicMatterImpl(OrganicMatter inInitialValue)

Method Detail

equals

public boolean equals(java.lang.Object inObj)

Overrides:

equals in class MatterImpl

add

public OrganicMatterImpl add(Matter inValue,
                             int inCount)

Overrides:

add in class MatterImpl

remove

public OrganicMatterImpl remove(Matter inValue)

Overrides:

remove in class MatterImpl

remove

public OrganicMatterImpl remove(Matter inValue,
                                int inCount)

Overrides:

remove in class MatterImpl

setOrganicAverageMass

public OrganicMatterImpl setOrganicAverageMass(java.lang.Double inValue)

If the elemental composition is known, use setElementalComposition() and the masses will be derived automatically; this method is for use in those (hopefully) rare times when the mass is known but not the elemental composition.

Parameters:

inValue - the mass to use as the organic average mass for this object

Returns:

this OrganicMatterImpl object to enable method chaining

getOrganicAverageMass

public java.lang.Double getOrganicAverageMass()

Specified by:

getOrganicAverageMass in interface OrganicMatter

clone

public OrganicMatterImpl clone()

Overrides:

clone in class MatterImpl

clearCalculatedProperties

public void clearCalculatedProperties()

Overrides:

clearCalculatedProperties in class MatterImpl

calculateMassFromElementalComposition

protected void calculateMassFromElementalComposition()

Overrides:

calculateMassFromElementalComposition in class MatterImpl

massesAreUserSet

protected boolean massesAreUserSet()

Overrides:

massesAreUserSet in class MatterImpl