com.net2plan.utils

Class InputParameter

java.lang.Object

com.net2plan.utils.InputParameter

public class InputParameter
extends Object

This class helps to define input parameters for algorithms and reports. By using this class it is possible to:

• Define each parameter as an InputParameter, specifying its default value, description, and potentially valid values (e.g non-negativity). Also, the parameter type will be defined (int, double, String, boolean, ...)
• By calling the method initializeAllInputParameterFieldsOfObject, all the fields in the current class of the type InputParameter are initialized from the values from a Map<String,String> map. The checks on the input parameter ranges are checked. Java reflection is used for this.
• The algorithm can use return InputParameter.getInformationAllInputParameterFieldsOfObject(this); inside its method getParameters, to return all the information of all the fields in the class of the type InputParameter. Again, this class uses Java reflection internally.

To recuperate the value assigned to an input parameter: use the methods getXXX

Author:

Pablo Pavon-Marino

Constructor Summary

Constructors

Constructor and Description
InputParameter(String memberName, boolean defaultValue, String description)
InputParameter(String memberName, double defaultValue, String par_description)
InputParameter(String memberName, double defaultValue, String description, double lowerLimitAcceptableValues, boolean lowerLimitIncluded, double upperLimitAcceptableValues, boolean upperLimitIncluded)
InputParameter(String memberName, int defaultValue, String description)
InputParameter(String memberName, int defaultValue, String description, int lowerLimitAcceptableValues, int upperLimitAcceptableValues)
InputParameter(String memberName, long defaultValue, String description)
InputParameter(String memberName, long defaultValue, String description, long lowerLimitAcceptableValues, long upperLimitAcceptableValues)
InputParameter(String memberName, String defaultValue, String description)

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	createMapFromInputParameters(InputParameter[] params)
boolean	getBoolean()
static List<Map<String,String>>	getCartesianProductOfParameters(Map<String,List<String>> paramKeyValues) Receives a map which assigns for each parameter name, a set of possible values, and returns a list with the cartesian product of all the maps combining the different parameter values
static Map<String,String>	getDefaultParameters(List<Triple<String,String,String>> paramDescriptions) Returns the map with the default parameters of the parameter description given.
double	getDouble()
Triple<String,String,String>	getInfo()
static List<Triple<String,String,String>>	getInformationAllInputParameterFieldsOfObject(Object o)
static List<Triple<String,String,String>>	getInformationAllInputParameterFieldsOfObject(Object o, String className)
int	getInt()
Long	getLong()
String	getRunnable_classname()
String	getRunnable_file()
String	getRunnable_parameters()
String	getString()
void	initialize(boolean val)
void	initialize(double val)
void	initialize(int val)
void	initialize(long val)
void	initialize(String val)
void	initialize(String file, String classname, String parameters)
static void	initializeAllInputParameterFieldsOfObject(Object o, Map<String,String> params)
static void	initializeAllInputParameterFieldsOfObject(Object o, String className, Map<String,String> params)
void	initializeFromMap(Map<String,String> map)
boolean	isWithinAcceptableRange()
static void	main(String[] args)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InputParameter

public InputParameter(String memberName,
                      boolean defaultValue,
                      String description)

InputParameter

public InputParameter(String memberName,
                      double defaultValue,
                      String par_description)

InputParameter

public InputParameter(String memberName,
                      double defaultValue,
                      String description,
                      double lowerLimitAcceptableValues,
                      boolean lowerLimitIncluded,
                      double upperLimitAcceptableValues,
                      boolean upperLimitIncluded)

InputParameter

public InputParameter(String memberName,
                      int defaultValue,
                      String description)

InputParameter

public InputParameter(String memberName,
                      int defaultValue,
                      String description,
                      int lowerLimitAcceptableValues,
                      int upperLimitAcceptableValues)

InputParameter

public InputParameter(String memberName,
                      long defaultValue,
                      String description)

InputParameter

public InputParameter(String memberName,
                      long defaultValue,
                      String description,
                      long lowerLimitAcceptableValues,
                      long upperLimitAcceptableValues)

InputParameter

public InputParameter(String memberName,
                      String defaultValue,
                      String description)

Method Detail

createMapFromInputParameters

public static Map<String,String> createMapFromInputParameters(InputParameter[] params)

getBoolean

public boolean getBoolean()

getCartesianProductOfParameters

public static List<Map<String,String>> getCartesianProductOfParameters(Map<String,List<String>> paramKeyValues)

Receives a map which assigns for each parameter name, a set of possible values, and returns a list with the cartesian product of all the maps combining the different parameter values

Parameters:

paramKeyValues - the input param-key values

Returns:

see above

getDefaultParameters

public static Map<String,String> getDefaultParameters(List<Triple<String,String,String>> paramDescriptions)

Returns the map with the default parameters of the parameter description given. For those default descriptions starting with character '#' (e.g. #select# 1 2 3), we return the first element after the second '#', trimmed without spaces (e.g. '2' in the previous example)

Parameters:

paramDescriptions - param name, param default, param description

Returns:

see above

getDouble

public double getDouble()

getInfo

public Triple<String,String,String> getInfo()

getInformationAllInputParameterFieldsOfObject

public static List<Triple<String,String,String>> getInformationAllInputParameterFieldsOfObject(Object o)

getInformationAllInputParameterFieldsOfObject

public static List<Triple<String,String,String>> getInformationAllInputParameterFieldsOfObject(Object o,
                                                                                               String className)

getInt

public int getInt()

getLong

public Long getLong()

getRunnable_classname

public String getRunnable_classname()

getRunnable_file

public String getRunnable_file()

getRunnable_parameters

public String getRunnable_parameters()

getString

public String getString()

initialize

public void initialize(boolean val)

initialize

public void initialize(double val)

initialize

public void initialize(int val)

initialize

public void initialize(long val)

initialize

public void initialize(String val)

initialize

public void initialize(String file,
                       String classname,
                       String parameters)

initializeAllInputParameterFieldsOfObject

public static void initializeAllInputParameterFieldsOfObject(Object o,
                                                             Map<String,String> params)

initializeAllInputParameterFieldsOfObject

public static void initializeAllInputParameterFieldsOfObject(Object o,
                                                             String className,
                                                             Map<String,String> params)

initializeFromMap

public void initializeFromMap(Map<String,String> map)

isWithinAcceptableRange

public boolean isWithinAcceptableRange()

main

public static void main(String[] args)

toString

public String toString()

Overrides:

toString in class Object