de.hawhamburg.reachability.ui.frame.simulation.resource

Class SimulationParameter

java.lang.Object

de.hawhamburg.reachability.ui.frame.simulation.resource.SimulationParameter

public class SimulationParameter
extends java.lang.Object

Data object which represents a simulation parameter for display within a start simulation user interface.

Objects of this class are each representing a single parameter within a start simulation user interface. They provide other display names, default values and field types to simplify the rendering process.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	defaultValue The default value of this parameter as String.
private java.lang.String	display The text as String that shall be displayed as name to the user.
private FieldType	fieldType The FieldType which describes, how the formula field of this parameter shall be rendered.
private java.lang.String	name The parameters name as String.

Constructor Summary

Constructors

Constructor and Description
SimulationParameter(java.lang.String nameIn, java.lang.String displayIn, FieldType fieldTypeIn, java.lang.String defaultValueIn) Initializes a new SimulationParameter object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDefaultValue() Returns the parameters default value as String.
java.lang.String	getDisplay() Returns the parameters display name as String.
FieldType	getFieldType() Returns the parameters field type as FieldType.
java.lang.String	getName() Returns the parameters name as String.

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

The parameters name as String.

display

private java.lang.String display

The text as String that shall be displayed as name to the user.

fieldType

private FieldType fieldType

The FieldType which describes, how the formula field of this parameter shall be rendered.

defaultValue

private java.lang.String defaultValue

The default value of this parameter as String.

Constructor Detail

SimulationParameter

public SimulationParameter(java.lang.String nameIn,
                   java.lang.String displayIn,
                   FieldType fieldTypeIn,
                   java.lang.String defaultValueIn)

Initializes a new SimulationParameter object.

Parameters:

nameIn - The parameters name as String.

displayIn - The text as String that shall be displayed as name to the user.

fieldTypeIn - The FieldType which describes how the formula field for this parameter shall be rendered.

defaultValueIn - The default value of this parameter as String.

Method Detail

getName

public final java.lang.String getName()

Returns the parameters name as String.

Returns:

The parameters name as String.

getDisplay

public final java.lang.String getDisplay()

Returns the parameters display name as String.

Returns:

The parameters display name as String.

getFieldType

public final FieldType getFieldType()

Returns the parameters field type as FieldType.

Returns:

The parameters field type as FieldType.

getDefaultValue

public final java.lang.String getDefaultValue()

Returns the parameters default value as String.

Returns:

The parameters default name as String.