org.metacsp.framework

Class Domain

java.lang.Object

org.metacsp.framework.Domain

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.lang.Object>

Direct Known Subclasses:

BooleanDomain, ConfigurationDomain, FuzzySymbolicDomain, Interval, MultiDomain, Rectangle, SimpleInterval, SpatialDomain, Vertex

public abstract class Domain
extends java.lang.Object
implements java.lang.Comparable<java.lang.Object>, java.io.Serializable

This class is used to represent domains of variables. Its main capability is to provide functionality for choosing values from a Variable's domain. This is done through ValueChoiceFunctions, which have to be registered with the domain.

Author:

Federico Pecora

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	defaultValueChoiceFunction
protected java.util.logging.Logger	logger
protected Variable	myVariable
static java.util.HashMap<java.lang.Class<?>,java.util.HashMap<java.lang.String,ValueChoiceFunction>>	valueChoiceFunctions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Domain(Variable v)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	chooseValue() Choose a value from this Domain according to the default ValueChoiceFunction (or the ValueChoiceFunction which was first registered if no default is set).
java.lang.Object	chooseValue(java.lang.String vcf) Choose a value from this Domain according to the given ValueChoiceFunction identifier.
java.util.HashMap<java.lang.String,ValueChoiceFunction>	getValueChoiceFunctions(java.lang.Class<?> specifiDomain) Get all the ValueChoiceFunctions associated with this Domain.
Variable	getVariable() Get the Variable of which this object is the Domain.
static void	registerValueChoiceFunction(java.lang.Class<?> specificDomain, ValueChoiceFunction vcf, java.lang.String name)
static void	removeValueChoiceFunctions(java.lang.Class<?> specificDomain)
void	setDefaultValueChoiceFunction(java.lang.String vcf) Set this Domain's default ValueChoiceFunction.
abstract java.lang.String	toString() Get a string representation of this domain (must be implemented by the Domain developer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

valueChoiceFunctions

public static java.util.HashMap<java.lang.Class<?>,java.util.HashMap<java.lang.String,ValueChoiceFunction>> valueChoiceFunctions

myVariable

protected Variable myVariable

defaultValueChoiceFunction

protected java.lang.String defaultValueChoiceFunction

logger

protected transient java.util.logging.Logger logger

Constructor Detail

Domain

protected Domain(Variable v)

Method Detail

removeValueChoiceFunctions

public static void removeValueChoiceFunctions(java.lang.Class<?> specificDomain)

registerValueChoiceFunction

public static void registerValueChoiceFunction(java.lang.Class<?> specificDomain,
                                               ValueChoiceFunction vcf,
                                               java.lang.String name)

chooseValue

public java.lang.Object chooseValue(java.lang.String vcf)
                             throws IllegalValueChoiceFunction

Choose a value from this Domain according to the given ValueChoiceFunction identifier.

Parameters:

vcf - A ValueChoiceFunction function identifier.

Returns:

A value chosen according to the given ValueChoiceFunction.

Throws:

IllegalValueChoiceFunction

chooseValue

public java.lang.Object chooseValue()

Choose a value from this Domain according to the default ValueChoiceFunction (or the ValueChoiceFunction which was first registered if no default is set).

Returns:

A value chosen according to the Domain's default ValueChoiceFunction.

setDefaultValueChoiceFunction

public void setDefaultValueChoiceFunction(java.lang.String vcf)

Set this Domain's default ValueChoiceFunction.

Parameters:

vcf - A ValueChoiceFunction identifier.

toString

public abstract java.lang.String toString()

Get a string representation of this domain (must be implemented by the Domain developer.

Overrides:

toString in class java.lang.Object

getValueChoiceFunctions

public java.util.HashMap<java.lang.String,ValueChoiceFunction> getValueChoiceFunctions(java.lang.Class<?> specifiDomain)

Get all the ValueChoiceFunctions associated with this Domain.

Returns:

The ValueChoiceFunctions associated with this Domain.

getVariable

public Variable getVariable()

Get the Variable of which this object is the Domain.

Returns:

The Variable of which this object is the Domain.