Variable (   The Meta-CSP FrameworkA Java API for Meta-CSP based reasoning)

java.lang.Object
- org.metacsp.framework.Variable

All Implemented Interfaces:

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

Direct Known Subclasses:

BooleanVariable, ConfigurationVariable, DummyVariable, FuzzySymbolicVariable, GeometricShapeVariable, MultiVariable, Polygon, Region, SimpleAllenInterval, TimePoint, VariablePrototype
```
public abstract class Variable
extends java.lang.Object
implements java.lang.Comparable<Variable>, java.io.Serializable
```
Class representing the decision variables in a Constraint Problem. This class is extended by abstract class MultiVariable to accommodate variables which are themselves constraint networks (essential for the Meta-CSP approach).

Author:

Federico Pecora

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`attributes` A field to set generic attributes
`static java.util.HashMap<org.metacsp.framework.Variable.FieldOfObject,java.lang.Object>`	`backupForSerialization`
`protected Variable[]`	`dependentVariables`
`protected int`	`id` ID generation is up to the implementing class.
`protected java.util.logging.Logger`	`logger`
`protected ConstraintSolver`	`solver` Every variable has a constraint solver.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Variable(ConstraintSolver cs, int id)` A variable should not be instantiated directly, rather only a ConstraintSolver should create variables (through the createVariable() methods).

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDependentVariables(Variable... depVars)` Add `Variable`s that depend on this `Variable`.
`boolean`	`dependsOn(Variable var)` Returns `true` iff this `Variable` depends on a given `Variable`.
`boolean`	`equals(java.lang.Object o)` Ascertain whether this variable is equal to another.
`MultiVariable`	`getAncestorVariable(java.lang.Class<?> cls)` Get the first ancestor `MultiVariable` of this `Variable` that is of a given type.
`java.lang.Object`	`getAttributes()`
`java.awt.Paint`	`getColor()`
`java.lang.String`	`getComponent()` Get this `Variable`'s component.
`ConstraintSolver`	`getConstraintSolver()` Get the constraint solver of this Variable.
`Variable[]`	`getDependentVariables()` Get the `Variable`s that depend on this variable.
`java.lang.String`	`getDescription()` Get the description of this `Variable`'s type.
`abstract Domain`	`getDomain()` Get the domain of this Variable.
`int`	`getID()` Get the ID of this variable.
`java.lang.Object`	`getMarking()` Get the marking of this `Variable`.
`java.lang.Object`	`getOwner()`
`MultiVariable`	`getParentVariable()` Get the parent variable of this `Variable`.
`Variable[]`	`getRecursivelyDependentVariables()` Recursively get all variables that depend on this `Variable` or its dependents, plus this `Variable`.
`MultiVariable`	`getRootVariable()` Get the highest ancestor `MultiVariable` of this `Variable` (root of the variable hierarchy).
`int`	`hashCode()`
`boolean`	`isDependentVariable()` Returns `true` iff this variable appears in the dependency list of any other variable in the same constraint network.
`void`	`removeDependentVariables(Variable... depVars)` Remove one or more `Variable`s from the list of `Variable`s that depend on this `Variable`.
`void`	`setAttributes(java.lang.Object attributes)`
`void`	`setColor(java.awt.Paint c)`
`void`	`setComponent(java.lang.String component)` Set this `Variable`'s component.
`void`	`setDependentVariables(Variable... depVars)` Set `Variable`s that depend on this `Variable`.
`abstract void`	`setDomain(Domain d)` Set the domain of this variable.
`void`	`setMarking(java.lang.Object marking)` Set the marking of this `Variable`.
`void`	`setOwner(java.lang.Object owner)`
`void`	`setParentVariable(MultiVariable p)` Set the parent variable of this `Variable`.
`abstract java.lang.String`	`toString()` Get a `String` representation of this `Variable`.

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.Variable.FieldOfObject,java.lang.Object> backupForSerialization
```
  - dependentVariables
```
protected Variable[] dependentVariables
```
  - logger
```
protected transient java.util.logging.Logger logger
```
  - id
```
protected int id
```
    ID generation is up to the implementing class. No automatic generation provided.
  - attributes
```
protected transient java.lang.Object attributes
```
    A field to set generic attributes
  - solver
```
protected ConstraintSolver solver
```
    Every variable has a constraint solver.
- Constructor Detail
  - Variable
```
protected Variable(ConstraintSolver cs,
                   int id)
```
    A variable should not be instantiated directly, rather only a ConstraintSolver should create variables (through the createVariable() methods). This constructor requires the specification of the constraint solver and of the Variable's ID.
    
    Parameters:
    
    cs - The constraint solver to which this variable refers to.
    
    id - The ID of the variable (should be maintained by the ConstraintSolver in some way).
- Method Detail
  - setDependentVariables
```
public void setDependentVariables(Variable... depVars)
```
    Set Variables that depend on this Variable. Dependent variables are removed when this variable is removed.
    
    Parameters:
    
    depVars - The Variables that depend on this Variable.
  - addDependentVariables
```
public void addDependentVariables(Variable... depVars)
```
    Add Variables that depend on this Variable. Dependent variables are removed when this variable is removed.
    
    Parameters:
    
    depVars - The Variables that depend on this Variable.
  - getDependentVariables
```
public Variable[] getDependentVariables()
```
    Get the Variables that depend on this variable. Dependent variables are removed when this variable is removed.
    
    Returns:
    
    The Variables that depend on this variable.
  - dependsOn
```
public boolean dependsOn(Variable var)
```
    Returns true iff this Variable depends on a given Variable.
    
    Parameters:
    
    var - The Variable to check for dependency.
    
    Returns:
    
    true if this Variable depends on the given Variable, false otherwise.
  - isDependentVariable
```
public boolean isDependentVariable()
```
    Returns true iff this variable appears in the dependency list of any other variable in the same constraint network.
    
    Returns:
    
    true if this variable appears in the dependency list of any other variable, false otherwise.
  - getRecursivelyDependentVariables
```
public Variable[] getRecursivelyDependentVariables()
```
    Recursively get all variables that depend on this Variable or its dependents, plus this Variable.
    
    Returns:
    
    All variables that depend on this Variable or its dependents, plus this Variable.
  - removeDependentVariables
```
public void removeDependentVariables(Variable... depVars)
```
    Remove one or more Variables from the list of Variables that depend on this Variable.
    
    Parameters:
    
    depVars - The dependencies to remove.
  - setParentVariable
```
public void setParentVariable(MultiVariable p)
```
    Set the parent variable of this Variable.
    
    Parameters:
    
    p - The parent variable of this Variable.
  - getParentVariable
```
public MultiVariable getParentVariable()
```
    Get the parent variable of this Variable.
    
    Returns:
    
    The parent variable of this Variable.
  - getAncestorVariable
```
public MultiVariable getAncestorVariable(java.lang.Class<?> cls)
```
    Get the first ancestor MultiVariable of this Variable that is of a given type.
    
    Parameters:
    
    cls - The type of the ancestor MultiVariable.
    
    Returns:
    
    The first ancestor MultiVariable of this Variable that is of the given type.
  - getRootVariable
```
public MultiVariable getRootVariable()
```
    Get the highest ancestor MultiVariable of this Variable (root of the variable hierarchy).
    
    Returns:
    
    The root of this Variable's variable hierarchy.
  - setMarking
```
public void setMarking(java.lang.Object marking)
```
    Set the marking of this Variable.
    
    Parameters:
    
    marking - an Object representing the marking of this Variable.
  - getMarking
```
public java.lang.Object getMarking()
```
    Get the marking of this Variable.
    
    Returns:
    
    An Object representing the marking of this Variable.
  - getConstraintSolver
```
public ConstraintSolver getConstraintSolver()
```
    Get the constraint solver of this Variable.
    
    Returns:
    
    The constraint solver of this variable.
  - getDomain
```
public abstract Domain getDomain()
```
    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.
    
    Returns:
    
    The domain of the variable.
  - setDomain
```
public abstract void setDomain(Domain d)
```
    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.
    
    Parameters:
    
    d - The domain of the variable.
  - getID
```
public int getID()
```
    Get the ID of this variable.
    
    Returns:
    
    the ID of this variable.
  - toString
```
public abstract java.lang.String toString()
```
    Get a String representation of this Variable.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String representation of this Variable.
  - getComponent
```
public java.lang.String getComponent()
```
    Get this Variable's component.
    
    Returns:
    
    This Variable's component.
  - setComponent
```
public void setComponent(java.lang.String component)
```
    Set this Variable's component.
    
    Parameters:
    
    component - This Variable's component.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Ascertain whether this variable is equal to another. Variables are equal iff they have the same ID.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getDescription
```
public java.lang.String getDescription()
```
    Get the description of this Variable's type.
    
    Returns:
    
    The description of this Variable's type.
  - getOwner
```
public java.lang.Object getOwner()
```
  - setOwner
```
public void setOwner(java.lang.Object owner)
```
  - getColor
```
public java.awt.Paint getColor()
```
  - setColor
```
public void setColor(java.awt.Paint c)
```
  - getAttributes
```
public java.lang.Object getAttributes()
```
  - setAttributes
```
public void setAttributes(java.lang.Object attributes)
```

Class Variable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Comparable

Field Detail

backupForSerialization

dependentVariables

logger

id

attributes

solver

Constructor Detail

Variable

Method Detail

setDependentVariables

addDependentVariables

getDependentVariables

dependsOn

isDependentVariable

getRecursivelyDependentVariables

removeDependentVariables

setParentVariable

getParentVariable

getAncestorVariable

getRootVariable

setMarking

getMarking

getConstraintSolver

getDomain

setDomain

getID

toString

getComponent

setComponent

equals

hashCode

getDescription

getOwner

setOwner

getColor

setColor

getAttributes

setAttributes