databionics.modules
Class FloatParameter

java.lang.Object
  databionics.modules.Parameter
      databionics.modules.FloatParameter

public class FloatParameter
extends Parameter

Parameter with floating point number argument.

Field Summary

protected java.lang.Float	def default value
protected static org.apache.log4j.Logger	log log4j logging
protected java.lang.Float	max maximum value
protected java.lang.Float	min minimum value
protected java.lang.Float	value parameter value

Fields inherited from class databionics.modules.Parameter

constant, description, longName, name, optional

Constructor Summary

FloatParameter()

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
java.lang.Float	getDefault() Get the default value
java.lang.Float	getMax() Get the maximum value
java.lang.Float	getMin() Get the minimum value
java.lang.Float	getValue() Get the value or, if value is not defined, the default value
java.lang.String	getValueAsString() String representation of value.
void	setDefault(float var) Set the default value
void	setDefault(java.lang.Float var) Set the default value
void	setMax(float i) Set the maximum value
void	setMax(java.lang.Float i) Set the maximum value
void	setMin(float i) Set the minimum value
void	setMin(java.lang.Float i) Set the minimum value
void	setValue(float var) Set the value.
void	setValue(java.lang.Float var) Set the value.
void	setValue(java.lang.String var) Set the value as a string If var is less than the minimum, set the minimum instead and throw LessThanMinException to issue a warning.
java.lang.String	toString() String representation with name and value as needed for starting a tool.
java.lang.String	toXml() XML representation
static FloatParameter	valueOf(org.w3c.dom.Element el) Create a FloatParameter from an XML tag

Methods inherited from class databionics.modules.Parameter

getDescription, getLongName, getName, isConstant, isOptional, setConstant, setDescription, setLongName, setName, setOptional

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.log4j.Logger log

log4j logging

value

protected java.lang.Float value

parameter value

def

protected java.lang.Float def

default value

min

protected java.lang.Float min

minimum value

max

protected java.lang.Float max

maximum value

Constructor Detail

FloatParameter

public FloatParameter()

Method Detail

getValue

public java.lang.Float getValue()

Get the value or, if value is not defined, the default value

getValueAsString

public java.lang.String getValueAsString()

String representation of value.

Specified by:

getValueAsString in class Parameter

setValue

public void setValue(float var)
              throws LessThanMinException,
                     GreaterThanMaxException

Set the value. If var is less than the minimum, set the minimum instead and throw LessThanMinException to issue a warning. If var is greater than the maximum, set the maximum instead and throw GreaterThanMaxException to issue a warning.

Parameters:

var - new value

Throws:

LessThanMinException

GreaterThanMaxException

setValue

public void setValue(java.lang.Float var)
              throws LessThanMinException,
                     GreaterThanMaxException

Set the value. If var is less than the minimum, set the minimum instead and throw LessThanMinException to issue a warning. If var is greater than the maximum, set the maximum instead and throw GreaterThanMaxException to issue a warning.

Throws:

LessThanMinException

GreaterThanMaxException

setValue

public void setValue(java.lang.String var)
              throws java.lang.NumberFormatException,
                     LessThanMinException,
                     GreaterThanMaxException

Set the value as a string If var is less than the minimum, set the minimum instead and throw LessThanMinException to issue a warning. If var is greater than the maximum, set the maximum instead and throw GreaterThanMaxException to issue a warning.

Throws:

java.lang.NumberFormatException

LessThanMinException

GreaterThanMaxException

getDefault

public java.lang.Float getDefault()

Get the default value

getMin

public java.lang.Float getMin()

Get the minimum value

getMax

public java.lang.Float getMax()

Get the maximum value

setDefault

public void setDefault(float var)

Set the default value

setDefault

public void setDefault(java.lang.Float var)

Set the default value

setMin

public void setMin(float i)

Set the minimum value

setMin

public void setMin(java.lang.Float i)

Set the minimum value

setMax

public void setMax(float i)

Set the maximum value

setMax

public void setMax(java.lang.Float i)

Set the maximum value

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Specified by:

clone in class Parameter

toString

public java.lang.String toString()

String representation with name and value as needed for starting a tool.

Specified by:

toString in class Parameter

valueOf

public static FloatParameter valueOf(org.w3c.dom.Element el)

Create a FloatParameter from an XML tag

toXml

public java.lang.String toXml()

XML representation

Specified by:

toXml in class Parameter