Value

All Known Implementing Classes:

DiscreteValue, DoubleArrayValue, IntArrayValue, IntValue, MultiTargetRelationalValue, OOMDPValue, RealValue, RelationalValue, StringValue
```
public interface Value
```
An abstract class for representing a value assignment for an attribute. Different value subclasses will use different internal representations such as an integer for discrete values or a double for real values. Value set/get methods that are not supported by the subclass will throw a runtime exception.

Author:

James MacGlashan

Method Summary

Methods
Modifier and Type	Method and Description
`Value`	`addAllRelationalTargets(java.util.Collection<java.lang.String> targets)`
`Value`	`addRelationalTarget(java.lang.String t)` adds a relational target for the object instance named t
`java.lang.String`	`attName()`
`java.lang.StringBuilder`	`buildStringVal(java.lang.StringBuilder builder)`
`Value`	`clearRelationTargets()` Removes any relational targets for this attribute
`Value`	`copy()` Creates a deep copy of this value object.
`java.util.Set<java.lang.String>`	`getAllRelationalTargets()` Returns the ordered set of all relational targets of this object.
`Attribute`	`getAttribute()`
`boolean`	`getBooleanValue()` Returns the boolean value of this attibute.
`int`	`getDiscVal()` Returns the discrete integer value of this Value object
`double[]`	`getDoubleArray()` Returns a double array value
`int[]`	`getIntArray()` Returns an int array value
`double`	`getNumericRepresentation()` Returns a numeric double representation of this value.
`double`	`getRealVal()` Returns the real-valued double value of this Value object
`java.lang.String`	`getStringVal()` Returns the string value of this Value object
`Value`	`removeRelationalTarget(java.lang.String target)` Removes a specific relational target from the relational value in relational attribute.
`Value`	`setValue(boolean v)` Sets the internalvalue representation using a boolean value
`Value`	`setValue(double v)` Sets the internal value representation using a double value
`Value`	`setValue(double[] doubleArray)` Sets the double array value.
`Value`	`setValue(int v)` Sets the internal value representation using an int value
`Value`	`setValue(int[] intArray)` Sets the int array value.
`Value`	`setValue(java.lang.String v)` Sets the internal value representation using a string value
`boolean`	`valueHasBeenSet()` Returns whether the value has been set to a meaningful value.

- Method Detail
  - copy
```
Value copy()
```
    Creates a deep copy of this value object.
    
    Returns:
    a deep copy of this value object.
  - attName
```
java.lang.String attName()
```
  - getAttribute
```
Attribute getAttribute()
```
  - valueHasBeenSet
```
boolean valueHasBeenSet()
```
    Returns whether the value has been set to a meaningful value. Unset values typically happen when a new object instance has been created by not had its values set. Leaving values unset will result in exceptions being thrown to prevent errors in underspecified states.
    
    Returns:
    true if the value has been set; false if not.
  - setValue
```
Value setValue(int v)
```
    Sets the internal value representation using an int value
    
    Parameters:
    v - the int value assignment
  - setValue
```
Value setValue(double v)
```
    Sets the internal value representation using a double value
    
    Parameters:
    v - the double value assignment
  - setValue
```
Value setValue(java.lang.String v)
```
    Sets the internal value representation using a string value
    
    Parameters:
    v - the string value assignment
  - addRelationalTarget
```
Value addRelationalTarget(java.lang.String t)
```
    adds a relational target for the object instance named t
    
    Parameters:
    t - the name of the object instance target
  - addAllRelationalTargets
```
Value addAllRelationalTargets(java.util.Collection<java.lang.String> targets)
```
  - clearRelationTargets
```
Value clearRelationTargets()
```
    Removes any relational targets for this attribute
  - removeRelationalTarget
```
Value removeRelationalTarget(java.lang.String target)
```
    Removes a specific relational target from the relational value in relational attribute. If the relational attribute does not have this target specified, then nothing happens. This method is primarily useful for multi-target relational attributes, but if the attribute is a single-target relational attribute and its one currently set target is the one passed to this method, then this method will clear the attribute value.
    
    Parameters:
    target - the object name identifier to remove
  - setValue
```
Value setValue(boolean v)
```
    Sets the internalvalue representation using a boolean value
    
    Parameters:
    v - the boolean value
  - setValue
```
Value setValue(int[] intArray)
```
    Sets the int array value.
    
    Parameters:
    intArray - the int array value to set.
  - setValue
```
Value setValue(double[] doubleArray)
```
    Sets the double array value.
    
    Parameters:
    doubleArray - the double array value to set.
  - getDiscVal
```
int getDiscVal()
```
    Returns the discrete integer value of this Value object
    
    Returns:
    the discrete integer value of this Value object
  - getRealVal
```
double getRealVal()
```
    Returns the real-valued double value of this Value object
    
    Returns:
    the real-valued double value of this Value object
  - getStringVal
```
java.lang.String getStringVal()
```
    Returns the string value of this Value object
    
    Returns:
    the string value of this Value object
  - buildStringVal
```
java.lang.StringBuilder buildStringVal(java.lang.StringBuilder builder)
```
  - getAllRelationalTargets
```
java.util.Set<java.lang.String> getAllRelationalTargets()
```
    Returns the ordered set of all relational targets of this object. The set will be empty if the value is not set to any relational targets.
    
    Returns:
    the ordered set of all relational targets of this object.
  - getBooleanValue
```
boolean getBooleanValue()
```
    Returns the boolean value of this attibute. For int values, this means 0 = false and all other values = true.
    
    Returns:
    the boolean value of this attribute.
  - getIntArray
```
int[] getIntArray()
```
    Returns an int array value
    
    Returns:
    an int array value
  - getDoubleArray
```
double[] getDoubleArray()
```
    Returns a double array value
    
    Returns:
    a double array value.
  - getNumericRepresentation
```
double getNumericRepresentation()
```
    Returns a numeric double representation of this value. If the value is discerete, the int will be type cast as a double.
    
    Returns:
    a numeric double representation of this value

Interface Value

Method Summary

Method Detail

copy

attName

getAttribute

valueHasBeenSet

setValue

setValue

setValue

addRelationalTarget

addAllRelationalTargets

clearRelationTargets

removeRelationalTarget

setValue

setValue

setValue

getDiscVal

getRealVal

getStringVal

buildStringVal

getAllRelationalTargets

getBooleanValue

getIntArray

getDoubleArray

getNumericRepresentation