burlap.mdp.core.oo.state.generic

Class GenericOOState

java.lang.Object

burlap.mdp.core.oo.state.generic.GenericOOState

All Implemented Interfaces:

MutableOOState, OOState, MutableState, State

Direct Known Subclasses:

DeepOOState

public class GenericOOState
extends java.lang.Object
implements MutableOOState

A generic implementation of a OOState. Stores the set of ObjectInstances with a map from the object name to the instance as well as a list of lists, organizing objects by their object class. The copy() operation will copy the collections, but not the actual ObjectInstance they hold; therefore, this is a ShallowCopyState. If you want to modify the values of an ObjectInstance in this state and the state is copied from another state, then you should retrieve the object with the touch(String) method, will update this state's instance of that object with a copy of it and return you the copy that can be safely modified. This object's set(Object, Object) method and other mutable methods will also perform safe copy-on-write operations.

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<ObjectInstance>>	objectsByClass
protected java.util.Map<java.lang.String,ObjectInstance>	objectsMap

Constructor Summary

Constructors

Constructor and Description
GenericOOState()
GenericOOState(ObjectInstance... objects)
GenericOOState(OOState srcOOState)

Method Summary

Modifier and Type	Method and Description
MutableOOState	addObject(ObjectInstance o) Adds object instance o to this state.
GenericOOState	copy() Returns a copy of this state suitable for creating state transitions.
java.lang.Object	get(java.lang.Object variableKey) Returns the value for the given variable key.
java.util.Map<java.lang.String,java.util.List<ObjectInstance>>	getObjectsByClass() Getter method for underlying data to support serialization.
java.util.Map<java.lang.String,ObjectInstance>	getObjectsMap() Getter method for underlying data to support serialization.
protected java.util.List<ObjectInstance>	getOrGenerateObjectClassList(java.lang.String className)
int	numObjects() Returns the number of object instances in this state.
ObjectInstance	object(java.lang.String oname) Returns the object in this state with the name oname
java.util.List<ObjectInstance>	objects() Returns the list of object instances in this state.
java.util.List<ObjectInstance>	objectsOfClass(java.lang.String oclass) Returns all objects that belong to the object class named oclass
MutableOOState	removeObject(java.lang.String oname) Removes the object instance with the name oname from this state.
MutableOOState	renameObject(java.lang.String objectName, java.lang.String newName) Renames the identifier for object instance o in this state to newName.
MutableState	set(java.lang.Object variableKey, java.lang.Object value) Sets the value for the given variable key.
void	setObjectsByClass(java.util.Map<java.lang.String,java.util.List<ObjectInstance>> objectsByClass) Setter method for underlying data to support serialization
void	setObjectsMap(java.util.Map<java.lang.String,ObjectInstance> objectsMap) Setter method for underlying data to support serialization
java.lang.String	toString()
ObjectInstance	touch(java.lang.String obname) Copies the object with the given name, and updates its index in this state.
java.util.List<java.lang.Object>	variableKeys() Returns the list of state variable keys.

Methods inherited from class java.lang.Object

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

Field Detail

objectsByClass

protected java.util.Map<java.lang.String,java.util.List<ObjectInstance>> objectsByClass

objectsMap

protected java.util.Map<java.lang.String,ObjectInstance> objectsMap

Constructor Detail

GenericOOState

public GenericOOState()

GenericOOState

public GenericOOState(OOState srcOOState)

GenericOOState

public GenericOOState(ObjectInstance... objects)

Method Detail

variableKeys

public java.util.List<java.lang.Object> variableKeys()

Description copied from interface: State

Returns the list of state variable keys.

Specified by:

variableKeys in interface State

Returns:

the list of state variable keys.

get

public java.lang.Object get(java.lang.Object variableKey)

Description copied from interface: State

Returns the value for the given variable key. Changes to the returned value are not guaranteed to modify the state.

Specified by:

get in interface State

Parameters:

variableKey - the variable key

Returns:

the value for the given variable key

set

public MutableState set(java.lang.Object variableKey,
                        java.lang.Object value)

Description copied from interface: MutableState

Sets the value for the given variable key.

Specified by:

set in interface MutableState

Parameters:

variableKey - the key identifier for the variable value to change

value - the variable value to which the variable should be set.

Returns:

this object to support method chaining

copy

public GenericOOState copy()

Description copied from interface: State

Returns a copy of this state suitable for creating state transitions. This copy may be a shallow copy or deep copy and is domain specific. The State implementation may indicate its copy level with the DeepCopyState or ShallowCopyState annotations. If it is a shallow copy, you should not *directly* modify any fields of a copied state without copying the fields first, or it could contaminate the state from which the copy was made. Alternatively, use the MutableState.set(Object, Object) method to modify ShallowCopyState copied states, which for ShallowCopyState instances should perform a safe copy-on-write operation.

Specified by:

copy in interface State

Returns:

a copy of this state.

addObject

public MutableOOState addObject(ObjectInstance o)

Description copied from interface: MutableOOState

Adds object instance o to this state.

Specified by:

addObject in interface MutableOOState

Parameters:

o - the object instance to be added to this state.

Returns:

the modified state

removeObject

public MutableOOState removeObject(java.lang.String oname)

Description copied from interface: MutableOOState

Removes the object instance with the name oname from this state.

Specified by:

removeObject in interface MutableOOState

Parameters:

oname - the name of the object instance to remove.

Returns:

the modified state

renameObject

public MutableOOState renameObject(java.lang.String objectName,
                                   java.lang.String newName)

Description copied from interface: MutableOOState

Renames the identifier for object instance o in this state to newName.

Specified by:

renameObject in interface MutableOOState

Parameters:

objectName - the current object name

newName - the new name of the object instance

Returns:

the modified state

numObjects

public int numObjects()

Description copied from interface: OOState

Returns the number of object instances in this state.

Specified by:

numObjects in interface OOState

Returns:

the number of object instances in this state.

object

public ObjectInstance object(java.lang.String oname)

Description copied from interface: OOState

Returns the object in this state with the name oname

Specified by:

object in interface OOState

Parameters:

oname - the name of the object instance to return

Returns:

the object instance with the name oname or null if there is no object in this state named oname

objects

public java.util.List<ObjectInstance> objects()

Description copied from interface: OOState

Returns the list of object instances in this state.

Specified by:

objects in interface OOState

Returns:

the list object instances in this state.

objectsOfClass

public java.util.List<ObjectInstance> objectsOfClass(java.lang.String oclass)

Description copied from interface: OOState

Returns all objects that belong to the object class named oclass

Specified by:

objectsOfClass in interface OOState

Parameters:

oclass - the name of the object class for which objects should be returned

Returns:

all objects that belong to the object class named oclass

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

touch

public ObjectInstance touch(java.lang.String obname)

Copies the object with the given name, and updates its index in this state. Use this method if you are going to directly modify the ObjectInstance to ensure that you do not contaminate any states from which this state was copied.

Parameters:

obname - the name of the object to be modified.

Returns:

a copy of the ObjectInstance with the given name. Null if this state contains no object with that name

getObjectsByClass

public java.util.Map<java.lang.String,java.util.List<ObjectInstance>> getObjectsByClass()

Getter method for underlying data to support serialization.

Returns:

the underlying Map from class names to ObjectInstance objects for objects in this state.

setObjectsByClass

public void setObjectsByClass(java.util.Map<java.lang.String,java.util.List<ObjectInstance>> objectsByClass)

Setter method for underlying data to support serialization

Parameters:

objectsByClass - the underlying Map from class names to ObjectInstance objects for objects in this state.

getObjectsMap

public java.util.Map<java.lang.String,ObjectInstance> getObjectsMap()

Getter method for underlying data to support serialization.

Returns:

the underlying Map from object names to ObjectInstance objects for objects in this state.

setObjectsMap

public void setObjectsMap(java.util.Map<java.lang.String,ObjectInstance> objectsMap)

Setter method for underlying data to support serialization

Parameters:

objectsMap - the underlying Map from object names to ObjectInstance objects for objects in this state.

getOrGenerateObjectClassList

protected java.util.List<ObjectInstance> getOrGenerateObjectClassList(java.lang.String className)