org.debellor.core
Class Parameters

java.lang.Object
  org.debellor.core.Parameters

All Implemented Interfaces:

java.io.Serializable

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

Stores parameters that can be passed to a Cell object. Preserves their ordering.

Important: parameters should be accessed rarely during execution of a data processing algorithm, because this access may be slow. If you implement a parameterized algorithm, you should preferably read all parameters at the beginning of your algorithm and store them in your custom structures or variables for fast access.

Author:

Marcin Wojnarski

See Also:

Cell, Serialized Form

Nested Class Summary

static class

Parameters.Entry

Constructor Summary

Parameters()

Method Summary

void	clear() Clears the content of this Parameters instance, so that no parameters are defined afterwards.
Parameters	copy() Returns deep copy of this object
boolean	exists(java.lang.String name) Checks whether a given parameter is present.
java.lang.String	get(java.lang.String name) Returns value of the parameter.
boolean	getAsBool(java.lang.String name)
byte	getAsByte(java.lang.String name)
double	getAsDouble(java.lang.String name)
float	getAsFloat(java.lang.String name)
int	getAsInt(java.lang.String name)
long	getAsLong(java.lang.String name)
short	getAsShort(java.lang.String name)
java.lang.String	getAsString(java.lang.String name)
Parameters.Entry	getEntry(int index) Returns Parameters.Entry present at specified position in parameter list.
java.lang.String	getName(int index) Returns name of the parameter at specified position in parameter list.
int	indexOf(java.lang.String name) Returns index of the first occurrence of parameter name or -1 if does not exist.
void	set(java.lang.String name, boolean b) Sets value of the parameter to string representation of boolean b.
void	set(java.lang.String name, double x) Sets value of the parameter to string representation of real number x.
void	set(java.lang.String name, int k) Sets value of the parameter to string representation of integer k.
void	set(java.lang.String name, java.lang.String value) Sets value of the parameter name to a given string value.
int	size() Returns the number of defined parameters.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters()

Method Detail

size

public int size()

Returns the number of defined parameters.

clear

public void clear()

Clears the content of this Parameters instance, so that no parameters are defined afterwards.

copy

public Parameters copy()

Returns deep copy of this object

set

public void set(java.lang.String name,
                java.lang.String value)

Sets value of the parameter name to a given string value. If name is null, does nothing. Note that String is a canonical representation of parameter values and all other types of values, passed to other variants of method set, are internally converted and stored as Strings.

set

public void set(java.lang.String name,
                int k)

Sets value of the parameter to string representation of integer k.

set

public void set(java.lang.String name,
                double x)

Sets value of the parameter to string representation of real number x. Caution: x is a real value and its conversion to String may introduce rounding errors, so the value decoded later on may slightly differ from the value passed to this method.

set

public void set(java.lang.String name,
                boolean b)

Sets value of the parameter to string representation of boolean b.

indexOf

public int indexOf(java.lang.String name)

Returns index of the first occurrence of parameter name or -1 if does not exist.

exists

public boolean exists(java.lang.String name)

Checks whether a given parameter is present.

Parameters:

name - Name of the parameter

Returns:

true if the parameter is present

get

public final java.lang.String get(java.lang.String name)
                           throws ParameterUndefinedException

Returns value of the parameter.

Throws:

ParameterUndefinedException - if the parameter is not present

getEntry

public Parameters.Entry getEntry(int index)

Returns Parameters.Entry present at specified position in parameter list.

Parameters:

index - Index of the parameter in the list.

getName

public java.lang.String getName(int index)

Returns name of the parameter at specified position in parameter list.

Parameters:

index - Index of the parameter in the list.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAsString

public java.lang.String getAsString(java.lang.String name)
                             throws ParameterUndefinedException

Throws:

ParameterUndefinedException

getAsInt

public int getAsInt(java.lang.String name)
             throws ParameterUndefinedException,
                    ParameterConversionException

Throws:

ParameterUndefinedException

ParameterConversionException

getAsByte

public byte getAsByte(java.lang.String name)
               throws ParameterUndefinedException,
                      ParameterConversionException

Throws:

ParameterUndefinedException

ParameterConversionException

getAsShort

public short getAsShort(java.lang.String name)
                 throws ParameterUndefinedException,
                        ParameterConversionException

Throws:

ParameterUndefinedException

ParameterConversionException

getAsLong

public long getAsLong(java.lang.String name)
               throws ParameterUndefinedException,
                      ParameterConversionException

Throws:

ParameterUndefinedException

ParameterConversionException

getAsDouble

public double getAsDouble(java.lang.String name)
                   throws ParameterUndefinedException,
                          ParameterConversionException

Throws:

ParameterUndefinedException

ParameterConversionException

getAsFloat

public float getAsFloat(java.lang.String name)
                 throws ParameterUndefinedException,
                        ParameterConversionException

Throws:

ParameterUndefinedException

ParameterConversionException

getAsBool

public boolean getAsBool(java.lang.String name)
                  throws ParameterUndefinedException,
                         ParameterConversionException

Throws:

ParameterUndefinedException

ParameterConversionException