org.metacsp.framework.multi

Class MultiVariable

java.lang.Object

org.metacsp.framework.Variable

org.metacsp.framework.multi.MultiVariable

All Implemented Interfaces:

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

Direct Known Subclasses:

AllenInterval, FuzzyActivity, FuzzySetActivity, MultiTimePoint, MultiVarDebug, RectangularCuboidRegion, RectangularRegion, SpatialFluent, SpatialFluent2, SpatioTemporalVariable, SymbolicVariable, SymbolicVariableActivity, TrajectoryEnvelope

public abstract class MultiVariable
extends Variable

A multi-variable is a variable "implemented" by several underlying lower-level Variables. This class is used by MultiConstraintSolvers along with MultiConstraints to maintain and propagate multiple CSPs defined by aggregations of variables and constraints. An example is the AllenInterval, an aggregation of two TimePoints, which can be bound by MultiConstraints of the type AllenIntervalConstraint and reasoned upon by an AllenIntervalNetworkSolver. Defining a MultiVariable is reduced to creating the internal lower-level Variables (method createVariablesSub(int num)). Also, a MultiVariable may have "implementing constraints". This is the case, e.g., in the AllenInterval, which, in addition to the two TimePoints, also possesses a AllenIntervalConstraint of type Duration. For this reason, the designer of a MultiVariable must also define the createInternalConstraints() method.

Author:

Federico Pecora

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashMap<org.metacsp.framework.multi.MultiVariable.FieldOfObject,java.lang.Object>	backupForSerialization
protected Constraint[]	constraints
protected ConstraintSolver[]	internalSolvers
protected Variable[]	variables

Fields inherited from class org.metacsp.framework.Variable

attributes, dependentVariables, id, logger, solver

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiVariable(ConstraintSolver cs, int id, ConstraintSolver[] internalSolvers, Variable[] internalVars) The constructor of an extensions to MultiVariable must call this constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract Constraint[]	createInternalConstraints(Variable[] variables) This method must be implemented to define the internal lower-level Constraints of this MultiVariable.
static void	drawVariableHierarchy(edu.uci.ics.jung.graph.DelegateTree<Variable,java.lang.String> tree) Draw the Variable hierarchy underlying this MultiVariable.
java.lang.String	getDescription() Get the description of this Variable's type.
MultiDomain	getDomain() Get the domain of this Variable.
Constraint[]	getInternalConstraints() Get the internal Constraints of this MultiVariable.
ConstraintSolver[]	getInternalConstraintSolvers() Get the internal ConstraintSolvers of this MultiVariable.
Variable[]	getInternalVariables() Get the internal Variables of this MultiVariable.
edu.uci.ics.jung.graph.DelegateTree<Variable,java.lang.String>	getVariableHierarchy() Get the hierarchy of Variables underlying this MultiVariable.
Variable[]	getVariablesFromVariableHierarchy(java.lang.Class<?> cl) Get the Variables of a given type in this MultiVariable's variable hierarchy.
void	setComponent(java.lang.String component) Set this Variable's component.

Methods inherited from class org.metacsp.framework.Variable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

backupForSerialization

public static java.util.HashMap<org.metacsp.framework.multi.MultiVariable.FieldOfObject,java.lang.Object> backupForSerialization

internalSolvers

protected ConstraintSolver[] internalSolvers

variables

protected Variable[] variables

constraints

protected Constraint[] constraints

Constructor Detail

MultiVariable

protected MultiVariable(ConstraintSolver cs,
                        int id,
                        ConstraintSolver[] internalSolvers,
                        Variable[] internalVars)

The constructor of an extensions to MultiVariable must call this constructor.

Parameters:

cs - The ConstraintSolver of the MultiVariable.

id - The MultiVariable's ID.

internalSolvers - The internal solvers of this MultiVariable (to which the

internalVars - The internal Variables implementing this MultiVariable.

Method Detail

createInternalConstraints

protected abstract Constraint[] createInternalConstraints(Variable[] variables)

This method must be implemented to define the internal lower-level Constraints of this MultiVariable.

Parameters:

variables - The internal variables among which the Constraints should be defined.

Returns:

The internal lower-level Constraints of this MultiVariable.

getInternalVariables

public Variable[] getInternalVariables()

Get the internal Variables of this MultiVariable.

Returns:

The internal Variables of this MultiVariable.

getInternalConstraints

public Constraint[] getInternalConstraints()

Get the internal Constraints of this MultiVariable.

Returns:

The internal Constraints of this MultiVariable.

getInternalConstraintSolvers

public ConstraintSolver[] getInternalConstraintSolvers()

Get the internal ConstraintSolvers of this MultiVariable.

Returns:

The internal ConstraintSolvers of this MultiVariable.

getDomain

public MultiDomain 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.

getVariableHierarchy

public edu.uci.ics.jung.graph.DelegateTree<Variable,java.lang.String> getVariableHierarchy()

Get the hierarchy of Variables underlying this MultiVariable.

Returns:

The hierarchy of Variables underlying this MultiVariable.

drawVariableHierarchy

public static void drawVariableHierarchy(edu.uci.ics.jung.graph.DelegateTree<Variable,java.lang.String> tree)

Draw the Variable hierarchy underlying this MultiVariable.

Parameters:

tree - The Variable hierarchy to draw.

getVariablesFromVariableHierarchy

public Variable[] getVariablesFromVariableHierarchy(java.lang.Class<?> cl)

Get the Variables of a given type in this MultiVariable's variable hierarchy.

Parameters:

cl - The type of Variables to fetch.

Returns:

The Variables of the given type in this MultiVariable's variable hierarchy.

getDescription

public java.lang.String getDescription()

Description copied from class: Variable

Get the description of this Variable's type.

Overrides:

getDescription in class Variable

Returns:

The description of this Variable's type.

setComponent

public void setComponent(java.lang.String component)

Description copied from class: Variable

Set this Variable's component.

Overrides:

setComponent in class Variable

Parameters:

component - This Variable's component.