lerfob.treelogger.diameterbasedtreelogger

Class DiameterBasedTreeLoggerParameters

java.lang.Object

repicea.simulation.treelogger.TreeLoggerParameters<DiameterBasedTreeLogCategory>

lerfob.treelogger.diameterbasedtreelogger.DiameterBasedTreeLoggerParameters

All Implemented Interfaces:

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

Direct Known Subclasses:

CATDiameterBasedTreeLoggerParameters, EuropeanBeechBasicTreeLoggerParameters, MaritimePineBasicTreeLoggerParameters

public class DiameterBasedTreeLoggerParameters
extends TreeLoggerParameters<DiameterBasedTreeLogCategory>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiameterBasedTreeLoggerParameters.Grade

Nested classes/interfaces inherited from class repicea.simulation.treelogger.TreeLoggerParameters

TreeLoggerParameters.TreeLoggerParametersFileFilter

Field Summary

Fields inherited from class repicea.simulation.treelogger.TreeLoggerParameters

ANY_SPECIES, treeLogger, TreeLoggerFileFilter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiameterBasedTreeLoggerParameters() Official constructor.
protected	DiameterBasedTreeLoggerParameters(java.lang.Class<? extends TreeLogger<?,?>> clazz) Constructor for derived classes

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	getDefaultSpecies() This method can be override in order to specify a default species.
DiameterBasedTreeLoggerParametersDialog	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
protected void	initializeDefaultLogCategories() This method serves to create a default list of selected tree log categories.
boolean	isCorrect() This method checks if the parameters are correct for the treelogger.
boolean	isVisible() This method returns true if the GUI is visible.
static void	main(java.lang.String[] args)

Methods inherited from class repicea.simulation.treelogger.TreeLoggerParameters

createTreeLoggerInstance, equals, fireEvent, getFileFilter, getFilename, getGUIPermission, getLogCategories, getLogCategory, getLogCategoryList, getLogCategoryNames, getMemorizerPackage, getSpeciesLogCategories, getTreeLoggerDescription, isParameterDialogCanceled, load, load, loadFromFile, postUnmarshallingAction, save, save, setFilename, setParameterDialogCanceled, setReadWritePermissionGranted, showUI, toString, unpackMemorizerPackage

Methods inherited from class java.lang.Object

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

Constructor Detail

DiameterBasedTreeLoggerParameters

protected DiameterBasedTreeLoggerParameters(java.lang.Class<? extends TreeLogger<?,?>> clazz)

Constructor for derived classes

Parameters:

clazz - a TreeLogger-derived class

DiameterBasedTreeLoggerParameters

protected DiameterBasedTreeLoggerParameters()

Official constructor.

Method Detail

initializeDefaultLogCategories

protected void initializeDefaultLogCategories()

Description copied from class: TreeLoggerParameters

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.

Specified by:

initializeDefaultLogCategories in class TreeLoggerParameters<DiameterBasedTreeLogCategory>

isCorrect

public boolean isCorrect()

Description copied from class: TreeLoggerParameters

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

Specified by:

isCorrect in class TreeLoggerParameters<DiameterBasedTreeLogCategory>

Returns:

a boolean

getUI

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

Specified by:

getUI in class TreeLoggerParameters<DiameterBasedTreeLogCategory>

Parameters:

parent - a parent Container instance (can be null)

Returns:

a Component instance

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObjectWithParent

This method returns true if the GUI is visible.

Returns:

a boolean

getDefaultSpecies

protected java.lang.Object getDefaultSpecies()

Description copied from class: TreeLoggerParameters

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

Overrides:

getDefaultSpecies in class TreeLoggerParameters<DiameterBasedTreeLogCategory>

Returns:

an Object preferably either a String or an Enum

main

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