de.jstacs.algorithms.optimization.termination
Class CombinedCondition.CombinedConditionParameterSet

java.lang.Object
  de.jstacs.parameters.ParameterSet
      de.jstacs.parameters.InstanceParameterSet
          de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet
              de.jstacs.algorithms.optimization.termination.CombinedCondition.CombinedConditionParameterSet

All Implemented Interfaces:

GalaxyConvertible, RangeIterator, Storable, Cloneable

Enclosing class:

CombinedCondition

public static class CombinedCondition.CombinedConditionParameterSet
extends AbstractTerminationCondition.AbstractTerminationConditionParameterSet

This class implements the parameter set for a CombinedCondition.

Author:

Jan Grau, 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, ranged

Constructor Summary

CombinedCondition.CombinedConditionParameterSet()
This constructor creates an empty parameter set.

CombinedCondition.CombinedConditionParameterSet(int threshold, AbstractTerminationCondition[] condition)
This constructor creates a filled instance of a parameters set.

CombinedCondition.CombinedConditionParameterSet(StringBuffer xml)
The standard constructor for the interface Storable.

Method Summary

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.
protected void	loadParameters() Loads the parameters for 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, getErrorMessage, getId, getIndex, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, reset, resetToFirst, setParent, simplify, toGalaxy, valuesToString

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedCondition.CombinedConditionParameterSet

public CombinedCondition.CombinedConditionParameterSet()

This constructor creates an empty parameter set.

CombinedCondition.CombinedConditionParameterSet

public CombinedCondition.CombinedConditionParameterSet(StringBuffer xml)
                                                throws NonParsableException

The standard constructor for the interface Storable. Constructs an CombinedCondition.CombinedConditionParameterSet out of an XML representation.

Parameters:

xml - the XML representation as StringBuffer

Throws:

NonParsableException - if the CombinedCondition.CombinedConditionParameterSet could not be reconstructed out of the StringBuffer representation

CombinedCondition.CombinedConditionParameterSet

public CombinedCondition.CombinedConditionParameterSet(int threshold,
                                                       AbstractTerminationCondition[] condition)
                                                throws Exception

This constructor creates a filled instance of a parameters set.

Parameters:

threshold - the number of conditions that has to be fulfilled

condition - the individual conditions for stopping the algorithm

Throws:

Exception - if the CombinedCondition.CombinedConditionParameterSet could not be created

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

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

Returns:

the name of the class

loadParameters

protected void loadParameters()
                       throws Exception

Description copied from class: ParameterSet

Loads the parameters for this ParameterSet. This is in most cases done by calling ParameterSet.initParameterList() or ParameterSet.initParameterList(int) to initialize ParameterSet.parameters and afterwards filling ParameterSet.parameters with instances of subclasses of Parameter.

Specified by:

loadParameters in class ParameterSet

Throws:

Exception - if the parameters could not be loaded

See Also:

Parameter, ParameterSet.parameters, ParameterSet.initParameterList(), ParameterSet.initParameterList(int)