org.uma.jmetal.solution.impl

Class VariableFactory

java.lang.Object

org.uma.jmetal.solution.impl.VariableFactory

public class VariableFactory
extends Object

This factory provides facilities to generate SolutionBuilder.Variables from usual situations.

Author:

Matthieu Vergne

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariableFactory.IsInterfaceException

Constructor Summary

Constructors

Constructor and Description
VariableFactory()

Method Summary

Modifier and Type	Method and Description
<Solution> Collection<SolutionBuilder.Variable<Solution,?>>	createFromGetters(Class<Solution> solutionClass) This method retrieves all the values accessible through a getter ( getX() method) in order to build the corresponding set of SolutionBuilder.Variables.
<Solution> Collection<SolutionBuilder.Variable<Solution,?>>	createFromGettersAndConstructors(Class<Solution> solutionClass) This method retrieves all the values accessible through a getter ( getX() method) in order to build the corresponding set of SolutionBuilder.Variables.
<Solution> Collection<SolutionBuilder.Variable<Solution,?>>	createFromGettersAndSetters(Class<Solution> solutionClass) This method retrieves all the values accessible through a getter ( getX() method) in order to build the corresponding set of SolutionBuilder.Variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableFactory

public VariableFactory()

Method Detail

createFromGetters

public <Solution> Collection<SolutionBuilder.Variable<Solution,?>> createFromGetters(Class<Solution> solutionClass)

This method retrieves all the values accessible through a getter ( getX() method) in order to build the corresponding set of SolutionBuilder.Variables. Notice that SolutionBuilder.Variables are supposed to represent the fundamental description of a Solution, so if the Solution has computation or other additional methods which are named as getters, they will also be retrieved as SolutionBuilder.Variables. In such a case, you should filter the returned SolutionBuilder.Variables, rely on more advanced methods, or generate the SolutionBuilder.Variables manually.

Parameters:

solutionClass - the Solution class to analyze

Returns:

the set of SolutionBuilder.Variables retrieved from this class

See Also:

createFromGettersAndSetters(Class), createFromGettersAndConstructors(Class)

createFromGettersAndSetters

public <Solution> Collection<SolutionBuilder.Variable<Solution,?>> createFromGettersAndSetters(Class<Solution> solutionClass)

This method retrieves all the values accessible through a getter ( getX() method) in order to build the corresponding set of SolutionBuilder.Variables. At the opposite of createFromGetters(Class), an additional filter is used: we build a SolutionBuilder.Variable for each getter which corresponds to a setter (setX() method with the same X than the getter). This method is adapted for dynamic Solution implementations, thus allowing to change the value of its SolutionBuilder.Variables (e.g. change the path of a TSP Solution).

Notice that, if all the relevant setters are not present (or they do not strictly respect the naming of the getter), the corresponding SolutionBuilder.Variables will not be retrieved. On the opposite, any additional setter/getter couple which does not correspond to a relevant SolutionBuilder.Variable will be mistakenly retrieved. So be sure that the relevant elements (and only these ones) have their setter and getter. Otherwise, you should use a different method or generate the SolutionBuilder.Variables manually.

Parameters:

solutionClass - the Solution class to analyze

Returns:

the set of SolutionBuilder.Variables retrieved from this class

createFromGettersAndConstructors

public <Solution> Collection<SolutionBuilder.Variable<Solution,?>> createFromGettersAndConstructors(Class<Solution> solutionClass)

This method retrieves all the values accessible through a getter ( getX() method) in order to build the corresponding set of SolutionBuilder.Variables. At the opposite of createFromGetters(Class), an additional filter is used: we build a SolutionBuilder.Variable for each getter which corresponds to a constructor argument (argument of the same type). This method is adapted for static Solution implementations, which usually have a constructor which takes all the relevant values and provide getters to retrieve them.

Because Java reflection does not always provide the required information (e.g. names of constructor arguments), this method can be applied only on solution classes which meet strict constraints:

• only one getter should return a given type
• for each constructor and between constructors, only one argument should be of a given type (it can appear in several constructors, but it should be always the same argument)

If all the constraints are not met, an exception will be thrown.

Parameters:

solutionClass - the Solution class to analyze

Returns:

the set of SolutionBuilder.Variables retrieved from this class

Throws:

IllegalArgumentException - if one of the constraints is not met

VariableFactory.IsInterfaceException - if the Solution class to analyze is an interface, thus constructors make no sense