lerfob.carbonbalancetool.io

Class CATGrowthSimulationRecordReader

java.lang.Object

repicea.io.tools.REpiceaRecordReader

lerfob.carbonbalancetool.io.CATGrowthSimulationRecordReader

All Implemented Interfaces:

java.io.Serializable

public class CATGrowthSimulationRecordReader
extends REpiceaRecordReader

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CATGrowthSimulationRecordReader.CATGrowthSimulationFieldID
protected static class	CATGrowthSimulationRecordReader.CATGrowthSimulationFieldLevel
protected static class	CATGrowthSimulationRecordReader.MessageID

Nested classes/interfaces inherited from class repicea.io.tools.REpiceaRecordReader

REpiceaRecordReader.InternalTask, REpiceaRecordReader.NullInThisFieldException, REpiceaRecordReader.VariableValueException

Constructor Summary

Constructors

Constructor and Description
CATGrowthSimulationRecordReader() General constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<ImportFieldElement>	defineFieldsToImport() This method defines the fields to be imported.
protected java.lang.Enum<?>	defineGroupFieldEnum() This method set the Enum var that corresponds to the group field.
REpiceaMatchSelector<CATSettings.CATSpecies>	getSelector() This method returns the selector for the species in CAT.
protected java.util.List<java.lang.String>	getSpeciesList()
java.util.List<CATCompatibleStand>	getStandList() This method returns the stand list that was last read.
protected void	instantiatePlotAndTree(java.lang.String standIdentification, int dateYr, int realization, java.lang.String plotID, double plotAreaHa, TreeStatusProvider.StatusClass statusClass, double treeVolumeDm3, double numberOfTrees, java.lang.String originalSpeciesName, java.lang.Double dbhCm)
void	readAllRecords() This method reads all the records of the dataset.
protected void	readLineRecord(java.lang.Object[] oArray, int lineCounter) This method read the line record and set the values in the appropriate fields.
void	readRecordsForThisGroupId(int groupId) This method reads the records that correspond to the group ID.

Methods inherited from class repicea.io.tools.REpiceaRecordReader

checkInputFieldsFormat, checkInputFieldsValue, getGroupList, getGroupMap, getGroupName, getImportFieldManager, getObservationIndicesForThisGroup, getSelectedGroupId, initGUIMode, initGUIMode, initInScriptMode, isGroupingEnabled, isThisFieldAvailable, makeASelection, setCurrentFieldID, setPopUpWindowEnabled, setSelectedGroupId

Methods inherited from class java.lang.Object

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

Constructor Detail

CATGrowthSimulationRecordReader

public CATGrowthSimulationRecordReader()

General constructor.

Method Detail

getSelector

public REpiceaMatchSelector<CATSettings.CATSpecies> getSelector()

This method returns the selector for the species in CAT.

Returns:

a REpiceaMatchSelector instance

defineFieldsToImport

protected java.util.List<ImportFieldElement> defineFieldsToImport()
                                                           throws java.lang.Exception

Description copied from class: REpiceaRecordReader

This method defines the fields to be imported. It is to be defined in the derived classes.

Specified by:

defineFieldsToImport in class REpiceaRecordReader

Returns:

a List of ImportFieldElement instances

Throws:

java.lang.Exception

defineGroupFieldEnum

protected java.lang.Enum<?> defineGroupFieldEnum()

Description copied from class: REpiceaRecordReader

This method set the Enum var that corresponds to the group field. If the method returns null then there is no stratum selection at all.

Specified by:

defineGroupFieldEnum in class REpiceaRecordReader

Returns:

an Enum variable

readLineRecord

protected void readLineRecord(java.lang.Object[] oArray,
                              int lineCounter)
                       throws REpiceaRecordReader.VariableValueException,
                              java.lang.Exception

Description copied from class: REpiceaRecordReader

This method read the line record and set the values in the appropriate fields. To be defined in derived classes.

Specified by:

readLineRecord in class REpiceaRecordReader

Throws:

REpiceaRecordReader.VariableValueException

java.lang.Exception

instantiatePlotAndTree

protected void instantiatePlotAndTree(java.lang.String standIdentification,
                                      int dateYr,
                                      int realization,
                                      java.lang.String plotID,
                                      double plotAreaHa,
                                      TreeStatusProvider.StatusClass statusClass,
                                      double treeVolumeDm3,
                                      double numberOfTrees,
                                      java.lang.String originalSpeciesName,
                                      java.lang.Double dbhCm)

readRecordsForThisGroupId

public void readRecordsForThisGroupId(int groupId)
                               throws java.lang.Exception

Description copied from class: REpiceaRecordReader

This method reads the records that correspond to the group ID. If the group ID is not found, the method read all the records by default.

Overrides:

readRecordsForThisGroupId in class REpiceaRecordReader

Parameters:

groupId - a integer that corresponds to the group ID

Throws:

java.lang.Exception

readAllRecords

public void readAllRecords()
                    throws java.lang.Exception

Description copied from class: REpiceaRecordReader

This method reads all the records of the dataset.

Overrides:

readAllRecords in class REpiceaRecordReader

Throws:

java.lang.Exception

getStandList

public java.util.List<CATCompatibleStand> getStandList()

This method returns the stand list that was last read.

Returns:

a list of CATCompatibleStand instances

getSpeciesList

protected java.util.List<java.lang.String> getSpeciesList()