repicea.simulation.treelogger

Class TreeLoggerParameters<LC extends LogCategory>

java.lang.Object

repicea.simulation.treelogger.TreeLoggerParameters<LC>

Type Parameters:

LC - a TreeLogCategory-derived class

All Implemented Interfaces:

java.io.Serializable, REpiceaGUIPermissionProvider, REpiceaShowableUIWithParent, REpiceaUIObjectWithParent, IOUserInterfaceableObject, Loadable, Saveable, Memorizable, PostXmlUnmarshalling

Direct Known Subclasses:

BasicTreeLoggerParameters, DiameterBasedTreeLoggerParameters, DouglasFCBATreeLoggerParameters, MathildeTreeLoggerParameters

public abstract class TreeLoggerParameters<LC extends LogCategory>
extends java.lang.Object
implements Memorizable, IOUserInterfaceableObject, java.io.Serializable, REpiceaShowableUIWithParent, PostXmlUnmarshalling, REpiceaGUIPermissionProvider

The TreeLoggerParameters contains the basic features for defining the parameters of a treelogger.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TreeLoggerParameters.TreeLoggerParametersFileFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANY_SPECIES
protected TreeLogger<?,?>	treeLogger
protected static TreeLoggerParameters.TreeLoggerParametersFileFilter	TreeLoggerFileFilter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TreeLoggerParameters(java.lang.Class<? extends TreeLogger<?,?>> treeLoggerClass) General constructor all the TreeLoggerParameters-derived classes.

Method Summary

Modifier and Type	Method and Description
TreeLogger<TreeLoggerParameters<?>,?>	createTreeLoggerInstance() This method returns a TreeLogger instance adapted to these parameters.
boolean	equals(java.lang.Object obj)
protected void	fireEvent() Deprecated.
protected java.lang.Object	getDefaultSpecies() This method can be override in order to specify a default species.
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.
REpiceaGUIPermission	getGUIPermission() This method returns the Permission instance associated with the object.
java.util.Map<java.lang.Object,java.util.List<LC>>	getLogCategories() This method returns a Map instance with the species names as key and the corresponding List of LogCategory-derived instances as values.
LC	getLogCategory(java.lang.String speciesName, java.lang.String name) This method returns a specific LogCategory object among the selected tree log categories contained in this class.
java.util.List<LC>	getLogCategoryList() This method returns a list of all the LogCategory instances.
java.util.List<java.lang.String>	getLogCategoryNames() This method returns the list of the log category names.
MemorizerPackage	getMemorizerPackage() This method creates a MemorizerPackage instance that can be sent in turn to the TemporaryMemorizer instance for serialization.
java.util.List<LC>	getSpeciesLogCategories(java.lang.Object species) This method returns the List of LogCategory-derived object for a particular species.
TreeLoggerDescription	getTreeLoggerDescription() This method returns a TreeLoggerDescription based on the TreeLogger class of this instance.
abstract TreeLoggerParametersDialog<?>	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
protected abstract void	initializeDefaultLogCategories() This method serves to create a default list of selected tree log categories.
abstract boolean	isCorrect() This method checks if the parameters are correct for the treelogger.
boolean	isParameterDialogCanceled() This method returns false if the parameter initialization has been aborted in GUI mode.
void	load()
void	load(java.lang.String filename) This method makes it possible to load information from a file.
static TreeLoggerParameters<?>	loadFromFile(java.lang.String filename) This method creates a TreeLoggerParameters instance from a previously saved .xml file
void	postUnmarshallingAction() This method is called after the unmashalling.
protected void	save() This method saves the parameters in the current filename.
void	save(java.lang.String filename) This method saves the records in a file denominated by the filename parameter.
void	setFilename(java.lang.String filename)
void	setParameterDialogCanceled(boolean b) This method makes it possible to specify whether or not the parameter initialization in GUI mode has been aborted.
void	setReadWritePermissionGranted(REpiceaGUIPermission permission) This method sets the GUI rights for changing the tree logger parameters.
void	showUI(java.awt.Window parent) This method shows the GUI interface of the class that implements this interface.
java.lang.String	toString()
void	unpackMemorizerPackage(MemorizerPackage mp) This method unpacks the MemorizerPackage instance retrieved by the TemporaryMemorizer class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface repicea.gui.REpiceaUIObjectWithParent

isVisible

Field Detail

TreeLoggerFileFilter

protected static final TreeLoggerParameters.TreeLoggerParametersFileFilter TreeLoggerFileFilter

ANY_SPECIES

public static final java.lang.String ANY_SPECIES

See Also:

Constant Field Values

treeLogger

protected transient TreeLogger<?,?> treeLogger

Constructor Detail

TreeLoggerParameters

protected TreeLoggerParameters(java.lang.Class<? extends TreeLogger<?,?>> treeLoggerClass)

General constructor all the TreeLoggerParameters-derived classes.

Method Detail

initializeDefaultLogCategories

protected abstract void initializeDefaultLogCategories()

This method serves to create a default list of selected tree log categories. Each TreeLoggerParameter object must implements this method in order to provide its own default configuration.

getDefaultSpecies

protected java.lang.Object getDefaultSpecies()

This method can be override in order to specify a default species. That species cannot be removed from the list.

Returns:

an Object preferably either a String or an Enum

getLogCategory

public LC getLogCategory(java.lang.String speciesName,
                         java.lang.String name)

This method returns a specific LogCategory object among the selected tree log categories contained in this class.

Parameters:

speciesName - a String that represents the species name

name - the name of the tree log category

Returns:

a TreeLogCategory-derived instance or null if it cannot be found

isCorrect

public abstract boolean isCorrect()

This method checks if the parameters are correct for the treelogger.

Returns:

a boolean

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

getLogCategoryNames

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

This method returns the list of the log category names. IMPORTANT: the list is filtered such that each value is unique. If the log category "sawlog" appears twice, let's say once for balsam fir and once for black spruce, the list will only have one occurrence of "sawlog".

Returns:

a List of String

getSpeciesLogCategories

public java.util.List<LC> getSpeciesLogCategories(java.lang.Object species)

This method returns the List of LogCategory-derived object for a particular species. IMPORTANT: If there is a default species as specified through the getDefaultSpecies() method and the species is not found in the map, then the log categories of the default species are returned.

Parameters:

species - an Object that represents the species name

Returns:

a List of TreeLogCategory-derived instances or null if the species was not found

getLogCategories

public java.util.Map<java.lang.Object,java.util.List<LC>> getLogCategories()

This method returns a Map instance with the species names as key and the corresponding List of LogCategory-derived instances as values.

Returns:

a Map instance

getLogCategoryList

public java.util.List<LC> getLogCategoryList()

This method returns a list of all the LogCategory instances.

Returns:

a List of LogCategory instances

isParameterDialogCanceled

public boolean isParameterDialogCanceled()

This method returns false if the parameter initialization has been aborted in GUI mode. Returns true otherwise.

Returns:

a boolean

setParameterDialogCanceled

public void setParameterDialogCanceled(boolean b)

This method makes it possible to specify whether or not the parameter initialization in GUI mode has been aborted.

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 mp)

Description copied from interface: Memorizable

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

Specified by:

unpackMemorizerPackage in interface Memorizable

Parameters:

mp - a MemorizerPackage instance

fireEvent

@Deprecated
protected void fireEvent()

Deprecated.

save

protected void save()
             throws java.io.IOException

This method saves the parameters in the current filename.

Throws:

java.io.IOException

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

load

public void load()
          throws java.io.IOException,
                 java.lang.instrument.IllegalClassFormatException

Throws:

java.io.IOException

java.lang.instrument.IllegalClassFormatException

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

getUI

public abstract TreeLoggerParametersDialog<?> 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)

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

setFilename

public void setFilename(java.lang.String filename)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

createTreeLoggerInstance

public TreeLogger<TreeLoggerParameters<?>,?> createTreeLoggerInstance()

This method returns a TreeLogger instance adapted to these parameters.

Returns:

a TreeLogger instance

getTreeLoggerDescription

public TreeLoggerDescription getTreeLoggerDescription()

This method returns a TreeLoggerDescription based on the TreeLogger class of this instance.

Returns:

a TreeLoggerDescription instance

loadFromFile

public static TreeLoggerParameters<?> loadFromFile(java.lang.String filename)
                                            throws java.io.IOException

This method creates a TreeLoggerParameters instance from a previously saved .xml file

Parameters:

filename - the path of the xml file

Returns:

a TreeLoggerParameter instance

Throws:

java.io.IOException

postUnmarshallingAction

public void postUnmarshallingAction()

Description copied from interface: PostXmlUnmarshalling

This method is called after the unmashalling. It may serve to correct for former implementation.

Specified by:

postUnmarshallingAction in interface PostXmlUnmarshalling

getGUIPermission

public REpiceaGUIPermission getGUIPermission()

Description copied from interface: REpiceaGUIPermissionProvider

This method returns the Permission instance associated with the object.

Specified by:

getGUIPermission in interface REpiceaGUIPermissionProvider

Returns:

a Permission instance

setReadWritePermissionGranted

public void setReadWritePermissionGranted(REpiceaGUIPermission permission)

This method sets the GUI rights for changing the tree logger parameters. By default, the rights are granted.

Parameters:

permission - a REpiceaGUIPermission instance

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object