repicea.io.tools

Class REpiceaRecordReader

java.lang.Object

repicea.io.tools.REpiceaRecordReader

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CATGrowthSimulationRecordReader, CATYieldTableRecordReader

public abstract class REpiceaRecordReader
extends java.lang.Object
implements java.io.Serializable

The RecordReader class does two things: 1- it defines the field to be imported and 2- it reads the different records.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	REpiceaRecordReader.InternalTask
static class	REpiceaRecordReader.MessageID
static class	REpiceaRecordReader.NullInThisFieldException
static class	REpiceaRecordReader.VariableValueException

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	REpiceaRecordReader() Constructor for GUI mode.

Method Summary

Modifier and Type	Method and Description
protected void	checkInputFieldsFormat(java.lang.Object[] oArray) This method checks if the input values of the current record are of the appropriate format.
protected void	checkInputFieldsValue(java.lang.Object[] oArray, java.lang.Enum<?> fieldID)
protected abstract java.util.List<ImportFieldElement>	defineFieldsToImport() This method defines the fields to be imported.
protected abstract java.lang.Enum	defineGroupFieldEnum() This method set the Enum var that corresponds to the group field.
java.util.List<java.lang.String>	getGroupList() This method returns a list of Strings that represents the groups.
java.util.Map<java.lang.String,java.util.List<java.lang.Integer>>	getGroupMap() This method returns the indices of all the observations according to their corresponding groups.
java.lang.String	getGroupName(int groupId) This method returns the group name for this particular group ID.
protected ImportFieldManager	getImportFieldManager()
java.util.List<java.lang.Integer>	getObservationIndicesForThisGroup(int groupId) This method returns the indices of the observations for a given group.
int	getSelectedGroupId() This method returns the id of the selected group.
void	initGUIMode(UseModeProvider.UseMode useMode, java.lang.String... fileSpec) This method initializes the RecordInstantiator object in GUI mode with no owner.
void	initGUIMode(java.awt.Window guiOwner, UseModeProvider.UseMode useMode, java.lang.String... fileSpec) This method initializes the RecordInstantiator object in GUI mode.
void	initInScriptMode(ImportFieldManager importFieldManager) For script mode.
boolean	isGroupingEnabled() This method returns true if the grouping is enabled.
protected boolean	isThisFieldAvailable(java.lang.Enum<?> fieldID, java.lang.Object[] oArray) This method returns true if the field is available.
protected void	makeASelection(java.awt.Window guiOwner) If the number of strata is larger than 1, this method provides a dialog with a list that allows to select a particular stratum.
void	readAllRecords() This method reads all the records of the dataset.
protected abstract 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.
protected java.lang.Enum<?>	setCurrentFieldID(java.lang.Object[] oArray, java.lang.Enum<?> currentFieldID)
protected void	setPopUpWindowEnabled(boolean isPopUpWindowEnabled) This method serves to enable or disable the PopUp Windows in the Import dialog.
void	setSelectedGroupId(int selectedGroupId) This method sets the selected group.

Methods inherited from class java.lang.Object

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

Constructor Detail

REpiceaRecordReader

protected REpiceaRecordReader()

Constructor for GUI mode.

Method Detail

initGUIMode

public void initGUIMode(java.awt.Window guiOwner,
                        UseModeProvider.UseMode useMode,
                        java.lang.String... fileSpec)
                 throws java.lang.Exception

This method initializes the RecordInstantiator object in GUI mode.

Parameters:

guiOwner - a Window instance that can be null if the dialog has no owner

fileSpec - the specifications of the file to be imported (e.g. filename, table, etc...)

Throws:

java.lang.Exception - a CancellationException is thrown if the user cancels the dialog

isThisFieldAvailable

protected final boolean isThisFieldAvailable(java.lang.Enum<?> fieldID,
                                             java.lang.Object[] oArray)

This method returns true if the field is available.

Parameters:

fieldID - the enum that represents the field.

oArray - the line record from the file.

Returns:

true if the field can be found in the import field manager and if it can be found in the line record.

setCurrentFieldID

protected final java.lang.Enum<?> setCurrentFieldID(java.lang.Object[] oArray,
                                                    java.lang.Enum<?> currentFieldID)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

checkInputFieldsValue

protected void checkInputFieldsValue(java.lang.Object[] oArray,
                                     java.lang.Enum<?> fieldID)
                              throws java.lang.Exception

Throws:

java.lang.Exception

initGUIMode

public void initGUIMode(UseModeProvider.UseMode useMode,
                        java.lang.String... fileSpec)
                 throws java.lang.Exception

This method initializes the RecordInstantiator object in GUI mode with no owner.

Parameters:

fileSpec - the specifications of the file to be imported (e.g. filename, table, etc...)

Throws:

java.lang.Exception - a CancellationException is thrown if the user cancels the dialog

initInScriptMode

public void initInScriptMode(ImportFieldManager importFieldManager)
                      throws java.lang.Exception

For script mode.

Parameters:

importFieldManager - a valid ImportFieldManager instance

Throws:

java.lang.Exception - when the groups have not been properly read

setPopUpWindowEnabled

protected void setPopUpWindowEnabled(boolean isPopUpWindowEnabled)

This method serves to enable or disable the PopUp Windows in the Import dialog. By default, the pop up are disabled.

Parameters:

isPopUpWindowEnabled - a boolean

readAllRecords

public void readAllRecords()
                    throws java.lang.Exception

This method reads all the records of the dataset.

Throws:

java.lang.Exception

readRecordsForThisGroupId

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

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.

Parameters:

groupId - a integer that corresponds to the group ID

Throws:

java.lang.Exception

getSelectedGroupId

public int getSelectedGroupId()

This method returns the id of the selected group.

Returns:

an Integer

setSelectedGroupId

public void setSelectedGroupId(int selectedGroupId)

This method sets the selected group.

Parameters:

selectedGroupId - an Integer that represents the index of the selected group

isGroupingEnabled

public boolean isGroupingEnabled()

This method returns true if the grouping is enabled.

Returns:

true if enabled or false otherwise

getGroupList

public java.util.List<java.lang.String> getGroupList()

This method returns a list of Strings that represents the groups.

Returns:

a List of String instances

getObservationIndicesForThisGroup

public java.util.List<java.lang.Integer> getObservationIndicesForThisGroup(int groupId)

This method returns the indices of the observations for a given group.

Parameters:

groupId - the id of the group

Returns:

a List of Integer instances

getGroupName

public java.lang.String getGroupName(int groupId)

This method returns the group name for this particular group ID.

Parameters:

groupId - the id of the group

Returns:

a String

getGroupMap

public java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> getGroupMap()

This method returns the indices of all the observations according to their corresponding groups.

Returns:

a Map instance with the group names as keys and the index lists as values

defineFieldsToImport

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

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

Returns:

a List of ImportFieldElement instances

Throws:

java.lang.Exception

checkInputFieldsFormat

protected void checkInputFieldsFormat(java.lang.Object[] oArray)
                               throws java.lang.Exception

This method checks if the input values of the current record are of the appropriate format.

Parameters:

oArray - the line record

Throws:

java.lang.Exception

makeASelection

protected void makeASelection(java.awt.Window guiOwner)
                       throws java.util.concurrent.CancellationException

If the number of strata is larger than 1, this method provides a dialog with a list that allows to select a particular stratum.

Parameters:

guiOwner - the Frame instance that acts as owner

Throws:

java.util.concurrent.CancellationException - if the user has cancelled the dialog

defineGroupFieldEnum

protected abstract java.lang.Enum defineGroupFieldEnum()

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.

Returns:

an Enum variable

readLineRecord

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

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

Throws:

REpiceaRecordReader.VariableValueException

java.lang.Exception

getImportFieldManager

protected ImportFieldManager getImportFieldManager()