hydra

Class ConfigHashtable

java.lang.Object

hydra.ConfigHashtable

All Implemented Interfaces:

java.io.Serializable

public class ConfigHashtable
extends java.lang.Object
implements java.io.Serializable

Manages a HashMap used for storing hydra configuration settings. This class provides routines for retrieving string, int, long, and double representations of parameter values.

Note that if one of the "at" methods is invoked, but no value has been specified for the configuration parameter, a HydraConfigException is thrown.

See Also:

TestConfig.tab(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigHashtable()

Method Summary

Modifier and Type	Method and Description
boolean	booleanAt(java.lang.Long key) Returns the string at key as a boolean.
boolean	booleanAt(java.lang.Long key, boolean defaultVal)
boolean	booleanAtWild(java.lang.Long key, int i, java.lang.Boolean defaultVal) Return the ith boolean of a vector parameter.
static boolean	booleanFor(java.lang.Object val, GsRandom rand, java.lang.Long key)
double	doubleAt(java.lang.Long key) Returns the double value of the Double at key.
double	doubleAt(java.lang.Long key, double defaultVal)
double	doubleAtWild(java.lang.Long key, int i, double defaultVal) Return the ith double of a vector parameter.
static double	doubleFor(java.lang.Object val, GsRandom rand, java.lang.Long key)
java.lang.Object	get(java.lang.Long key) Return the parameter with the given key or null if there isn't one.
java.lang.Object	get(java.lang.Long key, int i, java.lang.Object defaultVal) Return the ith element of a vector parameter, or the default if it's not there.
java.lang.Object	get(java.lang.Long key, java.lang.Object defaultVal) Return the parameter with the given key or the default if there isn't one.
java.lang.Boolean	getBoolean(java.lang.Long key, java.lang.Object val) Returns a Boolean from the object, null if it is the default string.
java.lang.Double	getDouble(java.lang.Long key, java.lang.Object val) Returns a Double from the object, null if it is the default string.
java.lang.Integer	getInteger(java.lang.Long key, java.lang.Object val) Returns an Integer from the object, null if it is the default string.
java.lang.Long	getLong(java.lang.Long key, java.lang.Object val) Returns a Long from the object, null if it is the default string.
protected java.lang.String	getPath(java.lang.Long key, java.lang.Object val) Returns a path from the object, null if it is the default string.
GsRandom	getRandGen() Returns the random number generator associated with this instance of ConfigHashtable.
java.lang.String	getString(java.lang.Long key, java.lang.Object val) Returns a String from the object, null if it is the default string.
java.util.Vector	getVector(java.lang.Long key, java.lang.Object val) Returns a Vector from the object, null if it is the default string.
java.lang.Object	getWild(java.lang.Long key, int i, java.lang.Object defaultVal) Return the ith element of a hydra vector parameter.
static java.lang.Object	getWild(java.util.Vector v, int i, java.lang.Object defaultVal)
int	intAt(java.lang.Long key) Returns the int value of key.
int	intAt(java.lang.Long key, int defaultVal)
int	intAtWild(java.lang.Long key, int i, int defaultVal) Return the ith int of a vector parameter.
static int	intFor(java.lang.Object val, GsRandom rand, java.lang.Long key)
long	longAt(java.lang.Long key) Returns the long value of the Double at key.
long	longAt(java.lang.Long key, long defaultVal)
long	longAtWild(java.lang.Long key, int i, long defaultVal) Return the ith long of a vector parameter.
static long	longFor(java.lang.Object val, GsRandom rand, java.lang.Long key)
java.lang.String	pathAt(java.lang.Long key) Returns the path stored at key.
java.lang.String	pathAt(java.lang.Long key, int i, java.lang.String defaultVal) Return the ith element of a vector parameter as a path, or default if null.
java.lang.String	pathAt(java.lang.Long key, java.lang.String defaultVal)
java.lang.String	pathAtWild(java.lang.Long key, int i, java.lang.String defaultVal) Return the ith path of a vector parameter.
static java.lang.String	pathFor(java.lang.Object val, GsRandom rand, java.lang.Long key)
void	put(java.lang.Long key, java.lang.Object val) Put an object in the table if it isn't null.
int	size()
java.lang.String	stringAt(java.lang.Long key) Returns the String stored at key.
java.lang.String	stringAt(java.lang.Long key, int i, java.lang.String defaultVal) Return the ith element of a vector parameter as a String, or default if null.
java.lang.String	stringAt(java.lang.Long key, java.lang.String defaultVal)
java.lang.String	stringAtWild(java.lang.Long key, int i, java.lang.String defaultVal) Return the ith string of a vector parameter.
static java.lang.String	stringFor(java.lang.Object val, GsRandom rand, java.lang.Long key)
java.util.SortedMap	toSortedMap()
protected java.util.SortedMap	toSortedMap(boolean forLatestConf)
java.lang.String	toString()
HydraVector	vecAt(java.lang.Long key) Returns the HydraVector stored at key.
HydraVector	vecAt(java.lang.Long key, HydraVector defaultVal)
HydraVector	vecAt(java.lang.Long key, int i, HydraVector defaultVal) Return the ith element of a vector of vectors parameter as a HydraVector, or default if null.
HydraVector	vecAtWild(java.lang.Long key, int i, HydraVector defaultVal) Return the ith vector of a vector of vectors parameter.
static HydraVector	vecFor(java.lang.Object val)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigHashtable

public ConfigHashtable()

Method Detail

size

public int size()

intAt

public int intAt(java.lang.Long key)

Returns the int value of key.

intAt

public int intAt(java.lang.Long key,
                 int defaultVal)

intFor

public static int intFor(java.lang.Object val,
                         GsRandom rand,
                         java.lang.Long key)

intAtWild

public int intAtWild(java.lang.Long key,
                     int i,
                     int defaultVal)

Return the ith int of a vector parameter. If none is specified, try previous elements, from i-1 down to 0, using the first that isn't null. If they are all null, use the provided default value.

longAt

public long longAt(java.lang.Long key)

Returns the long value of the Double at key.

longAt

public long longAt(java.lang.Long key,
                   long defaultVal)

longFor

public static long longFor(java.lang.Object val,
                           GsRandom rand,
                           java.lang.Long key)

longAtWild

public long longAtWild(java.lang.Long key,
                       int i,
                       long defaultVal)

Return the ith long of a vector parameter. If none is specified, try previous elements, from i-1 down to 0, using the first that isn't null. If they are all null, use the provided default value.

doubleAt

public double doubleAt(java.lang.Long key)

Returns the double value of the Double at key.

doubleAt

public double doubleAt(java.lang.Long key,
                       double defaultVal)

doubleFor

public static double doubleFor(java.lang.Object val,
                               GsRandom rand,
                               java.lang.Long key)

doubleAtWild

public double doubleAtWild(java.lang.Long key,
                           int i,
                           double defaultVal)

Return the ith double of a vector parameter. If none is specified, try previous elements, from i-1 down to 0, using the first that isn't null. If they are all null, use the provided default value.

booleanAt

public boolean booleanAt(java.lang.Long key)

Returns the string at key as a boolean.

booleanAt

public boolean booleanAt(java.lang.Long key,
                         boolean defaultVal)

booleanFor

public static boolean booleanFor(java.lang.Object val,
                                 GsRandom rand,
                                 java.lang.Long key)

booleanAtWild

public boolean booleanAtWild(java.lang.Long key,
                             int i,
                             java.lang.Boolean defaultVal)

Return the ith boolean of a vector parameter. If none is specified, try previous elements, from i-1 down to 0, using the first that isn't null. If they are all null, use the provided default value.

stringAt

public java.lang.String stringAt(java.lang.Long key)

Returns the String stored at key.

stringAt

public java.lang.String stringAt(java.lang.Long key,
                                 java.lang.String defaultVal)

stringFor

public static java.lang.String stringFor(java.lang.Object val,
                                         GsRandom rand,
                                         java.lang.Long key)

stringAt

public java.lang.String stringAt(java.lang.Long key,
                                 int i,
                                 java.lang.String defaultVal)

Return the ith element of a vector parameter as a String, or default if null.

stringAtWild

public java.lang.String stringAtWild(java.lang.Long key,
                                     int i,
                                     java.lang.String defaultVal)

Return the ith string of a vector parameter. If none is specified, try previous elements, from i-1 down to 0, using the first that isn't null. If they are all null, use the provided default value (which can be null).

pathAt

public java.lang.String pathAt(java.lang.Long key)

Returns the path stored at key.

pathAt

public java.lang.String pathAt(java.lang.Long key,
                               java.lang.String defaultVal)

pathFor

public static java.lang.String pathFor(java.lang.Object val,
                                       GsRandom rand,
                                       java.lang.Long key)

pathAt

public java.lang.String pathAt(java.lang.Long key,
                               int i,
                               java.lang.String defaultVal)

Return the ith element of a vector parameter as a path, or default if null.

pathAtWild

public java.lang.String pathAtWild(java.lang.Long key,
                                   int i,
                                   java.lang.String defaultVal)

Return the ith path of a vector parameter. If none is specified, try previous elements, from i-1 down to 0, using the first that isn't null. If they are all null, use the provided default value (which can be null).

vecAt

public HydraVector vecAt(java.lang.Long key)

Returns the HydraVector stored at key. If the value is not a HydraVector, it creates one.

vecAt

public HydraVector vecAt(java.lang.Long key,
                         HydraVector defaultVal)

vecAt

public HydraVector vecAt(java.lang.Long key,
                         int i,
                         HydraVector defaultVal)

Return the ith element of a vector of vectors parameter as a HydraVector, or default if null. If the ith value is not a HydraVector, it creates one.

vecAtWild

public HydraVector vecAtWild(java.lang.Long key,
                             int i,
                             HydraVector defaultVal)

Return the ith vector of a vector of vectors parameter. If none is specified, try previous elements, from i-1 down to 0, using the first that isn't null. If they are all null, use the provided default value (which can be null).

vecFor

public static HydraVector vecFor(java.lang.Object val)

get

public java.lang.Object get(java.lang.Long key)

Return the parameter with the given key or null if there isn't one.

get

public java.lang.Object get(java.lang.Long key,
                            java.lang.Object defaultVal)

Return the parameter with the given key or the default if there isn't one.

get

public java.lang.Object get(java.lang.Long key,
                            int i,
                            java.lang.Object defaultVal)

Return the ith element of a vector parameter, or the default if it's not there.

getWild

public java.lang.Object getWild(java.lang.Long key,
                                int i,
                                java.lang.Object defaultVal)

Return the ith element of a hydra vector parameter. If none is specified, try previous elements, from i-1 down to 0, using the first that isn't null. If they are all null, use the provided default value. If the parameter is not a vector, just return the value, if it exists.

getWild

public static java.lang.Object getWild(java.util.Vector v,
                                       int i,
                                       java.lang.Object defaultVal)

getBoolean

public java.lang.Boolean getBoolean(java.lang.Long key,
                                    java.lang.Object val)

Returns a Boolean from the object, null if it is the default string. Handles OneOf, Range, RobinG, etc.

Throws:

HydraTypeException - if the object is an illegal type.

getDouble

public java.lang.Double getDouble(java.lang.Long key,
                                  java.lang.Object val)

Returns a Double from the object, null if it is the default string. Handles OneOf, Range, RobinG, etc.

Throws:

HydraTypeException - if the object is an illegal type.

getInteger

public java.lang.Integer getInteger(java.lang.Long key,
                                    java.lang.Object val)

Returns an Integer from the object, null if it is the default string. Handles OneOf, Range, RobinG, etc.

Throws:

HydraTypeException - if the object is an illegal type.

getLong

public java.lang.Long getLong(java.lang.Long key,
                              java.lang.Object val)

Returns a Long from the object, null if it is the default string. Handles OneOf, Range, RobinG, etc.

Throws:

HydraTypeException - if the object is an illegal type.

getString

public java.lang.String getString(java.lang.Long key,
                                  java.lang.Object val)

Returns a String from the object, null if it is the default string. Handles OneOf, Range, RobinG, etc.

Throws:

HydraTypeException - if the object is an illegal type.

getVector

public java.util.Vector getVector(java.lang.Long key,
                                  java.lang.Object val)

Returns a Vector from the object, null if it is the default string.

Throws:

HydraTypeException - if the object is an illegal type.

getPath

protected java.lang.String getPath(java.lang.Long key,
                                   java.lang.Object val)

Returns a path from the object, null if it is the default string. Handles OneOf, RobinG, etc.

Throws:

HydraTypeException - if the object is an illegal type.

put

public void put(java.lang.Long key,
                java.lang.Object val)

Put an object in the table if it isn't null.

getRandGen

public GsRandom getRandGen()

Returns the random number generator associated with this instance of ConfigHashtable. It is also used by instances of HydraVector stored in this table. It is used to compute values for "range" and "oneof". The seed is obtained from Prms.randomSeed if it exists. Otherwise the seed is System.currentTimeMillis().

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toSortedMap

public java.util.SortedMap toSortedMap()

toSortedMap

protected java.util.SortedMap toSortedMap(boolean forLatestConf)