lerfob.carbonbalancetool.biomassparameters

Class BiomassParameters

java.lang.Object

lerfob.carbonbalancetool.biomassparameters.BiomassParameters

All Implemented Interfaces:

REpiceaShowableUIWithParent, REpiceaUIObjectWithParent, Resettable, IOUserInterfaceableObject, Loadable, Saveable, Memorizable

public class BiomassParameters
extends java.lang.Object
implements REpiceaShowableUIWithParent, IOUserInterfaceableObject, Resettable, Memorizable

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<SpeciesTypeProvider.SpeciesType,java.lang.Double>	basicWoodDensityFactors Deprecated.
protected boolean	basicWoodDensityFromModel
protected boolean	basicWoodDensityFromModelEnabled
protected boolean	branchExpansionFactorFromModel
protected boolean	branchExpansionFactorFromModelEnabled
protected java.util.HashMap<SpeciesTypeProvider.SpeciesType,java.lang.Double>	branchExpansionFactors
protected java.util.HashMap<SpeciesTypeProvider.SpeciesType,java.lang.Double>	carbonContentFactors
protected boolean	carbonContentFromModel
protected boolean	carbonContentFromModelEnabled
protected REpiceaGUIPermission	permissions
protected boolean	rootExpansionFactorFromModel
protected boolean	rootExpansionFactorFromModelEnabled
protected java.util.HashMap<SpeciesTypeProvider.SpeciesType,java.lang.Double>	rootExpansionFactors

Constructor Summary

Constructors

Constructor and Description
BiomassParameters() Empty constructor for class.newInstance() call.
BiomassParameters(REpiceaGUIPermission permissions) Empty constructor for class.newInstance() call.

Method Summary

Modifier and Type	Method and Description
double	getAboveGroundBiomassMg(java.util.Collection<CATCompatibleTree> trees, MonteCarloSimulationCompliantObject subject) This method returns the aboveground biomass for a collection of trees.
double	getAboveGroundCarbonMg(CATCompatibleTree tree, MonteCarloSimulationCompliantObject subject) This method returns the aboveground carbon of a particular tree (Mg), INCLUDING bark.
double	getAboveGroundCarbonMg(java.util.Collection<CATCompatibleTree> trees, MonteCarloSimulationCompliantObject subject) This method returns the aboveground carbon for a collection of trees.
double	getAboveGroundVolumeM3(CATCompatibleTree tree, MonteCarloSimulationCompliantObject subject) This method returns the aboveground volume of a particular tree (m3), INCLUDING bark.
double	getAboveGroundVolumeM3(java.util.Collection<CATCompatibleTree> trees, MonteCarloSimulationCompliantObject subject) This method returns the aboveground volume for a collection of trees.
double	getBasicWoodDensityFromThisTree(CATCompatibleTree tree, MonteCarloSimulationCompliantObject subject) This method returns the basic density factor for this tree.
double	getBelowGroundBiomassMg(java.util.Collection<CATCompatibleTree> trees, MonteCarloSimulationCompliantObject subject)
double	getBelowGroundCarbonMg(java.util.Collection<CATCompatibleTree> trees, MonteCarloSimulationCompliantObject subject)
double	getBelowGroundVolumeM3(CATCompatibleTree tree, MonteCarloSimulationCompliantObject subject) This method returns the belowground volume of a particular instance, INCLUDING bark and
double	getBelowGroundVolumeM3(java.util.Collection<CATCompatibleTree> trees, MonteCarloSimulationCompliantObject subject)
double	getCarbonContentFromThisTree(CATCompatibleTree tree, MonteCarloSimulationCompliantObject subject) This method returns the carbon content ratio for this tree, INCLUDING bark.
double	getCommercialBiomassMg(java.util.Collection<CATCompatibleTree> trees, MonteCarloSimulationCompliantObject subject)
double	getCommercialCarbonMg(java.util.Collection<CATCompatibleTree> trees, MonteCarloSimulationCompliantObject subject)
double	getCommercialVolumeM3(java.util.Collection<CATCompatibleTree> trees)
javax.swing.filechooser.FileFilter	getFileFilter() This method returns the appropriate FileFilter instance for this class.
java.lang.String	getFilename() This method returns the filename of the parameters.
MemorizerPackage	getMemorizerPackage() This method creates a MemorizerPackage instance that can be sent in turn to the TemporaryMemorizer instance for serialization.
java.lang.String	getName()
static double	getOverbarkCommercialVolumeM3(CATCompatibleTree tree) This static method returns the volume over bark of a CATCompatibleTree instance.
protected java.lang.String	getSubjectId(CATSensitivityAnalysisSettings.VariabilitySource source, CATCompatibleTree tree)
java.awt.Component	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
boolean	isValid()
boolean	isVisible() This method returns true if the GUI is visible.
void	load(java.lang.String filename) This method makes it possible to load information from a file.
static void	main(java.lang.String[] args)
void	reset() This method reinitializes some fields of the instance that implements this interface.
void	save(java.lang.String filename) This method saves the records in a file denominated by the filename parameter.
void	setReferent(java.lang.Object referent)
void	showUI(java.awt.Window parent) This method shows the GUI interface of the class that implements this interface.
void	unpackMemorizerPackage(MemorizerPackage wasMemorized) This method unpacks the MemorizerPackage instance retrieved by the TemporaryMemorizer class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

branchExpansionFactors

protected final java.util.HashMap<SpeciesTypeProvider.SpeciesType,java.lang.Double> branchExpansionFactors

rootExpansionFactors

protected final java.util.HashMap<SpeciesTypeProvider.SpeciesType,java.lang.Double> rootExpansionFactors

basicWoodDensityFactors

@Deprecated
protected final java.util.HashMap<SpeciesTypeProvider.SpeciesType,java.lang.Double> basicWoodDensityFactors

Deprecated.

carbonContentFactors

protected final java.util.HashMap<SpeciesTypeProvider.SpeciesType,java.lang.Double> carbonContentFactors

rootExpansionFactorFromModel

protected boolean rootExpansionFactorFromModel

rootExpansionFactorFromModelEnabled

protected boolean rootExpansionFactorFromModelEnabled

branchExpansionFactorFromModel

protected boolean branchExpansionFactorFromModel

branchExpansionFactorFromModelEnabled

protected boolean branchExpansionFactorFromModelEnabled

basicWoodDensityFromModel

protected boolean basicWoodDensityFromModel

basicWoodDensityFromModelEnabled

protected boolean basicWoodDensityFromModelEnabled

carbonContentFromModel

protected boolean carbonContentFromModel

carbonContentFromModelEnabled

protected boolean carbonContentFromModelEnabled

permissions

protected transient REpiceaGUIPermission permissions

Constructor Detail

BiomassParameters

public BiomassParameters(REpiceaGUIPermission permissions)

Empty constructor for class.newInstance() call.

BiomassParameters

public BiomassParameters()

Empty constructor for class.newInstance() call.

Method Detail

setReferent

public void setReferent(java.lang.Object referent)

getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()

Description copied from interface: IOUserInterfaceableObject

This method returns the appropriate FileFilter instance for this class.

Specified by:

getFileFilter in interface IOUserInterfaceableObject

Returns:

a FileFilter instance

reset

public void reset()

Description copied from interface: Resettable

This method reinitializes some fields of the instance that implements this interface.

Specified by:

reset in interface Resettable

isValid

public boolean isValid()

getUI

public java.awt.Component getUI(java.awt.Container parent)

Description copied from interface: REpiceaUIObjectWithParent

This method returns the GUI interface of the class that implements this interface.

Specified by:

getUI in interface REpiceaUIObjectWithParent

Parameters:

parent - a parent Container instance (can be null)

Returns:

a Component instance

showUI

public void showUI(java.awt.Window parent)

Description copied from interface: REpiceaShowableUIWithParent

This method shows the GUI interface of the class that implements this interface.

Specified by:

showUI in interface REpiceaShowableUIWithParent

Parameters:

parent - the parent Window instance (can be null)

save

public void save(java.lang.String filename)
          throws java.io.IOException

Description copied from interface: Saveable

This method saves the records in a file denominated by the filename parameter.

Specified by:

save in interface Saveable

Parameters:

filename - the name of the file

Throws:

java.io.IOException

getName

public java.lang.String getName()

load

public void load(java.lang.String filename)
          throws java.io.IOException

Description copied from interface: Loadable

This method makes it possible to load information from a file.

Specified by:

load in interface Loadable

Parameters:

filename - the name of the file

Throws:

java.io.IOException - if the file cannot be read

getFilename

public java.lang.String getFilename()

Description copied from interface: IOUserInterfaceableObject

This method returns the filename of the parameters.

Specified by:

getFilename in interface IOUserInterfaceableObject

Returns:

a String

getMemorizerPackage

public MemorizerPackage getMemorizerPackage()

Description copied from interface: Memorizable

This method creates a MemorizerPackage instance that can be sent in turn to the TemporaryMemorizer instance for serialization.

Specified by:

getMemorizerPackage in interface Memorizable

Returns:

a MemorizerPackage instance

unpackMemorizerPackage

public void unpackMemorizerPackage(MemorizerPackage wasMemorized)

Description copied from interface: Memorizable

This method unpacks the MemorizerPackage instance retrieved by the TemporaryMemorizer class.

Specified by:

unpackMemorizerPackage in interface Memorizable

Parameters:

wasMemorized - a MemorizerPackage instance

getBasicWoodDensityFromThisTree

public double getBasicWoodDensityFromThisTree(CATCompatibleTree tree,
                                              MonteCarloSimulationCompliantObject subject)

This method returns the basic density factor for this tree.

Parameters:

tree - a CarbonToolCompatibleTree

Returns:

a double (Mg/m3)

getCarbonContentFromThisTree

public double getCarbonContentFromThisTree(CATCompatibleTree tree,
                                           MonteCarloSimulationCompliantObject subject)

This method returns the carbon content ratio for this tree, INCLUDING bark.

Parameters:

tree - a CarbonToolCompatibleTree

Returns:

a double

getBelowGroundVolumeM3

public double getBelowGroundVolumeM3(CATCompatibleTree tree,
                                     MonteCarloSimulationCompliantObject subject)

This method returns the belowground volume of a particular instance, INCLUDING bark and

Parameters:

tree - a CarbonToolCompatibleTree instance

Returns:

the volume (M3)

getAboveGroundCarbonMg

public double getAboveGroundCarbonMg(CATCompatibleTree tree,
                                     MonteCarloSimulationCompliantObject subject)

This method returns the aboveground carbon of a particular tree (Mg), INCLUDING bark.

Parameters:

tree - a CarbonCompatibleTree

Returns:

a double

getAboveGroundVolumeM3

public double getAboveGroundVolumeM3(CATCompatibleTree tree,
                                     MonteCarloSimulationCompliantObject subject)

This method returns the aboveground volume of a particular tree (m3), INCLUDING bark.

Parameters:

tree - a CarbonCompatibleTree

Returns:

a double

getSubjectId

protected java.lang.String getSubjectId(CATSensitivityAnalysisSettings.VariabilitySource source,
                                        CATCompatibleTree tree)

getOverbarkCommercialVolumeM3

public static double getOverbarkCommercialVolumeM3(CATCompatibleTree tree)

This static method returns the volume over bark of a CATCompatibleTree instance.

Parameters:

tree - a CATCompatibleTree instance

Returns:

the volume of a single tree, i.e. WITHOUT any expansion factor.

getAboveGroundVolumeM3

public double getAboveGroundVolumeM3(java.util.Collection<CATCompatibleTree> trees,
                                     MonteCarloSimulationCompliantObject subject)

This method returns the aboveground volume for a collection of trees.

Parameters:

trees - a Collection of CarbonToolCompatibleTree instances

Returns:

a double

getAboveGroundBiomassMg

public double getAboveGroundBiomassMg(java.util.Collection<CATCompatibleTree> trees,
                                      MonteCarloSimulationCompliantObject subject)

This method returns the aboveground biomass for a collection of trees.

Parameters:

trees - a Collection of CarbonToolCompatibleTree instances

Returns:

a double

getAboveGroundCarbonMg

public double getAboveGroundCarbonMg(java.util.Collection<CATCompatibleTree> trees,
                                     MonteCarloSimulationCompliantObject subject)

This method returns the aboveground carbon for a collection of trees.

Parameters:

trees - a Collection of CarbonToolCompatibleTree instances

Returns:

a double

getBelowGroundCarbonMg

public double getBelowGroundCarbonMg(java.util.Collection<CATCompatibleTree> trees,
                                     MonteCarloSimulationCompliantObject subject)

getBelowGroundBiomassMg

public double getBelowGroundBiomassMg(java.util.Collection<CATCompatibleTree> trees,
                                      MonteCarloSimulationCompliantObject subject)

getBelowGroundVolumeM3

public double getBelowGroundVolumeM3(java.util.Collection<CATCompatibleTree> trees,
                                     MonteCarloSimulationCompliantObject subject)

getCommercialVolumeM3

public double getCommercialVolumeM3(java.util.Collection<CATCompatibleTree> trees)

getCommercialBiomassMg

public double getCommercialBiomassMg(java.util.Collection<CATCompatibleTree> trees,
                                     MonteCarloSimulationCompliantObject subject)

getCommercialCarbonMg

public double getCommercialCarbonMg(java.util.Collection<CATCompatibleTree> trees,
                                    MonteCarloSimulationCompliantObject subject)

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObjectWithParent

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObjectWithParent

Returns:

a boolean

main

public static void main(java.lang.String[] args)