lerfob.carbonbalancetool.productionlines

Class ProductionProcessorManager

java.lang.Object

repicea.simulation.processsystem.SystemManager

lerfob.carbonbalancetool.productionlines.ProductionProcessorManager

All Implemented Interfaces:

ListManager<Processor>, REpiceaGUIPermissionProvider, REpiceaShowableUIWithParent, REpiceaUIObjectWithParent, Resettable, IOUserInterfaceableObject, Loadable, Saveable, Memorizable

public class ProductionProcessorManager
extends SystemManager
implements Memorizable

The ProductionProcessorManager class is an implementation of SystemManager for production line design in a context of carbon balance assessment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ProductionProcessorManager.EnhancedMode
protected static class	ProductionProcessorManager.TreeLoggerInstanceCompatibilityException

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<LeftHandSideProcessor>	DefaultLeftHandSideProcessors
protected java.util.ArrayList<LeftHandSideProcessor>	logCategoryProcessors
protected static lerfob.carbonbalancetool.productionlines.ProductionProcessorManager.ProductionLineFileFilter	MyFileFilter
static double	VERY_SMALL The VERY_SMALL value serves as threshold when dealing with small quantities.

Fields inherited from class repicea.simulation.processsystem.SystemManager

guiInterface

Constructor Summary

Constructors

Constructor and Description
ProductionProcessorManager()
ProductionProcessorManager(DefaultREpiceaGUIPermission defaultPermission) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actualizeCarbonUnits(CATCompartmentManager compartmentManager) This method actualizes the different carbon units.
protected void	actualizeTreeLoggerParameters()
protected java.util.Vector<TreeLoggerParameters<?>>	getAvailableTreeLoggerParameters()
protected CarbonUnitMap<CarbonUnit.CarbonUnitStatus>	getCarbonUnitMap()
CarbonUnitList	getCarbonUnits(CarbonUnit.CarbonUnitStatus type) This method returns the CarbonUnitList instance that match the type of carbon.
protected CATDecayFunction	getDecayFunction()
javax.swing.filechooser.FileFilter	getFileFilter() This method returns the appropriate FileFilter instance for this class.
MemorizerPackage	getMemorizerPackage() This method creates a MemorizerPackage instance that can be sent in turn to the TemporaryMemorizer instance for serialization.
TreeLogger	getSelectedTreeLogger()
protected TreeLoggerParameters<?>	getSelectedTreeLoggerParameters()
SystemManagerDialog	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
boolean	isValid() This method returns true if the ProductionProcessorManager instance is valid or false otherwise.
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	processWoodPiece(LogCategory logCategory, int dateIndex, java.lang.String samplingUnitID, AmountMap<CarbonUnit.Element> amountMap, java.lang.String speciesName) The main method for this class.
void	processWoodyDebris(int dateIndex, java.lang.String samplingUnitID, AmountMap<CarbonUnit.Element> amountMap, java.lang.String speciesName, WoodyDebrisProcessor.WoodyDebrisProcessorID type) This method calculates the carbon units in the woody debris.
void	reset() This method reinitializes some fields of the instance that implements this interface.
void	resetCarbonUnitMap()
void	setAvailableTreeLoggers(java.util.Vector<TreeLoggerDescription> vector) This method sets the list of tree logger descriptions.
protected void	setSelectedTreeLogger(TreeLoggerParameters<?> treeLoggerParameters)
void	unpackMemorizerPackage(MemorizerPackage wasMemorized) This method unpacks the MemorizerPackage instance retrieved by the TemporaryMemorizer class.

Methods inherited from class repicea.simulation.processsystem.SystemManager

checkForEndlessLoops, getFilename, getGUIPermission, getList, getName, getPrimaryProcessors, isVisible, registerObject, removeObject, save, showUI

Methods inherited from class java.lang.Object

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

Field Detail

DefaultLeftHandSideProcessors

protected static java.util.List<LeftHandSideProcessor> DefaultLeftHandSideProcessors

MyFileFilter

protected static final lerfob.carbonbalancetool.productionlines.ProductionProcessorManager.ProductionLineFileFilter MyFileFilter

VERY_SMALL

public static final double VERY_SMALL

The VERY_SMALL value serves as threshold when dealing with small quantities. Below the threshold the quantity is not considered at all.

See Also:

Constant Field Values

logCategoryProcessors

protected final java.util.ArrayList<LeftHandSideProcessor> logCategoryProcessors

Constructor Detail

ProductionProcessorManager

public ProductionProcessorManager(DefaultREpiceaGUIPermission defaultPermission)

Constructor.

ProductionProcessorManager

public ProductionProcessorManager()

Method Detail

getSelectedTreeLogger

public TreeLogger getSelectedTreeLogger()

resetCarbonUnitMap

public void resetCarbonUnitMap()

getSelectedTreeLoggerParameters

protected TreeLoggerParameters<?> getSelectedTreeLoggerParameters()

setSelectedTreeLogger

protected void setSelectedTreeLogger(TreeLoggerParameters<?> treeLoggerParameters)

actualizeTreeLoggerParameters

protected void actualizeTreeLoggerParameters()

getAvailableTreeLoggerParameters

protected java.util.Vector<TreeLoggerParameters<?>> getAvailableTreeLoggerParameters()

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

Overrides:

getFileFilter in class SystemManager

Returns:

a FileFilter instance

getUI

public SystemManagerDialog 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

Overrides:

getUI in class SystemManager

Parameters:

parent - a parent Container instance (can be null)

Returns:

a Component instance

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

Overrides:

getMemorizerPackage in class SystemManager

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

Overrides:

unpackMemorizerPackage in class SystemManager

Parameters:

wasMemorized - a MemorizerPackage instance

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

Overrides:

load in class SystemManager

Parameters:

filename - the name of the file

Throws:

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

setAvailableTreeLoggers

public void setAvailableTreeLoggers(java.util.Vector<TreeLoggerDescription> vector)

This method sets the list of tree logger descriptions.

Parameters:

vector - a Vector instance containing TreeLoggerdescription objects

isValid

public boolean isValid()

This method returns true if the ProductionProcessorManager instance is valid or false otherwise. To be valid, all the LogCategoryProcessor must have at least one sub processor. Moreover, all the processors must be valid, i.e. the sum of the fluxes to the sub processors must be equal to 100%.

Returns:

a boolean

processWoodPiece

public void processWoodPiece(LogCategory logCategory,
                             int dateIndex,
                             java.lang.String samplingUnitID,
                             AmountMap<CarbonUnit.Element> amountMap,
                             java.lang.String speciesName)

The main method for this class. The different kinds of produced carbon units are stored in the carbon unit map, which is accessible through the getCarbonUnits(CarbonUnitType) method.

Parameters:

logCategory - a TreeLogCategory instance

dateIndex - the index of the date in the time scale

amountMap - a Map which contains the amounts of the different elements

processWoodyDebris

public void processWoodyDebris(int dateIndex,
                               java.lang.String samplingUnitID,
                               AmountMap<CarbonUnit.Element> amountMap,
                               java.lang.String speciesName,
                               WoodyDebrisProcessor.WoodyDebrisProcessorID type)

This method calculates the carbon units in the woody debris.

Parameters:

dateIndex - the index of the date in the time scale

amountMap - a Map which contains the amounts of the different elements

type - a WoodyDebrisProcessorID enum variable

actualizeCarbonUnits

public void actualizeCarbonUnits(CATCompartmentManager compartmentManager)
                          throws java.lang.Exception

This method actualizes the different carbon units. It proceeds in the following order :
1- the carbon units in the wood products
2- the carbon units recycled from the disposed wood products
3- the carbon units left in the forest
4- the carbon units at the landfill site

Parameters:

compartmentManager - the CATCompartmentManager instance

Throws:

java.lang.Exception

getDecayFunction

protected CATDecayFunction getDecayFunction()

getCarbonUnitMap

protected CarbonUnitMap<CarbonUnit.CarbonUnitStatus> getCarbonUnitMap()

getCarbonUnits

public CarbonUnitList getCarbonUnits(CarbonUnit.CarbonUnitStatus type)

This method returns the CarbonUnitList instance that match the type of carbon.

Parameters:

type - a CarbonUnitType enum (EndUseWoodProduct, Landfill, Recycled, LeftInForest)

Returns:

a CarbonUnitList 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

Overrides:

reset in class SystemManager

main

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