de.xabsl.jxabsl.parameters
Class Parameters

java.lang.Object
  extended by de.xabsl.jxabsl.parameters.Parameters
Direct Known Subclasses:
OptionParameters

public class Parameters
extends java.lang.Object

Represents the current set of parameters of a behavior or an input symbol. Parameters are referenced by integer positions. The position can be obtained by givng the parameters name


Field Summary
protected  java.util.LinkedHashMap<java.lang.String,java.lang.Integer> bool
           
protected  java.util.List<BooleanParameter> booleanParameters
           
protected  DebugMessages debug
           
protected  java.util.LinkedHashMap<java.lang.String,java.lang.Integer> decimal
           
protected  java.util.List<DecimalParameter> decimalParameters
           
protected  java.util.LinkedHashMap<java.lang.String,java.lang.Integer> enumerated
           
protected  java.util.List<EnumeratedParameter> enumeratedParameters
           
protected  java.util.List<Enumeration> enumerations
           
 
Constructor Summary
Parameters(DebugMessages debug)
           
 
Method Summary
 java.lang.String getBooleanName(int position)
          Returns the name of a boolean parameter
 int getBooleanPosition(java.lang.String name)
          Get the position of a boolean parameter.
 int getBooleanSize()
           
 java.lang.String getDecimalName(int position)
          Returns the name of a decimal parameter
 int getDecimalPosition(java.lang.String name)
          Get the position of a decimal parameter.
 int getDecimalSize()
           
 java.lang.String getEnumeratedName(int position)
          Returns the name of an enumerated parameter
 int getEnumeratedPosition(java.lang.String name)
          Get the position of an enumerated parameter.
 int getEnumeratedSize()
           
 Enumeration getEnumeration(java.lang.String parameterName)
           
 void registerBoolean(java.lang.String name, BooleanParameter parameter)
          Registers a boolean parameter with a name.
 void registerDecimal(java.lang.String name, DecimalParameter parameter)
          Registers a decimal parameter with a name.
 void registerEnumerated(java.lang.String name, Enumeration enumeration, EnumeratedParameter parameter)
          Registers an enumerated parameter with a name.
 void reset()
           
 void setBoolean(int pos, boolean value)
          Set the value of a boolean parameter
 void setDecimal(int pos, double value)
          Set the value of a decimal parameter
 void setEnumerated(int pos, java.lang.Object value)
          Set the value of an enumerated parameter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

debug

protected DebugMessages debug

decimal

protected java.util.LinkedHashMap<java.lang.String,java.lang.Integer> decimal

bool

protected java.util.LinkedHashMap<java.lang.String,java.lang.Integer> bool

enumerated

protected java.util.LinkedHashMap<java.lang.String,java.lang.Integer> enumerated

decimalParameters

protected java.util.List<DecimalParameter> decimalParameters

booleanParameters

protected java.util.List<BooleanParameter> booleanParameters

enumeratedParameters

protected java.util.List<EnumeratedParameter> enumeratedParameters

enumerations

protected java.util.List<Enumeration> enumerations
Constructor Detail

Parameters

public Parameters(DebugMessages debug)
Method Detail

registerDecimal

public void registerDecimal(java.lang.String name,
                            DecimalParameter parameter)
Registers a decimal parameter with a name.

Parameters:
name - The name of the parameter
parameter - The reference to a parameter

registerBoolean

public void registerBoolean(java.lang.String name,
                            BooleanParameter parameter)
Registers a boolean parameter with a name.

Parameters:
name - The name of the parameter
parameter - The reference to a parameter

registerEnumerated

public void registerEnumerated(java.lang.String name,
                               Enumeration enumeration,
                               EnumeratedParameter parameter)
Registers an enumerated parameter with a name.

Parameters:
name - The name of the parameter
parameter - The reference to a parameter

getDecimalSize

public int getDecimalSize()
Returns:
The number of decimal parameters

getBooleanSize

public int getBooleanSize()
Returns:
The number of boolean parameters

getEnumeratedSize

public int getEnumeratedSize()
Returns:
The number of enumerated parameters

getDecimalPosition

public int getDecimalPosition(java.lang.String name)
Get the position of a decimal parameter. The parameters value can then be set using that position

Parameters:
name - The name of the parameter
Returns:
The position of the parameter

getBooleanPosition

public int getBooleanPosition(java.lang.String name)
Get the position of a boolean parameter. The parameters value can then be set using that position

Parameters:
name - The name of the parameter
Returns:
The position of the parameter

getEnumeratedPosition

public int getEnumeratedPosition(java.lang.String name)
Get the position of an enumerated parameter. The parameters value can then be set using that position

Parameters:
name - The name of the parameter
Returns:
The position of the parameter

setDecimal

public void setDecimal(int pos,
                       double value)
Set the value of a decimal parameter

Parameters:
pos - The parameters position. Can be obtained via getDecimalPosition()
value - The parameter's value to set

setBoolean

public void setBoolean(int pos,
                       boolean value)
Set the value of a boolean parameter

Parameters:
pos - The parameters position. Can be obtained via getBooleanPosition()
value - The parameter's value to set

setEnumerated

public void setEnumerated(int pos,
                          java.lang.Object value)
Set the value of an enumerated parameter

Parameters:
pos - The parameters position. Can be obtained via getEnumeratedPosition()
value - The parameter's value to set

getBooleanName

public java.lang.String getBooleanName(int position)
Returns the name of a boolean parameter

Parameters:
position - The position of the parameter
Returns:

getDecimalName

public java.lang.String getDecimalName(int position)
Returns the name of a decimal parameter

Parameters:
position - The position of the parameter
Returns:

getEnumeratedName

public java.lang.String getEnumeratedName(int position)
Returns the name of an enumerated parameter

Parameters:
position - The position of the parameter
Returns:

getEnumeration

public Enumeration getEnumeration(java.lang.String parameterName)
Parameters:
parameterName -
Returns:
The enumeration which is the domain of the parameter
Throws:
SymbolNotRegisteredException - if the parameter was not registered

reset

public void reset()