repicea.gui.components

Class REpiceaMatchSelector<E extends java.lang.Enum<E>>

java.lang.Object

repicea.gui.components.REpiceaMatchSelector<E>

Type Parameters:

E - an Enum

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.TableModelListener, REpiceaShowableUIWithParent, REpiceaUIObjectWithParent, IOUserInterfaceableObject, Loadable, Saveable, Memorizable

Direct Known Subclasses:

CATGrowthSimulationSpeciesSelector

public class REpiceaMatchSelector<E extends java.lang.Enum<E>>
extends java.lang.Object
implements REpiceaShowableUIWithParent, javax.swing.event.TableModelListener, IOUserInterfaceableObject, Memorizable

The REpiceaMatchSelector class has a Map that related some strings to an enum variable. It has a user interface that displays a table in which the user can make the different matches.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object[]	columnNames
protected java.lang.String	filename
protected REpiceaMatchSelectorDialog	guiInterface
protected java.util.Map<java.lang.Object,java.lang.Enum<E>>	matchMap
protected java.util.List<java.lang.Enum<E>>	potentialMatches

Constructor Summary

Constructors

Constructor and Description
REpiceaMatchSelector(java.lang.Object[] toBeMatched, java.lang.Enum<E>[] potentialMatchArray, java.lang.Enum<E> defaultMatch, java.lang.Object[] columnNames) Official constructor

Method Summary

Modifier and Type	Method and Description
protected void	addMatches(java.lang.Enum<E>[] enumValues) This method adds a potential treatment to the list of available treatments
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.
java.lang.Enum<E>	getMatch(java.lang.Object obj) This method returns the match corresponding to the parameter.
MemorizerPackage	getMemorizerPackage() This method creates a MemorizerPackage instance that can be sent in turn to the TemporaryMemorizer instance for serialization.
protected java.util.List<java.lang.Enum<E>>	getPotentialMatches()
REpiceaMatchSelectorDialog	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
boolean	isVisible() This method returns true if the GUI is visible.
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	save(java.lang.String filename) This method saves the records in a file denominated by the filename parameter.
protected void	setFilename(java.lang.String filename)
void	showUI(java.awt.Window parent) This method shows the GUI interface of the class that implements this interface.
void	tableChanged(javax.swing.event.TableModelEvent e)
void	unpackMemorizerPackage(MemorizerPackage wasMemorized) This method unpacks the MemorizerPackage instance retrieved by the TemporaryMemorizer class.

Methods inherited from class java.lang.Object

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

Field Detail

matchMap

protected final java.util.Map<java.lang.Object,java.lang.Enum<E extends java.lang.Enum<E>>> matchMap

potentialMatches

protected final java.util.List<java.lang.Enum<E extends java.lang.Enum<E>>> potentialMatches

filename

protected java.lang.String filename

guiInterface

protected transient REpiceaMatchSelectorDialog guiInterface

columnNames

protected final java.lang.Object[] columnNames

Constructor Detail

REpiceaMatchSelector

public REpiceaMatchSelector(java.lang.Object[] toBeMatched,
                            java.lang.Enum<E>[] potentialMatchArray,
                            java.lang.Enum<E> defaultMatch,
                            java.lang.Object[] columnNames)

Official constructor

Parameters:

toBeMatched - an array of strings to be matched

potentialMatchArray - an array of enum variables

defaultMatch - an enum variable that acts as a default match

columnNames - an array of object (Strings or Enum) for column titles

Method Detail

addMatches

protected void addMatches(java.lang.Enum<E>[] enumValues)

This method adds a potential treatment to the list of available treatments

Parameters:

enumValues - an array of enum variable

getPotentialMatches

protected java.util.List<java.lang.Enum<E>> getPotentialMatches()

getUI

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

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObjectWithParent

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObjectWithParent

Returns:

a boolean

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)

tableChanged

public void tableChanged(javax.swing.event.TableModelEvent e)

Specified by:

tableChanged in interface javax.swing.event.TableModelListener

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

setFilename

protected void setFilename(java.lang.String filename)

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

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

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

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

Description copied from interface: Memorizable

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

Specified by:

unpackMemorizerPackage in interface Memorizable

Parameters:

wasMemorized - a MemorizerPackage instance

getMatch

public java.lang.Enum<E> getMatch(java.lang.Object obj)

This method returns the match corresponding to the parameter.

Parameters:

obj -

Returns:

an Enum of class E

main

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