IRPact_modellierung.helper

Class ValueConversionHelper

java.lang.Object

IRPact_modellierung.helper.ValueConversionHelper

public class ValueConversionHelper
extends java.lang.Object

Class to provide helper methods to convert values of one data type into another.

Constructor Summary

Constructors

Constructor and Description
ValueConversionHelper()

Method Summary

Modifier and Type	Method and Description
static java.awt.geom.Point2D	arrayList2DtoPoint2D(java.util.ArrayList<java.lang.Double> twoTuple) Method to convert a 2-tupel ArrayList representation of a point (with Double coordinates) into a Point2D(.Double) format
static java.util.HashMap<java.lang.String,java.lang.Object>[]	arrayListHashMapToArrayHashMap(java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Object>> arrayListToConvert) Method to convert an ArrayList of HashMaps (of String-Object pairs) into an Array of HashMaps (of String-Object pairs)
static java.util.Set<java.lang.String>	arrayListToSet(java.util.ArrayList<java.lang.String> stringsToConvert) Method to copy the strings contained in an Array list into a set.
static java.util.Map<ConsumerAgentGroup,java.lang.Integer>	deriveCAGIntegerMap(java.util.Set<ConsumerAgentGroup> consumerAgentGroups, java.util.HashMap<java.lang.String,java.lang.Integer> consumerGroupIntegerMapping, java.lang.String context) Method to transform a String-Integer map to a ConsumerAgentGroup-Integer map with the ConsumerAgentGroup corresponding to the keys of the String-Integer map.
static java.util.Set<Need>	getCorrespondingNeeds(java.util.Set<java.lang.String> needsSatisfied, java.util.Map<java.lang.String,Need> needsMap) Method to select all needs from a String-Need map as from a set of Strings.
static java.util.Map<java.lang.Integer,java.util.Set<Product>>	IntegerFPDSetMapToIntegerProductSetMap(java.util.Map<java.lang.Integer,java.util.Set<FixedProductDescription>> initiallyAdoptedFPDs, SimulationContainer simulationContainer) Method to convert a map of Integer keys and sets of FixedProductDescription to a map of the same integer keys with set of products corresponding to the instances of the FixedProductDescriptions as values
static java.util.ArrayList<Value>	linkedHashMapToArrayList(java.util.LinkedHashMap<Value,java.lang.Double> orderedFactorMap) Method to convert an ordered LinkedHashMap of Value-Double pairs to an array list of the same order
static java.util.Set<ProductGroup>	ProductGroupCollectionToSet(java.util.Collection<ProductGroup> productGroups) Method to convert a Collection of productGroups to a set of these
static java.util.ArrayList<java.lang.Double>	SetToArrayList(java.util.Set<java.lang.Double> setToConvert) Method to convert a set of Double values to an array list.
static boolean	signToBoolean(double doubleToConvert) Method to convert a numerical representation of a boolean value into a boolean value.
static java.util.Set<ConsumerAgent>	synchronousConsumerAgentsToConsumerAgents(java.util.Set<SynchronousConsumerAgent> agentsInCAG) Method to convert a set of SynchronousConsumerAgents to a set of ConsumerAgents

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueConversionHelper

public ValueConversionHelper()

Method Detail

signToBoolean

public static boolean signToBoolean(double doubleToConvert)

Method to convert a numerical representation of a boolean value into a boolean value. Converts a double to false if it is 0.0 or smaller and true otherwise

Parameters:

doubleToConvert - The (double representation) value to convert to boolean

Returns:

true if numerical value > 0.0, false otherwise

SetToArrayList

public static java.util.ArrayList<java.lang.Double> SetToArrayList(java.util.Set<java.lang.Double> setToConvert)
                                                            throws java.lang.IllegalArgumentException

Method to convert a set of Double values to an array list. Implies no order, will just arrange them in an order (in which the set is processed).

Parameters:

setToConvert - Set of numbers to convert to a list

Returns:

(unsorted) ArrayList of the values within the set

Throws:

java.lang.IllegalArgumentException - Will be thrown when the set is empty

arrayList2DtoPoint2D

public static java.awt.geom.Point2D arrayList2DtoPoint2D(java.util.ArrayList<java.lang.Double> twoTuple)
                                                  throws java.lang.IllegalArgumentException

Method to convert a 2-tupel ArrayList representation of a point (with Double coordinates) into a Point2D(.Double) format

Parameters:

twoTuple - The two tuple (as an ArrayList of Double values) to convert to a point, with first coordinate as x-Coordinate, and second coordinate as y-Coordinate

Returns:

A Point2D.Double representation of the coordenates of the provided array list

Throws:

java.lang.IllegalArgumentException - Will be thrown when the dimension of the parameter is not 2 (not a 2-tuple)

arrayListHashMapToArrayHashMap

public static java.util.HashMap<java.lang.String,java.lang.Object>[] arrayListHashMapToArrayHashMap(java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Object>> arrayListToConvert)
                                                                                             throws java.lang.IllegalArgumentException

Method to convert an ArrayList of HashMaps (of String-Object pairs) into an Array of HashMaps (of String-Object pairs)

Parameters:

arrayListToConvert - The ArrayList of hash maps that is to be converted to an array of hash maps

Returns:

An array consisting of the entries of the provided ArrayList

Throws:

java.lang.IllegalArgumentException - Will be thrown when the array list to convert is empty

getCorrespondingNeeds

public static java.util.Set<Need> getCorrespondingNeeds(java.util.Set<java.lang.String> needsSatisfied,
                                                        java.util.Map<java.lang.String,Need> needsMap)
                                                 throws java.lang.IllegalArgumentException

Method to select all needs from a String-Need map as from a set of Strings. Will look up each corresponding Need (for each String) and put them into a result set (provided every String is accounted for; if not an Exception will be thrown)

Parameters:

needsSatisfied - String representation of the needs satisfied whose corresponding needs are to be selected

needsMap - The needs map, mapping the provided strings with their desired needs

Returns:

The set of Needs corresponding to the set of Strings provided, based on the String-Need map

Throws:

java.lang.IllegalArgumentException - Will be thrown if the set of Strings is empty or one of them is not a key of the needsMap

arrayListToSet

public static java.util.Set<java.lang.String> arrayListToSet(java.util.ArrayList<java.lang.String> stringsToConvert)
                                                      throws java.lang.IllegalArgumentException

Method to copy the strings contained in an Array list into a set. Will throw an exception if the array list is empty or an entry appear twice

Parameters:

stringsToConvert - The (Arraylist of) strings to convert into a set

Returns:

A set consisting of the strings contained in the provided array list

Throws:

java.lang.IllegalArgumentException - Will be thrown if the array list is empty or contains duplicate entries

synchronousConsumerAgentsToConsumerAgents

public static java.util.Set<ConsumerAgent> synchronousConsumerAgentsToConsumerAgents(java.util.Set<SynchronousConsumerAgent> agentsInCAG)
                                                                              throws java.lang.IllegalArgumentException

Method to convert a set of SynchronousConsumerAgents to a set of ConsumerAgents

Parameters:

agentsInCAG - SynchronousConsumerAgents to be converted

Returns:

A set of the same SynchronousConsumerAgent as ConsumerAgents

Throws:

java.lang.IllegalArgumentException - will be thrown if the set to convert is empty

ProductGroupCollectionToSet

public static java.util.Set<ProductGroup> ProductGroupCollectionToSet(java.util.Collection<ProductGroup> productGroups)
                                                               throws java.lang.IllegalArgumentException

Method to convert a Collection of productGroups to a set of these

Parameters:

productGroups - The Collection to convert to a set

Returns:

The product groups to be converted as a set

Throws:

java.lang.IllegalArgumentException - Will be thrown when collection is empty

IntegerFPDSetMapToIntegerProductSetMap

public static java.util.Map<java.lang.Integer,java.util.Set<Product>> IntegerFPDSetMapToIntegerProductSetMap(java.util.Map<java.lang.Integer,java.util.Set<FixedProductDescription>> initiallyAdoptedFPDs,
                                                                                                             SimulationContainer simulationContainer)
                                                                                                      throws java.lang.IllegalArgumentException

Method to convert a map of Integer keys and sets of FixedProductDescription to a map of the same integer keys with set of products corresponding to the instances of the FixedProductDescriptions as values

Parameters:

initiallyAdoptedFPDs - The map which values are to be converted to sets

simulationContainer - The container the simulation runs in

Returns:

A map of the same keys as the initiallyAdoptedFPDs with their values converted to sets of instances of the corresponding products

Throws:

java.lang.IllegalArgumentException - Will be throw if the map is empty, the container is null, or a FixedProductDescription doesn't not have a corresponding product in the simulation

linkedHashMapToArrayList

public static java.util.ArrayList<Value> linkedHashMapToArrayList(java.util.LinkedHashMap<Value,java.lang.Double> orderedFactorMap)
                                                           throws java.lang.IllegalArgumentException

Method to convert an ordered LinkedHashMap of Value-Double pairs to an array list of the same order

Parameters:

orderedFactorMap - The (ordered) map to be converted

Returns:

An array list with the same order as the provided argument hash map

Throws:

java.lang.IllegalArgumentException - Gets thrown when the argument is an empty map

deriveCAGIntegerMap

public static java.util.Map<ConsumerAgentGroup,java.lang.Integer> deriveCAGIntegerMap(java.util.Set<ConsumerAgentGroup> consumerAgentGroups,
                                                                                      java.util.HashMap<java.lang.String,java.lang.Integer> consumerGroupIntegerMapping,
                                                                                      java.lang.String context)
                                                                               throws java.lang.IllegalArgumentException

Method to transform a String-Integer map to a ConsumerAgentGroup-Integer map with the ConsumerAgentGroup corresponding to the keys of the String-Integer map. If a String doesn't refer to the name of a CAG given, it will throw an Exception

Parameters:

consumerAgentGroups - The potential keys for the CAG-Integer map

consumerGroupIntegerMapping - The String-Integer map with the keys referring to existing CAGs

context - A String describing the context the method was called from (for a more verbose Exception)

Returns:

A CAG-Integer map with the keys corresponding to the referred CAGs and the values being the respective values of the String-Integer map

Throws:

java.lang.IllegalArgumentException - Will be thrown when a key of the String-Integer map doesn't refer to an agent group given as argument