de.jstacs.algorithms.optimization.termination

Class IterationCondition.IterationConditionParameterSet

java.lang.Object

de.jstacs.parameters.ParameterSet

de.jstacs.parameters.InstanceParameterSet<AbstractTerminationCondition>

de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet

de.jstacs.algorithms.optimization.termination.IterationCondition.IterationConditionParameterSet

All Implemented Interfaces:

GalaxyConvertible, Storable, Cloneable

Enclosing class:

IterationCondition

public static class IterationCondition.IterationConditionParameterSet
extends AbstractTerminationCondition.AbstractTerminationConditionParameterSet

This class implements the parameter set for a IterationCondition.

Author:

Jens Keilwagen

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet

ParameterSet.ParameterList

Field Summary

Fields inherited from class de.jstacs.parameters.ParameterSet

errorMessage, parameters, parent

Constructor Summary

Constructors

Constructor and Description
IterationCondition.IterationConditionParameterSet() This constructor creates an empty parameter set.
IterationCondition.IterationConditionParameterSet(int maxIter) This constructor creates a filled instance of a parameters set.
IterationCondition.IterationConditionParameterSet(StringBuffer xml) The standard constructor for the interface Storable.

Method Summary

Methods

Modifier and Type	Method and Description
String	getInstanceComment() Returns a comment (a textual description) of the class that can be constructed using this ParameterSet.
String	getInstanceName() Returns the name of an instance of the class that can be constructed using this ParameterSet.

Methods inherited from class de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet

clone

Methods inherited from class de.jstacs.parameters.InstanceParameterSet

fromXML, getInstance, getInstanceClass, toXML

Methods inherited from class de.jstacs.parameters.ParameterSet

fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy

Methods inherited from class java.lang.Object

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

Constructor Detail

IterationCondition.IterationConditionParameterSet

public IterationCondition.IterationConditionParameterSet()

This constructor creates an empty parameter set.

IterationCondition.IterationConditionParameterSet

public IterationCondition.IterationConditionParameterSet(StringBuffer xml)
                                                  throws NonParsableException

The standard constructor for the interface Storable. Constructs an IterationCondition.IterationConditionParameterSet out of an XML representation.

Parameters:

xml - the XML representation as StringBuffer

Throws:

NonParsableException - if the IterationCondition.IterationConditionParameterSet could not be reconstructed out of the StringBuffer representation

IterationCondition.IterationConditionParameterSet

public IterationCondition.IterationConditionParameterSet(int maxIter)
                                                  throws IllegalArgumentException,
                                                         SimpleParameter.IllegalValueException

This constructor creates a filled instance of a parameters set.

Parameters:

maxIter - the maximal number of iterations of the algorithm

Throws:

IllegalArgumentException - if parameter can not be set

SimpleParameter.IllegalValueException - if parameter can not be set

Method Detail

getInstanceComment

public String getInstanceComment()

Description copied from class: InstanceParameterSet

Returns a comment (a textual description) of the class that can be constructed using this ParameterSet.

Specified by:

getInstanceComment in class InstanceParameterSet<AbstractTerminationCondition>

Returns:

the comment of the class

getInstanceName

public String getInstanceName()

Description copied from class: InstanceParameterSet

Returns the name of an instance of the class that can be constructed using this ParameterSet.

Specified by:

getInstanceName in class InstanceParameterSet<AbstractTerminationCondition>

Returns:

the name of the class