burlap.oomdp.core.values

Class RelationalValue

java.lang.Object

burlap.oomdp.core.values.OOMDPValue

burlap.oomdp.core.values.RelationalValue

All Implemented Interfaces:

Value

public class RelationalValue
extends OOMDPValue
implements Value

A relational valued value subclass in which values are stored as a single String object for the name of the object instance to which it is linked. If the relational value is not linked to any object, then the String value is set to the empty String: "".

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	target A string representing the object target of this value.

Fields inherited from class burlap.oomdp.core.values.OOMDPValue

attribute

Constructor Summary

Constructors

Constructor and Description
RelationalValue(Attribute attribute) Initializes this value to be an assignment for Attribute attribute.
RelationalValue(Attribute attribute, java.lang.String target)
RelationalValue(RelationalValue v) Initializes this value as a copy from the source Value object v.

Method Summary

Methods

Modifier and Type	Method and Description
Value	addRelationalTarget(java.lang.String t) adds a relational target for the object instance named t
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.
boolean	equals(java.lang.Object obj)
java.util.Set<java.lang.String>	getAllRelationalTargets() Returns the ordered set of all relational targets of this object.
double	getNumericRepresentation() Returns a numeric representation
Value	removeRelationalTarget(java.lang.String target) Removes a specific relational target from the relational value in relational attribute.
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.

Methods inherited from class burlap.oomdp.core.values.OOMDPValue

addAllRelationalTargets, attName, getAttribute, getBooleanValue, getDiscVal, getDoubleArray, getIntArray, getRealVal, getStringVal, setValue, setValue, setValue, setValue, setValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface burlap.oomdp.core.values.Value

addAllRelationalTargets, attName, getAttribute, getBooleanValue, getDiscVal, getDoubleArray, getIntArray, getRealVal, getStringVal, setValue, setValue, setValue, setValue, setValue

Field Detail

target

protected final java.lang.String target

A string representing the object target of this value. Targets are specified by the object name identifier. If the relational target is unset, then this value will be set to the empty string "", which is the default value.

Constructor Detail

RelationalValue

public RelationalValue(Attribute attribute)

Initializes this value to be an assignment for Attribute attribute.

Parameters:

attribute -

RelationalValue

public RelationalValue(RelationalValue v)

Initializes this value as a copy from the source Value object v.

Parameters:

v - the source Value to make this object a copy of.

RelationalValue

public RelationalValue(Attribute attribute,
               java.lang.String target)

Method Detail

copy

public Value copy()

Description copied from interface: Value

Creates a deep copy of this value object.

Specified by:

copy in interface Value

Returns:

a deep copy of this value object.

valueHasBeenSet

public boolean valueHasBeenSet()

Description copied from interface: Value

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.

Specified by:

valueHasBeenSet in interface Value

Returns:

true if the value has been set; false if not.

setValue

public Value setValue(java.lang.String v)

Description copied from class: OOMDPValue

Sets the internal value representation using a string value

Specified by:

setValue in interface Value

Overrides:

setValue in class OOMDPValue

Parameters:

v - the string value assignment

addRelationalTarget

public Value addRelationalTarget(java.lang.String t)

Description copied from class: OOMDPValue

adds a relational target for the object instance named t

Specified by:

addRelationalTarget in interface Value

Overrides:

addRelationalTarget in class OOMDPValue

Parameters:

t - the name of the object instance target

clearRelationTargets

public Value clearRelationTargets()

Description copied from class: OOMDPValue

Removes any relational targets for this attribute

Specified by:

clearRelationTargets in interface Value

Overrides:

clearRelationTargets in class OOMDPValue

removeRelationalTarget

public Value removeRelationalTarget(java.lang.String target)

Description copied from class: OOMDPValue

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.

Specified by:

removeRelationalTarget in interface Value

Overrides:

removeRelationalTarget in class OOMDPValue

Parameters:

target - the object name identifier to remove

getAllRelationalTargets

public java.util.Set<java.lang.String> getAllRelationalTargets()

Description copied from interface: Value

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.

Specified by:

getAllRelationalTargets in interface Value

Overrides:

getAllRelationalTargets in class OOMDPValue

Returns:

the ordered set of all relational targets of this object.

buildStringVal

public java.lang.StringBuilder buildStringVal(java.lang.StringBuilder builder)

Specified by:

buildStringVal in interface Value

getNumericRepresentation

public double getNumericRepresentation()

Description copied from class: OOMDPValue

Returns a numeric representation

Specified by:

getNumericRepresentation in interface Value

Overrides:

getNumericRepresentation in class OOMDPValue

Returns:

a double value.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object