JaCoP.search
Interface ConsistencyListener

All Known Implementing Classes:

CreditCalculator, Shaving, TraceGenerator

public interface ConsistencyListener

Defines an interface of an object which can be plugined into the search right after executing the consistency function (at the beginning of each search node). Using children listeners it is possible to attach multiple number of listeners working together in any fashion.

Version:

3.1

Author:

Radoslaw Szymanek and Krzysztof Kuchcinski

Method Summary

boolean	executeAfterConsistency(boolean consistent) It is executed right after consistency of the current search node.
void	setChildrenListeners(ConsistencyListener child) Setting one child listener.
void	setChildrenListeners(ConsistencyListener[] children) Each of the child listeners will be called and the return code from them will be combined (taken into account) by a parent).

Method Detail

executeAfterConsistency

boolean executeAfterConsistency(boolean consistent)

It is executed right after consistency of the current search node. Returning true when the parameter was false is not advised as things like invalid solutions can be found.

Parameters:

consistent - specifies if the consistency call returned true or false.

Returns:

true if the search should continue, false if the search should act as the consistency returned false.

setChildrenListeners

void setChildrenListeners(ConsistencyListener[] children)

Each of the child listeners will be called and the return code from them will be combined (taken into account) by a parent).

Parameters:

children - the children listeners attached to this listener.

setChildrenListeners

void setChildrenListeners(ConsistencyListener child)

Setting one child listener.

Parameters:

child - the only child listener added to this consistency listener.