Class GetParams

java.lang.Object
  |
  +--GetParams

class GetParams

extends java.lang.Object

This class get the argument list from the Applet or .mae startup file. Which is used depends on whether the execution instance is an Applet or not. Arguments are read from a startup file with a .mae file extension in the case of a stand-alone application. It will first set the defaults from the Config class that reads the MaExplorerConfig.txt Configuration file.

This work was produced by Peter Lemkin of the National Cancer Institute, an agency of the United States Government. As a work of the United States Government there is no associated copyright. It is offered as open source software under the Mozilla Public License (version 1.1) subject to the limitations noted in the accompanying LEGAL file. This notice must be included with the code. The MAExplorer Mozilla and Legal files are available on http://maexplorer.sourceforge.net/.

Version:

$Date: 2002/12/11 17:23:23 $ $Revision: $

Author:

P. Lemkin (NCI), G. Thornwall (SAIC), NCI-Frederick, Frederick, MD

See Also:

MAExplorer Home

Field Summary

private static MAExplorer

mae link to global MAExplorer instance

Constructor Summary

(package private)

GetParams(MAExplorer mae) GetParams() - constructor

Method Summary

(package private) java.lang.String	getConfigAndPARAMvalue(java.lang.String tag) getConfigAndPARAMvalue() - get Config then val for tag 1.
(package private) java.lang.String[]	getNumberedParamList(java.lang.String prefix) getNumberedParamList() - get a numbered parameter list The parameters are of the form: "image1", "image2", ...
(package private) java.lang.String	getParamVal(java.lang.String param) getParamVal() - get parameter from Configuration database file
(package private) java.lang.String	getSAParam(java.lang.String tag) getSAParam() - get parameter from applet or standalone application startup database Table previously read from file.
(package private) boolean	setDefParam(java.lang.String tag, boolean defaultVal) setDefParam() - set value or default if
(package private) java.awt.Color	setDefParam(java.lang.String tag, java.awt.Color defaultVal) setDefParam() - set value or default if
(package private) double	setDefParam(java.lang.String tag, double defaultVal) setDefParam() - set double value or default value if <APPLET> <PARAM NAME=tag VALUE=val>
(package private) double	setDefParam(java.lang.String tag, double defaultVal, double minVal, double maxVal) setDefParam() - set double value or default value if <APPLET> <PARAM NAME=tag VALUE=val>
(package private) float	setDefParam(java.lang.String tag, float defaultVal) setDefParam() - set floag value or default value if <APPLET> <PARAM NAME=tag VALUE=val>
(package private) float	setDefParam(java.lang.String tag, float defaultVal, float minVal, float maxVal) setDefParam() - set float value or default value if <APPLET> <PARAM NAME=tag VALUE=val>
(package private) int	setDefParam(java.lang.String tag, int defaultVal) setDefParam() - set value or default value if 1.
(package private) int	setDefParam(java.lang.String tag, int defaultVal, int minVal, int maxVal) setDefParam() - set int value or default value if <APPLET> <PARAM NAME=tag VALUE=val>
(package private) java.lang.String	setDefParam(java.lang.String tag, java.lang.String defaultVal) setDefParam() - set String value or default value if <APPLET> <PARAM NAME=tag VALUE=val>

Methods inherited from class java.lang.Object

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

Field Detail

mae

private static MAExplorer mae

link to global MAExplorer instance

Constructor Detail

GetParams

GetParams(MAExplorer mae)

GetParams() - constructor

Parameters:

mae - is instance of MAExplorer

Method Detail

getParamVal

java.lang.String getParamVal(java.lang.String param)

getParamVal() - get parameter from Configuration database file

Parameters:

param - is the parameter name to search for

Returns:

value if found, else null

See Also:

ConfigTable.getValueByName(java.lang.String)

getSAParam

java.lang.String getSAParam(java.lang.String tag)

getSAParam() - get parameter from applet or standalone application startup database Table previously read from file.

Parameters:

tag - is name of parameter to search for

Returns:

value if found, else null.

See Also:

UserState.getMAEstartupValue(java.lang.String)

getNumberedParamList

java.lang.String[] getNumberedParamList(java.lang.String prefix)

getNumberedParamList() - get a numbered parameter list The parameters are of the form: "image1", "image2", ... with integers starting at 1 appended to the right of the prefix. Return a String[0:nItems] if any elements exist, else return null

Parameters:

prefix - to serach for

Returns:

list of values if found, else null.

See Also:

getParamVal(java.lang.String)

setDefParam

boolean setDefParam(java.lang.String tag,
                    boolean defaultVal)

setDefParam() - set value or default if

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

Returns:

value if found, else defaultVal

See Also:

getParamVal(java.lang.String), getSAParam(java.lang.String)

setDefParam

java.awt.Color setDefParam(java.lang.String tag,
                           java.awt.Color defaultVal)

setDefParam() - set value or default if

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

Returns:

value if found, else defaultVal

See Also:

getParamVal(java.lang.String), getSAParam(java.lang.String)

getConfigAndPARAMvalue

java.lang.String getConfigAndPARAMvalue(java.lang.String tag)

getConfigAndPARAMvalue() - get Config then val for tag 1. First: get values from stand-alone .mae file if defined. NAME=tag VALUE=val 2. Else second: get from Applet if it exists 3. Else third: get it from the configuration file. Config/MaExplorerConfig.txt file.

Parameters:

tag - is the parameter name to search for

Returns:

value if found, else defaultVal

See Also:

getParamVal(java.lang.String), getSAParam(java.lang.String)

setDefParam

int setDefParam(java.lang.String tag,
                int defaultVal)

setDefParam() - set value or default value if 1. the default is set by final constants in .java files. 2. the first overide is set by the Config/MaExplorerConfig.txt file. 3. the final overide is set by

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

Returns:

value if found, else defaultVal

See Also:

getConfigAndPARAMvalue(java.lang.String)

setDefParam

int setDefParam(java.lang.String tag,
                int defaultVal,
                int minVal,
                int maxVal)

setDefParam() - set int value or default value if <APPLET> <PARAM NAME=tag VALUE=val> 1. the default is set by final constants in .java files. 2. the first overide is set by the Config/MaExplorerConfig.txt file. 3. the final overide is set by "APPLET PARAM NAME=tag VALUE=val"

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

minVal - is minimum allowable value

maxVal - is maximum allowable value

Returns:

value if found, else defaultVal

See Also:

setDefParam(java.lang.String, boolean)

setDefParam

float setDefParam(java.lang.String tag,
                  float defaultVal,
                  float minVal,
                  float maxVal)

setDefParam() - set float value or default value if <APPLET> <PARAM NAME=tag VALUE=val> 1. the default is set by final constants in .java files. 2. the first overide is set by the Config/MaExplorerConfig.txt file. 3. the final overide is set by "APPLET PARAM NAME=tag VALUE=val"

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

minVal - is minimum allowable value

maxVal - is maximum allowable value

Returns:

value if found, else defaultVal

See Also:

getConfigAndPARAMvalue(java.lang.String)

setDefParam

double setDefParam(java.lang.String tag,
                   double defaultVal,
                   double minVal,
                   double maxVal)

setDefParam() - set double value or default value if <APPLET> <PARAM NAME=tag VALUE=val> 1. the default is set by final constants in .java files. 2. the first overide is set by the Config/MaExplorerConfig.txt file. 3. the final overide is set by "APPLET PARAM NAME=tag VALUE=val"

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

minVal - is minimum allowable value

maxVal - is maximum allowable value

Returns:

value if found, else defaultVal

See Also:

getConfigAndPARAMvalue(java.lang.String)

setDefParam

double setDefParam(java.lang.String tag,
                   double defaultVal)

setDefParam() - set double value or default value if <APPLET> <PARAM NAME=tag VALUE=val> 1. the default is set by final constants in .java files. 2. the first overide is set by the Config/MaExplorerConfig.txt file. 3. the final overide is set by "APPLET PARAM NAME=tag VALUE=val"

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

Returns:

value if found, else defaultVal

See Also:

getConfigAndPARAMvalue(java.lang.String)

setDefParam

float setDefParam(java.lang.String tag,
                  float defaultVal)

setDefParam() - set floag value or default value if <APPLET> <PARAM NAME=tag VALUE=val> 1. the default is set by final constants in .java files. 2. the first overide is set by the Config/MaExplorerConfig.txt file. 3. the final overide is set by "APPLET PARAM NAME=tag VALUE=val"

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

Returns:

value if found, else defaultVal

See Also:

getConfigAndPARAMvalue(java.lang.String)

setDefParam

java.lang.String setDefParam(java.lang.String tag,
                             java.lang.String defaultVal)

setDefParam() - set String value or default value if <APPLET> <PARAM NAME=tag VALUE=val> 1. the default is set by final constants in .java files. 2. the first overide is set by the Config/MaExplorerConfig.txt file. 3. the final overide is set by "APPLET PARAM NAME=tag VALUE=val"

Parameters:

param - is the parameter name to search for

defaultVal - to use if not found

Returns:

value if found, else defaultVal

See Also:

getConfigAndPARAMvalue(java.lang.String)