ObjectInstance

All Known Implementing Classes:

HashableObject, HashableObject.CachedHashableObject, ImmutableHashableObjectFactory.ImmutableHashableObject, ImmutableObjectInstance, MutableObjectInstance, OOMDPObjectInstance
```
public interface ObjectInstance
```
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

Method Summary

Methods
Modifier and Type	Method and Description
`ObjectInstance`	`addAllRelationalTargets(java.lang.String attName, java.util.Collection<java.lang.String> targets)` Adds all relational targets to the attribute attName for this object instance.
`ObjectInstance`	`addRelationalTarget(java.lang.String attName, java.lang.String target)` Sets/adds the relational value of the attribute named attName for this object instance.
`java.lang.StringBuilder`	`buildObjectDescription(java.lang.StringBuilder builder)`
`ObjectInstance`	`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 copy of this object instance's values, if mutable the copy should be deep
`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).
`java.lang.String`	`getClassName()` Returns the name of this object instance's object class
`double[]`	`getDoubleArrayValForAttribute(java.lang.String attName)` Returns the int array value of the attribute (only defined for int array attributes).
`double[]`	`getFeatureVec()` Returns a double vector of all the observable values in this object instance.
`int[]`	`getIntArrayValForAttribute(java.lang.String attName)` Returns the int array value of the attribute (only defined for int array attributes).
`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[]`	`getNormalizedFeatureVec()` 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`	`getObjectDescriptionWithNullForUnsetAttributes()` Returns a string description of the object with the unset attribute values listed as null.
`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.
`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.
`ObjectInstance`	`removeRelationalTarget(java.lang.String attName, java.lang.String target)` Removes an object target from the specified relational attribute.
`ObjectInstance`	`setName(java.lang.String name)` Sets the name of this object instance.
`ObjectInstance`	`setValue(java.lang.String attName, boolean v)` Sets the value of the attribute named attName for this object instance.
`ObjectInstance`	`setValue(java.lang.String attName, double v)` Sets the value of the attribute named attName for this object instance.
`ObjectInstance`	`setValue(java.lang.String attName, double[] v)` Sets the value of the attribute named attName for this object instance.
`ObjectInstance`	`setValue(java.lang.String attName, int v)` Sets the value of the attribute named attName for this object instance.
`ObjectInstance`	`setValue(java.lang.String attName, int[] v)` Sets the value of the attribute named attName for this object instance.
`ObjectInstance`	`setValue(java.lang.String attName, java.lang.String v)` Sets the value of the attribute named attName for this object instance.
`<T> ObjectInstance`	`setValue(java.lang.String attName, T v)`
`java.util.List<java.lang.String>`	`unsetAttributes()` Returns a list of the names of `Attribute`s 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.

- Method Detail
  - copy
```
ObjectInstance copy()
```
    Creates and returns a new object instance that is a copy of this object instance's values, if mutable the copy should be deep
    
    Returns:
    a new object instance that is a copy of this object instance
  - setName
```
ObjectInstance setName(java.lang.String name)
```
    Sets the name of this object instance.
    
    Parameters:
    name - the name for this object instance.
  - setValue
```
<T> ObjectInstance setValue(java.lang.String attName,
                          T v)
```
  - setValue
```
ObjectInstance 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
```
ObjectInstance 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
```
ObjectInstance 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
```
ObjectInstance 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
```
ObjectInstance 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
```
ObjectInstance 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
```
ObjectInstance 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
```
ObjectInstance 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
```
ObjectInstance clearRelationalTargets(java.lang.String attName)
```
    Clears all the relational value targets of the attribute named attName for this object instance.
    
    Parameters:
    attName -
  - removeRelationalTarget
```
ObjectInstance 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
```
java.lang.String getName()
```
    Returns the name identifier of this object instance
    
    Returns:
    the name identifier of this object instance
  - getObjectClass
```
ObjectClass getObjectClass()
```
    Returns this object instance's object class
    
    Returns:
    this object instance's object class
  - getClassName
```
java.lang.String getClassName()
```
    Returns the name of this object instance's object class
    
    Returns:
    the name of this object instance's object class
  - getValueForAttribute
```
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
```
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
```
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
```
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
```
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.
  - getAllRelationalTargets
```
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.
  - getBooleanValForAttribute
```
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.
  - getIntArrayValForAttribute
```
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.
  - getDoubleArrayValForAttribute
```
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
```
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
```
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
```
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.
  - buildObjectDescription
```
java.lang.StringBuilder buildObjectDescription(java.lang.StringBuilder builder)
```
  - getObjectDescriptionWithNullForUnsetAttributes
```
java.lang.String getObjectDescriptionWithNullForUnsetAttributes()
```
    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.
  - getFeatureVec
```
double[] getFeatureVec()
```
    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.
  - getNormalizedFeatureVec
```
double[] getNormalizedFeatureVec()
```
    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.
  - valueEquals
```
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. This may differ from a normal equals because it does not require the object instance name identifiers to be the same.
    
    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.

Interface ObjectInstance

Method Summary

Method Detail

copy

setName

setValue

setValue

setValue

setValue

setValue

setValue

setValue

addRelationalTarget

addAllRelationalTargets

clearRelationalTargets

removeRelationalTarget

getName

getObjectClass

getClassName

getValueForAttribute

getRealValForAttribute

getNumericValForAttribute

getStringValForAttribute

getIntValForAttribute

getAllRelationalTargets

getBooleanValForAttribute

getIntArrayValForAttribute

getDoubleArrayValForAttribute

getValues

unsetAttributes

getObjectDescription

buildObjectDescription

getObjectDescriptionWithNullForUnsetAttributes

getFeatureVec

getNormalizedFeatureVec

valueEquals