org.metacsp.framework

Class VariablePrototype

java.lang.Object

org.metacsp.framework.Variable

org.metacsp.framework.VariablePrototype

All Implemented Interfaces:

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

public class VariablePrototype
extends Variable

Objects of this type can be used to represent prototype variables. This is useful since the only way to create a Variable is to invoke a ConstraintSolver's factory methods, which in turn perform other operations to keep track of the created variable(s). If a variable is to be used only as a prototype, then all of these operations can be skipped, and this class used. Variable prototypes are not used for reasoning, rather real Variables are automatically instantiated through the factory methods of concrete ConstraintSolvers on the basis of the information contained in variable prototypes.

Author:

Federico Pecora

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	id Static ID counter for VariablePrototypes.
protected java.lang.Object[]	parameters

Fields inherited from class org.metacsp.framework.Variable

attributes, backupForSerialization, dependentVariables, logger, solver

Constructor Summary

Constructors

Constructor and Description
VariablePrototype(ConstraintSolver cs, java.lang.Object... parameters) Create a new VariablePrototype with a given ConstraintSolver and given parameters.

Method Summary

Modifier and Type	Method and Description
VariablePrototype	clone()
int	compareTo(Variable arg0)
Domain	getDomain() Get the domain of this Variable.
java.lang.Object[]	getParameters() Get the parameters of this VariablePrototype.
void	setDomain(Domain d) Set the domain of this variable.
java.lang.String	toString() Get a String representation of this Variable.

Methods inherited from class org.metacsp.framework.Variable

addDependentVariables, dependsOn, equals, getAncestorVariable, getAttributes, getColor, getComponent, getConstraintSolver, getDependentVariables, getDescription, getID, getMarking, getOwner, getParentVariable, getRecursivelyDependentVariables, getRootVariable, hashCode, isDependentVariable, removeDependentVariables, setAttributes, setColor, setComponent, setDependentVariables, setMarking, setOwner, setParentVariable

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

parameters

protected java.lang.Object[] parameters

id

public static int id

Static ID counter for VariablePrototypes.

Constructor Detail

VariablePrototype

public VariablePrototype(ConstraintSolver cs,
                         java.lang.Object... parameters)

Create a new VariablePrototype with a given ConstraintSolver and given parameters.

Parameters:

cs - The ConstraintSolver to which concrete Variables created on the basis of this prototype should refer to.

parameters - Parameters useful for the creation of a concrete Variable.

Method Detail

getParameters

public java.lang.Object[] getParameters()

Get the parameters of this VariablePrototype.

Returns:

The parameters of this VariablePrototype.

compareTo

public int compareTo(Variable arg0)

getDomain

public Domain getDomain()

Description copied from class: Variable

Get the domain of this Variable. Must be implemented by the ConstraintSolver developer, since getting the domain of a variable may be a non-trivial operation.

Specified by:

getDomain in class Variable

Returns:

The domain of the variable.

setDomain

public void setDomain(Domain d)

Description copied from class: Variable

Set the domain of this variable. Must be implemented by the ConstraintSolver developer, since setting the domain of a variable may be a non-trivial operation.

Specified by:

setDomain in class Variable

Parameters:

d - The domain of the variable.

toString

public java.lang.String toString()

Description copied from class: Variable

Get a String representation of this Variable.

Specified by:

toString in class Variable

Returns:

A String representation of this Variable.

clone

public VariablePrototype clone()

Overrides:

clone in class java.lang.Object