org.jamesframework.core.problems.constraints.validations

Class SimplePenalizingValidation

java.lang.Object

org.jamesframework.core.problems.constraints.validations.SimplePenalizingValidation

All Implemented Interfaces:

PenalizingValidation, Validation

public class SimplePenalizingValidation
extends Object
implements PenalizingValidation

A simple penalizing validation object that wraps a boolean value, indicating whether the corresponding solution passed validation, and a double value, indicating the assigned penalty if the solution did not pass validation.

Author:

Herman De Beukelaer

Field Summary

Fields

Modifier and Type	Field and Description
static SimplePenalizingValidation	PASSED Constant simple penalizing validation indicating that the validation passed successfully (passed() returns true and no penalty is assigned).

Constructor Summary

Constructors

Constructor and Description
SimplePenalizingValidation(boolean passed, double penalty) Create a simple penalizing validation with a given boolean value, indicating whether the corresponding solution passed validation, and an assigned penalty.

Method Summary

Modifier and Type	Method and Description
static SimplePenalizingValidation	FAILED(double penalty) Creates a simple penalizing validation indicating that the validation failed, where the given strictly positive penalty is assigned.
double	getPenalty() Get the assigned penalty.
boolean	passed() Get the boolean value specified at construction, indicating whether the corresponding solution passed validation.
String	toString() Get a string representation of the validation object.

Methods inherited from class java.lang.Object

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

Field Detail

PASSED

public static final SimplePenalizingValidation PASSED

Constant simple penalizing validation indicating that the validation passed successfully (passed() returns true and no penalty is assigned).

Constructor Detail

SimplePenalizingValidation

public SimplePenalizingValidation(boolean passed,
                                  double penalty)

Create a simple penalizing validation with a given boolean value, indicating whether the corresponding solution passed validation, and an assigned penalty. If passed is true the value of penalty is ignored and the penalty is set to 0. In such case, penalty can be set to any value, e.g. -1. If passed is false it is required that penalty is a strictly positive value.

Parameters:

passed - boolean value, true if the corresponding solution is valid

penalty - assigned penalty, ignored if passed is true

Throws:

IllegalArgumentException - if passed is false but penalty is not strictly positive

Method Detail

FAILED

public static final SimplePenalizingValidation FAILED(double penalty)

Creates a simple penalizing validation indicating that the validation failed, where the given strictly positive penalty is assigned.

Parameters:

penalty - assigned penalty

Returns:

simple penalizing validation where passed() returns false and getPenalty() returns the given strictly positive penalty

Throws:

IllegalArgumentException - if penalty is not strictly positive

passed

public boolean passed()

Get the boolean value specified at construction, indicating whether the corresponding solution passed validation. If this method returns true, getPenalty() returns 0.0.

Specified by:

passed in interface Validation

Returns:

boolean value, true if the corresponding solution is valid

getPenalty

public double getPenalty()

Get the assigned penalty. If passed() returns false this method returns the strictly positive penalty specified at construction. Else, it returns 0.0.

Specified by:

getPenalty in interface PenalizingValidation

Returns:

assigned penalty

toString

public String toString()

Get a string representation of the validation object. Indicates whether the the solution passed validation and the assigned penalty (only if any).

Overrides:

toString in class Object

Returns:

string representation