burlap.oomdp.core

Class ObjectInstance

java.lang.Object

burlap.oomdp.core.ObjectInstance

public class ObjectInstance
extends java.lang.Object

Object Instances are the primary element for defining states. An object instance as a name identifier that is unique from any other object instances in the same state. Object Instances belong to a specific object class, and have a set of value assignments for each of its object class' attributes.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected ObjectClass	obClass
protected java.util.List<Value>	values

Constructor Summary

Constructors

Constructor and Description
ObjectInstance(ObjectClass obClass, java.lang.String name) Initializes an object instance for a given object class and name.
ObjectInstance(ObjectInstance o) Creates a new object instance that is a deep copy of the specified object instance's values.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllRelationalTargets(java.lang.String attName, java.util.Collection<java.lang.String> targets) Adds all relational targets to the attribute attName for this object instance.
void	addRelationalTarget(java.lang.String attName, java.lang.String target) Sets/adds the relational value of the attribute named attName for this object instance.
void	clearRelationalTargets(java.lang.String attName) Clears all the relational value targets of the attribute named attName for this object instance.
ObjectInstance	copy() Creates and returns a new object instance that is a deep copy of this object instance's values.
boolean	equals(java.lang.Object obj)
java.util.Set<java.lang.String>	getAllRelationalTargets(java.lang.String attName) Returns the set of all relational targets to which the relational attribute named attName is set.
boolean	getBooleanValForAttribute(java.lang.String attName) Returns the boolean value of the attribute (only defined for boolean attributes, int, and disc values).
boolean	getBooleanValue(java.lang.String attName) Deprecated.
int	getDiscValForAttribute(java.lang.String attName) Deprecated.
double[]	getDoubleArrayValForAttribute(java.lang.String attName) Returns the int array value of the attribute (only defined for int array attributes).
double[]	getDoubleArrayValue(java.lang.String attName) Deprecated.
int[]	getIntArrayValForAttribute(java.lang.String attName) Returns the int array value of the attribute (only defined for int array attributes).
int[]	getIntArrayValue(java.lang.String attName) Deprecated.
int	getIntValForAttribute(java.lang.String attName) Returns the int value assignment for the discrete-valued attribute named attName.
java.lang.String	getName() Returns the name identifier of this object instance
double[]	getNormalizedObservableFeatureVec() Returns a normalized double vector of all the observable values in this object instance.
double	getNumericValForAttribute(java.lang.String attName) Returns the double value for the attribute named attType.
ObjectClass	getObjectClass() Returns this object instance's object class
java.lang.String	getObjectDescription() Returns a string representation of this object including its name and value attribute value assignment.
java.lang.String	getObjectDesriptionWithNullForUnsetAttributes() Returns a string description of the object with the unset attribute values listed as null.
double[]	getObservableFeatureVec() Returns a double vector of all the observable values in this object instance.
double	getRealValForAttribute(java.lang.String attName) Returns the double value assignment for the real-valued attribute named attName.
java.lang.String	getStringValForAttribute(java.lang.String attName) Returns the string value representation for the attribute named attName.
java.lang.String	getTrueClassName() Returns the name of this object instance's object class
Value	getValueForAttribute(java.lang.String attName) Returns the Value object assignment for the attribute named attName
java.util.List<Value>	getValues() Returns the list of value object assignments to all of this object instance's attributes.
int	hashCode()
void	initializeValueObjects() Creates new value object assignments for each of this object instance class's attributes.
void	removeRelationalTarget(java.lang.String attName, java.lang.String target) Removes an object target from the specified relational attribute.
void	setName(java.lang.String name) Sets the name of this object instance.
void	setValue(java.lang.String attName, boolean v) Sets the value of the attribute named attName for this object instance.
void	setValue(java.lang.String attName, double v) Sets the value of the attribute named attName for this object instance.
void	setValue(java.lang.String attName, double[] v) Sets the value of the attribute named attName for this object instance.
void	setValue(java.lang.String attName, int v) Sets the value of the attribute named attName for this object instance.
void	setValue(java.lang.String attName, int[] v) Sets the value of the attribute named attName for this object instance.
void	setValue(java.lang.String attName, java.lang.String v) Sets the value of the attribute named attName for this object instance.
java.util.List<java.lang.String>	unsetAttributes() Returns a list of the names of Attributes that have unset values
boolean	valueEquals(ObjectInstance obj) Returns true if the value assignments in this object instance are the same as they are in the target object instance.

Methods inherited from class java.lang.Object

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

Field Detail

obClass

protected ObjectClass obClass

name

protected java.lang.String name

values

protected java.util.List<Value> values

Constructor Detail

ObjectInstance

public ObjectInstance(ObjectClass obClass,
              java.lang.String name)

Initializes an object instance for a given object class and name.

Parameters:

obClass - the object class to which this object belongs

name - the name of the object

ObjectInstance

public ObjectInstance(ObjectInstance o)

Creates a new object instance that is a deep copy of the specified object instance's values. The object class and name is a shallow copy.

Parameters:

o - the source object instance from which this will object will copy.

Method Detail

copy

public ObjectInstance copy()

Creates and returns a new object instance that is a deep copy of this object instance's values.

Returns:

a new object instance that is a deep copy of this object instance's values (the name and object class reference are a shallow copy)

initializeValueObjects

public void initializeValueObjects()

Creates new value object assignments for each of this object instance class's attributes.

setName

public void setName(java.lang.String name)

Sets the name of this object instance.

Parameters:

name - the name for this object instance.

setValue

public void setValue(java.lang.String attName,
            java.lang.String v)

Sets the value of the attribute named attName for this object instance.

Parameters:

attName - the name of the attribute whose value is to be set.

v - the string rep value to which the attribute of this object instance should be set.

setValue

public void setValue(java.lang.String attName,
            double v)

Sets the value of the attribute named attName for this object instance.

Parameters:

attName - the name of the attribute whose value is to be set.

v - the double rep value to which the attribute of this object instance should be set.

setValue

public void setValue(java.lang.String attName,
            int v)

Sets the value of the attribute named attName for this object instance.

Parameters:

attName - the name of the attribute whose value is to be set.

v - the int rep value to which the attribute of this object instance should be set.

setValue

public void setValue(java.lang.String attName,
            boolean v)

Sets the value of the attribute named attName for this object instance.

Parameters:

attName - the name of the attribute whose value is to be set.

v - the int rep value to which the attribute of this object instance should be set.

setValue

public void setValue(java.lang.String attName,
            int[] v)

Sets the value of the attribute named attName for this object instance.

Parameters:

attName - the name of the attribute whose value is to be set.

v - the int array rep value to which the attribute of this object instance should be set.

setValue

public void setValue(java.lang.String attName,
            double[] v)

Sets the value of the attribute named attName for this object instance.

Parameters:

attName - the name of the attribute whose value is to be set.

v - the double array rep value to which the attribute of this object instance should be set.

addRelationalTarget

public void addRelationalTarget(java.lang.String attName,
                       java.lang.String target)

Sets/adds the relational value of the attribute named attName for this object instance. If the attribute is a multi-target relational attribute, then this value is added to the target list.

Parameters:

attName - the name of the relational attribute that will have a relational target added/set

target - the name of the object reference that is to be added as a target.

addAllRelationalTargets

public void addAllRelationalTargets(java.lang.String attName,
                           java.util.Collection<java.lang.String> targets)

Adds all relational targets to the attribute attName for this object instance. For a single-target relational attribute, the value that is ultimately set depends on the iteration order of iterable.

Parameters:

attName - the name of the relational attribute that will have a relational target added/set

targets - the names of the object references that are to be added as a targets.

clearRelationalTargets

public void clearRelationalTargets(java.lang.String attName)

Clears all the relational value targets of the attribute named attName for this object instance.

Parameters:

attName -

removeRelationalTarget

public void removeRelationalTarget(java.lang.String attName,
                          java.lang.String target)

Removes an object target from the specified relational attribute.

Parameters:

attName - the name of the relational attribute from which the target should be removed.

target - the target to remove from the relational attribute value.

getName

public java.lang.String getName()

Returns the name identifier of this object instance

Returns:

the name identifier of this object instance

getObjectClass

public ObjectClass getObjectClass()

Returns this object instance's object class

Returns:

this object instance's object class

getTrueClassName

public java.lang.String getTrueClassName()

Returns the name of this object instance's object class

Returns:

the name of this object instance's object class

getValueForAttribute

public Value getValueForAttribute(java.lang.String attName)

Returns the Value object assignment for the attribute named attName

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

the Value object assignment for the attribute named attName

getRealValForAttribute

public double getRealValForAttribute(java.lang.String attName)

Returns the double value assignment for the real-valued attribute named attName. Will throw a runtime exception is the attribute named attName is not of type REAL or REALUNBOUNDED

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

the double value assignment for the real-valued attribute named attName.

getNumericValForAttribute

public double getNumericValForAttribute(java.lang.String attName)

Returns the double value for the attribute named attType. This method differs from the getRealValForAttribute(String) method because it will cast the int values for non real attributes to double values and will not throw an exception. Note that if this method is called on relational attributes, it will return 0., where as attributes like Attribute.AttributeType.INT and Attribute.AttributeType.DISC will cast their int values to doubles.

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

a double value assignment for the attribute; casting occurs if the attribute is not real-valued.

getStringValForAttribute

public java.lang.String getStringValForAttribute(java.lang.String attName)

Returns the string value representation for the attribute named attName.

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

the string value assignment for the attribute named attName.

getIntValForAttribute

public int getIntValForAttribute(java.lang.String attName)

Returns the int value assignment for the discrete-valued attribute named attName. Will throw a runtime exception is the attribute named attName is not of type DISC

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

the int value assignment for the discrete-valued attribute named attName.

getDiscValForAttribute

@Deprecated
public int getDiscValForAttribute(java.lang.String attName)

Deprecated.

Deprecated method name; use getIntValForAttribute(String) instead.

getAllRelationalTargets

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

Returns the set of all relational targets to which the relational attribute named attName is set. If attName is a single target relational attribute, then it will return a set of at most cardinality one.

Parameters:

attName - attName the name of the attribute whose value should be returned

Returns:

the set of all object instance targets (indicated by their object instance name) for the relational-valued attribute named attName.

getBooleanValue

@Deprecated
public boolean getBooleanValue(java.lang.String attName)

Deprecated.

Deprecated method name; use the getBooleanValForAttribute(String) method instead.

getBooleanValForAttribute

public boolean getBooleanValForAttribute(java.lang.String attName)

Returns the boolean value of the attribute (only defined for boolean attributes, int, and disc values).

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

true if the value for the attribute evaluates to true, false otherwise.

getIntArrayValue

@Deprecated
public int[] getIntArrayValue(java.lang.String attName)

Deprecated.

Deprecated method name; use the getIntArrayValForAttribute(String) method instead.

getIntArrayValForAttribute

public int[] getIntArrayValForAttribute(java.lang.String attName)

Returns the int array value of the attribute (only defined for int array attributes).

Parameters:

attName - the name of the attribute whose value should be returned.

Returns:

the int array value.

getDoubleArrayValue

@Deprecated
public double[] getDoubleArrayValue(java.lang.String attName)

Deprecated.

Deprecated method name; use the getDoubleArrayValForAttribute(String) instead.

getDoubleArrayValForAttribute

public double[] getDoubleArrayValForAttribute(java.lang.String attName)

Returns the int array value of the attribute (only defined for int array attributes).

Parameters:

attName - the name of the attribute whose value should be returned.

Returns:

the int array value.

getValues

public java.util.List<Value> getValues()

Returns the list of value object assignments to all of this object instance's attributes.

Returns:

the list of value object assignments to all of this object instance's attributes.

unsetAttributes

public java.util.List<java.lang.String> unsetAttributes()

Returns a list of the names of Attributes that have unset values

Returns:

a list of the names of attributes that have unset values

getObjectDescription

public java.lang.String getObjectDescription()

Returns a string representation of this object including its name and value attribute value assignment.

Returns:

a string representation of this object including its name and value attribute value assignment.

getObjectDesriptionWithNullForUnsetAttributes

public java.lang.String getObjectDesriptionWithNullForUnsetAttributes()

Returns a string description of the object with the unset attribute values listed as null.

Returns:

a string description of the object with the unset attribute values listed as null.

getObservableFeatureVec

public double[] getObservableFeatureVec()

Returns a double vector of all the observable values in this object instance. Discrete values have their int stored valued converted to a double for this array. This method will throw a runtime exception if the object instance includes relational values. This method may be useful if objects need to be indexed in data structures like kd-trees.

Returns:

a double vector of all the observable values in this object instance.

getNormalizedObservableFeatureVec

public double[] getNormalizedObservableFeatureVec()

Returns a normalized double vector of all the observable values in this object instance. This method relies on the lowerlims and upperlims being set for the corresponding attribute. Furthermore, this method will throw a runtime exception if the object instance includes attributes that are *not* type REAL or INT.

Returns:

a normalized double vector of all the observable values in this object instance.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

valueEquals

public boolean valueEquals(ObjectInstance obj)

Returns true if the value assignments in this object instance are the same as they are in the target object instance.

Parameters:

obj - the object instance against which this object instance should be compared.

Returns:

true if this object instance and obj have identical value assignments; false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object