xal.extension.solver.hint

Class Hint

java.lang.Object

xal.extension.solver.hint.Hint

Direct Known Subclasses:

DomainHint, ExcursionHint

public abstract class Hint
extends java.lang.Object

Hint is the abstract class used for implementing hints.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_label the Hint's label

Constructor Summary

Constructors

Constructor and Description
Hint(java.lang.String aHint) Creates a new instance of Hint

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLabel() Get this hint's label.
abstract java.lang.String	getType() Get the type identifier of this Hint which will be used to fetch this hint in a table of hints.

Methods inherited from class java.lang.Object

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

Field Detail

_label

protected java.lang.String _label

the Hint's label

Constructor Detail

Hint

public Hint(java.lang.String aHint)

Creates a new instance of Hint

Method Detail

getLabel

public java.lang.String getLabel()

Get this hint's label.

Returns:

this hint's label.

getType

public abstract java.lang.String getType()

Get the type identifier of this Hint which will be used to fetch this hint in a table of hints. Subclasses should override this method to return a unique string identifying the hint.

Returns:

the unique type identifier of this Hint