lerfob.carbonbalancetool

Enum CATCompartment.CompartmentInfo

java.lang.Object

java.lang.Enum<CATCompartment.CompartmentInfo>

lerfob.carbonbalancetool.CATCompartment.CompartmentInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CATCompartment.CompartmentInfo>, REpiceaTranslator.TextableEnum

Enclosing class:

CATCompartment

public static enum CATCompartment.CompartmentInfo
extends java.lang.Enum<CATCompartment.CompartmentInfo>
implements REpiceaTranslator.TextableEnum

This enum contains basic information on the carbon compartments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AbGround The aboveground biomass (bole, branches and twigs).
CarbEmis The carbon emissions due to fossil fuel consumption.
DeadBiom The dead biomass, i.e.
EnerSubs The energy substitution.
LfillDeg The landfill degradable carbon pool.
LfillEm The Landfill GHG emissions (CH4)
LfillND The landfill non degradable carbon pool.
LivingBiomass The living biomass, i.e.
NetSubs The net substitution, i.e.
Products The wood products.
Roots The compartment that contains the root biomass.
TotalProducts The sum of the living biomass and the wood products.
WComb Emissions due to wood combustion

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getColor() This method returns the color of the compartment for rendering.
static java.util.List<CATCompartment.CompartmentInfo>	getNaturalOrder() This method returns the natural order of this enum variable.
protected boolean	isPrimaryCompartment()
void	setText(java.lang.String englishText, java.lang.String frenchText) This method sets the english and french text for the label, control or title.
java.lang.String	toString()
static CATCompartment.CompartmentInfo	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CATCompartment.CompartmentInfo[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Roots

public static final CATCompartment.CompartmentInfo Roots

The compartment that contains the root biomass.

AbGround

public static final CATCompartment.CompartmentInfo AbGround

The aboveground biomass (bole, branches and twigs).

DeadBiom

public static final CATCompartment.CompartmentInfo DeadBiom

The dead biomass, i.e. the dead trees and the wood pieces left in the forest

Products

public static final CATCompartment.CompartmentInfo Products

The wood products.

LfillDeg

public static final CATCompartment.CompartmentInfo LfillDeg

The landfill degradable carbon pool.

CarbEmis

public static final CATCompartment.CompartmentInfo CarbEmis

The carbon emissions due to fossil fuel consumption.

EnerSubs

public static final CATCompartment.CompartmentInfo EnerSubs

The energy substitution.

LfillND

public static final CATCompartment.CompartmentInfo LfillND

The landfill non degradable carbon pool.

LfillEm

public static final CATCompartment.CompartmentInfo LfillEm

The Landfill GHG emissions (CH4)

WComb

public static final CATCompartment.CompartmentInfo WComb

Emissions due to wood combustion

LivingBiomass

public static final CATCompartment.CompartmentInfo LivingBiomass

The living biomass, i.e. the aboveground biomass + the belowground biomass.

TotalProducts

public static final CATCompartment.CompartmentInfo TotalProducts

The sum of the living biomass and the wood products.

NetSubs

public static final CATCompartment.CompartmentInfo NetSubs

The net substitution, i.e. the energy substitution less the carbon emissions.

Method Detail

values

public static CATCompartment.CompartmentInfo[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CATCompartment.CompartmentInfo c : CATCompartment.CompartmentInfo.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CATCompartment.CompartmentInfo valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isPrimaryCompartment

protected boolean isPrimaryCompartment()

setText

public void setText(java.lang.String englishText,
                    java.lang.String frenchText)

Description copied from interface: REpiceaTranslator.TextableEnum

This method sets the english and french text for the label, control or title.

Specified by:

setText in interface REpiceaTranslator.TextableEnum

Parameters:

englishText - a String

frenchText - a String

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<CATCompartment.CompartmentInfo>

getNaturalOrder

public static java.util.List<CATCompartment.CompartmentInfo> getNaturalOrder()

This method returns the natural order of this enum variable.

Returns:

a List of CompartmentInfo instance

getColor

public java.awt.Color getColor()

This method returns the color of the compartment for rendering.

Returns:

a Color instance