jas.io
Class ParameterField

java.lang.Object
  jas.io.ParameterField

All Implemented Interfaces:

java.lang.Comparable

public class ParameterField
extends java.lang.Object
implements java.lang.Comparable

An object representing a parameter, with its own type, a short description and the min-max range when it is bounded.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Field Summary

static int	TYPE_BOOLEAN A boolean field.
static int	TYPE_BROWSE An string field representing a file path, used to browse the file system.
static int	TYPE_CHOOSER A closed choose field.
static int	TYPE_DBL A double field.
static int	TYPE_FLOAT A float field.
static int	TYPE_INT An integer field.
static int	TYPE_LONG A long field.
static int	TYPE_SLIDER An integer field, edited by a slider control.
static int	TYPE_STRING A string field.

Constructor Summary

ParameterField(ParameterField field)
Construct a new parameter as a copy of another one.

ParameterField(java.lang.String parameterName, double min, double max)
Construct a new TYPE_DBL parameter field with bounded interval.

ParameterField(java.lang.String parameterName, float min, float max)
Construct a new TYPE_FLOAT parameter field with bounded interval.

ParameterField(java.lang.String parameterName, int parameterType)
Construct a new parameter field.

ParameterField(java.lang.String parameterName, int min, int max)
Construct a new TYPE_INT parameter field with bounded interval.

ParameterField(java.lang.String parameterName, long min, long max)
Construct a new TYPE_LONG parameter field with bounded interval.

Method Summary

void	addChooserValue(java.lang.String value) Add a choose to the list of chooses for a TYPE_CHOOSER field.
int	compareTo(java.lang.Object o)
boolean	equals(java.lang.Object o) Test if paramter has the same name and the same value.
boolean	getBool() Return the current value for a TYPE_BOOLEAN field.
java.lang.String	getChoose() Return the current choose for a TYPE_CHOOSER field.
int	getChooseIndex() Return the current index value for a TYPE_CHOOSER field.
java.util.List	getChooseList() Return the list of chooses for a TYPE_CHOOSER field.
double	getDbl() Return the current value for a TYPE_DBL field.
java.lang.String	getDescription() Return the current description attribute of the field.
float	getFloat() Return the current value for a TYPE_FLOAT field.
int	getInt() Return the current value for a TYPE_INT, TYPE_CHOOSER or TYPE_CHOOSER field.
long	getLong() Return the current value for a TYPE_LONG field.
java.lang.Object	getMaxValue() Return the maximum accepted value.
java.lang.Object	getMinValue() Return the minimum accepted value.
java.lang.String	getName() Return the name of the field.
java.lang.Integer	getOrder()
java.lang.String	getStr() Return the current value for a TYPE_STRING field.
int	getType() Return the type of the field.
static int	getTypeValue(java.lang.String name) Return the constant value corresponding with its string description.
java.lang.Object	getValue() Return the current value of the field.
void	increaseOrder(int value)
void	set(java.lang.Object value) Set the current value of the field.
void	setBool(boolean value) Set the current value for a TYPE_BOOLEAN field.
void	setChoose(int value) Set the current value for a TYPE_CHOOSER field.
void	setChoose(java.lang.String value) Set the current value for a TYPE_CHOOSER field.
void	setChooserValues(java.lang.String[] values) Set the list of chooses for a TYPE_CHOOSER field.
boolean	setDbl(double value) Set the current value for a TYPE_DBL field.
void	setDescription(java.lang.String description) Set the description attribute to the field.
boolean	setFloat(float value) Set the current value for a TYPE_FLOAT field.
boolean	setInt(int value) Set the current value for a TYPE_INT, TYPE_CHOOSER or TYPE_CHOOSER field.
boolean	setLong(long value) Set the current value for a TYPE_LONG field.
void	setMinMaxValues(java.lang.Object min, java.lang.Object max) Set the bounds for the interval of the field.
void	setOrder(int order)
void	setStr(java.lang.String value) Set the current value for a TYPE_STRING field.
static java.lang.String[]	supportedTypes() A list of strings describing the types supported by the class.
java.lang.String	toString() Return a string describing parameter.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

A boolean field. Displayed with a check box.

See Also:

Constant Field Values

TYPE_BROWSE

public static final int TYPE_BROWSE

An string field representing a file path, used to browse the file system.

See Also:

Constant Field Values

TYPE_CHOOSER

public static final int TYPE_CHOOSER

A closed choose field. Displayed with a combo box.

See Also:

Constant Field Values

TYPE_DBL

public static final int TYPE_DBL

A double field.

See Also:

Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT

A float field.

See Also:

Constant Field Values

TYPE_INT

public static final int TYPE_INT

An integer field.

See Also:

Constant Field Values

TYPE_LONG

public static final int TYPE_LONG

A long field.

See Also:

Constant Field Values

TYPE_SLIDER

public static final int TYPE_SLIDER

An integer field, edited by a slider control.

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

A string field.

See Also:

Constant Field Values

Constructor Detail

ParameterField

public ParameterField(ParameterField field)

Construct a new parameter as a copy of another one.

Parameters:

field - The existing field to be copied.

ParameterField

public ParameterField(java.lang.String parameterName,
                      double min,
                      double max)

Construct a new TYPE_DBL parameter field with bounded interval.

Parameters:

parameterName - The name of the field.

min - The minimum value accepted.

max - The maximum value accepted.

ParameterField

public ParameterField(java.lang.String parameterName,
                      float min,
                      float max)

Construct a new TYPE_FLOAT parameter field with bounded interval.

Parameters:

parameterName - The name of the field.

min - The minimum value accepted.

max - The maximum value accepted.

ParameterField

public ParameterField(java.lang.String parameterName,
                      int parameterType)

Construct a new parameter field.

Parameters:

parameterName - The name of the field.

parameterType - The type of the field. One of the TYPE_ constants.

ParameterField

public ParameterField(java.lang.String parameterName,
                      int min,
                      int max)

Construct a new TYPE_INT parameter field with bounded interval.

Parameters:

parameterName - The name of the field.

min - The minimum value accepted.

max - The maximum value accepted.

ParameterField

public ParameterField(java.lang.String parameterName,
                      long min,
                      long max)

Construct a new TYPE_LONG parameter field with bounded interval.

Parameters:

parameterName - The name of the field.

min - The minimum value accepted.

max - The maximum value accepted.

Method Detail

addChooserValue

public void addChooserValue(java.lang.String value)

Add a choose to the list of chooses for a TYPE_CHOOSER field.

Parameters:

value - The item to be added.

Throws:

java.lang.ClassCastException - if the type is not compatible.

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

equals

public boolean equals(java.lang.Object o)

Test if paramter has the same name and the same value.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to be compared.

Returns:

True if objects have the same name and content.

getBool

public boolean getBool()

Return the current value for a TYPE_BOOLEAN field.

Returns:

The current boolean value.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getChoose

public java.lang.String getChoose()

Return the current choose for a TYPE_CHOOSER field.

Returns:

The current choose.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getChooseIndex

public int getChooseIndex()

Return the current index value for a TYPE_CHOOSER field.

Returns:

The index of the current choose.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getChooseList

public java.util.List getChooseList()

Return the list of chooses for a TYPE_CHOOSER field.

Returns:

The list of allowded chooses.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getDbl

public double getDbl()

Return the current value for a TYPE_DBL field.

Returns:

The current double value.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getDescription

public java.lang.String getDescription()

Return the current description attribute of the field.

Returns:

The current description.

getFloat

public float getFloat()

Return the current value for a TYPE_FLOAT field.

Returns:

The current float value.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getInt

public int getInt()

Return the current value for a TYPE_INT, TYPE_CHOOSER or TYPE_CHOOSER field.

Returns:

The current integer value.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getLong

public long getLong()

Return the current value for a TYPE_LONG field.

Returns:

The current long value.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getMaxValue

public java.lang.Object getMaxValue()

Return the maximum accepted value.

Returns:

An object containing the maximum. The class type is the wrapper class according to the type of the field.

getMinValue

public java.lang.Object getMinValue()

Return the minimum accepted value.

Returns:

An object containing the minimum. The class type is the wrapper class according to the type of the field.

getName

public java.lang.String getName()

Return the name of the field.

Returns:

The name attribute.

getOrder

public java.lang.Integer getOrder()

getStr

public java.lang.String getStr()

Return the current value for a TYPE_STRING field.

Returns:

The current String value.

Throws:

java.lang.ClassCastException - if the type is not compatible.

getType

public int getType()

Return the type of the field.

Returns:

The constant value representing type.

getTypeValue

public static int getTypeValue(java.lang.String name)

Return the constant value corresponding with its string description.
For instance getTypeValue("Integer") returns the TYPE_INT constant value.

Parameters:

name - The string representing one of the supported types.

Returns:

The constant value for the given type.

getValue

public java.lang.Object getValue()

Return the current value of the field.

Returns:

An object containing the current value. The class type is the wrapper class according to the type of the field.

increaseOrder

public void increaseOrder(int value)

set

public void set(java.lang.Object value)

Set the current value of the field.

Parameters:

value - An object containing the current value to be set. The class type must be the wrapper class according to the type of the field or a right formatted string.

setBool

public void setBool(boolean value)

Set the current value for a TYPE_BOOLEAN field.

Parameters:

value - A boolean value.

Throws:

java.lang.ClassCastException - if the type is not compatible.

setChoose

public void setChoose(int value)

Set the current value for a TYPE_CHOOSER field.

Parameters:

value - The index of the list of chooses.

Throws:

java.lang.ClassCastException - if the type is not compatible.

setChoose

public void setChoose(java.lang.String value)

Set the current value for a TYPE_CHOOSER field.

Parameters:

value - The string corresponding to one of the list of chooses.

Throws:

java.lang.ClassCastException - if the type is not compatible.

setChooserValues

public void setChooserValues(java.lang.String[] values)

Set the list of chooses for a TYPE_CHOOSER field.

Parameters:

values - A list of allowded chooses.

Throws:

java.lang.ClassCastException - if the type is not compatible.

setDbl

public boolean setDbl(double value)

Set the current value for a TYPE_DBL field.

Parameters:

value - A double value.

Returns:

True if value has been modified. If the given value is out of bounds it is not updated and the method returns false.

Throws:

java.lang.ClassCastException - if the type is not compatible.

setDescription

public void setDescription(java.lang.String description)

Set the description attribute to the field.

Parameters:

description - A short description for the field.

setFloat

public boolean setFloat(float value)

Set the current value for a TYPE_FLOAT field.

Parameters:

value - A float value.

Returns:

True if value has been modified. If the given value is out of bounds it is not updated and the method returns false.

Throws:

java.lang.ClassCastException - if the type is not compatible.

setInt

public boolean setInt(int value)

Set the current value for a TYPE_INT, TYPE_CHOOSER or TYPE_CHOOSER field.

Parameters:

value - An integer value.

Returns:

True if value has been modified. If the given value is out of bounds it is not updated and the method returns false.

Throws:

java.lang.ClassCastException - if the type is not compatible.

setLong

public boolean setLong(long value)

Set the current value for a TYPE_LONG field.

Parameters:

value - A long value.

Returns:

True if value has been modified. If the given value is out of bounds it is not updated and the method returns false.

Throws:

java.lang.ClassCastException - if the type is not compatible.

setMinMaxValues

public void setMinMaxValues(java.lang.Object min,
                            java.lang.Object max)

Set the bounds for the interval of the field.

Parameters:

min - An object representing the minimum accepted value.

max - An object representing the maximum accepted value.

setOrder

public void setOrder(int order)

setStr

public void setStr(java.lang.String value)

Set the current value for a TYPE_STRING field.

Parameters:

value - A String value.

Throws:

java.lang.ClassCastException - if the type is not compatible.

supportedTypes

public static java.lang.String[] supportedTypes()

A list of strings describing the types supported by the class.

Returns:

an array of String like {"Boolean", "Chooser", "Integer", ...}.

toString

public java.lang.String toString()

Return a string describing parameter.

Overrides:

toString in class java.lang.Object

Returns:

The output format is name = current value.