jadex.rules.tools.stateviewer

Class CopyState

java.lang.Object

jadex.rules.tools.stateviewer.CopyState

All Implemented Interfaces:

jadex.rules.state.IOAVState

public class CopyState
extends java.lang.Object
implements jadex.rules.state.IOAVState

A copy state allows to decouple a state from the user (e.g. a local or remote gui tool). Changes to the original state will be represented in the copy state, but synchronized to a user environment (e.g. swing thread). Therefore, a synchronizator needs to be set.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map	copy The state copy.
protected jadex.rules.state.IOAVStateListener	listener The listener on the original state.
protected java.util.List	listeners The listeners.
protected java.util.Set	rootobjects The root objects.
protected jadex.rules.state.IOAVState	state The original state.
protected jadex.commons.concurrent.ISynchronizator	synchronizator The synchronizator (e.g.
protected jadex.rules.state.OAVTypeModel	tmodel The typemodel.

Constructor Summary

Constructors

Constructor and Description
CopyState(jadex.rules.state.IOAVState state, jadex.commons.concurrent.ISynchronizator synchronizator) Create a local copy state.

Method Summary

Modifier and Type	Method and Description
void	addAttributeValue(java.lang.Object object, jadex.rules.state.OAVAttributeType attribute, java.lang.Object value) Add an attribute of an object to the given value.
void	addExternalObjectUsage(java.lang.Object id, java.lang.Object external) Add an external usage of a state object.
void	addJavaRootObject(java.lang.Object object) Add a Java object as root object.
void	addStateListener(jadex.rules.state.IOAVStateListener listener, boolean bunch) Add a new state listener.
void	addSubstate(jadex.rules.state.IOAVState substate) Add a substate.
boolean	containsKey(java.lang.Object object, jadex.rules.state.OAVAttributeType attribute, java.lang.Object key) Test if a key is contained in the map attribute.
boolean	containsObject(java.lang.Object object) Test if the state contains a specific object.
protected static java.util.Map	copyObject(jadex.rules.state.IOAVState state, java.lang.Object id, jadex.rules.state.OAVObjectType type) Copy an OAV object into a map.
java.lang.Object	createObject(jadex.rules.state.OAVObjectType type) Create an object.
java.lang.Object	createRootObject(jadex.rules.state.OAVObjectType type) Create a root object.
void	dispose() Dispose the state.
void	dropObject(java.lang.Object object) Drop an object from the state.
boolean	equals(java.lang.Object a, java.lang.Object b) Test if two values are equal according to current identity/equality settings.
void	expungeStaleObjects() Expunge stale objects.
java.util.List	findCycle(java.util.Collection objects) Find a cycle in a given set of objects.
java.util.Collection	getAttributeKeys(java.lang.Object object, jadex.rules.state.OAVAttributeType attribute) Get the keys of an attribute of an object.
java.lang.Object	getAttributeValue(java.lang.Object object, jadex.rules.state.OAVAttributeType attribute) Get an attribute value of an object.
java.lang.Object	getAttributeValue(java.lang.Object object, jadex.rules.state.OAVAttributeType attribute, java.lang.Object key) Get an attribute value of an object.
java.util.Collection	getAttributeValues(java.lang.Object object, jadex.rules.state.OAVAttributeType attribute) Get the values of an attribute of an object.
java.util.Iterator	getDeepObjects() Get all objects in the state and its substates.
java.util.Iterator	getObjects() Get all objects in the state.
jadex.rules.state.IProfiler	getProfiler() Get the profiler.
java.util.Collection	getReferencingObjects(java.lang.Object value) Get those objects referencing a given object.
java.util.Iterator	getRootObjects() Get the root objects of the state.
int	getSize() Get the number of objects in the state.
jadex.rules.state.IOAVState[]	getSubstates() Get the substates.
jadex.commons.concurrent.ISynchronizator	getSynchronizator() Get the synchronizator (if any).
jadex.rules.state.OAVObjectType	getType(java.lang.Object object) Get the type of an object.
jadex.rules.state.OAVTypeModel	getTypeModel() Get the type model.
java.util.Collection	getUnreferencedObjects() Get all unreferenced objects.
boolean	isIdentifier(java.lang.Object object) Test if the object represents an identifier.
boolean	isJavaIdentity() Flag indicating that java objects are stored by identity instead of equality.
void	notifyEventListeners() Throw collected events and notify the listeners.
void	removeAttributeValue(java.lang.Object object, jadex.rules.state.OAVAttributeType attribute, java.lang.Object value) Remove an attribute of an object to the given value.
void	removeExternalObjectUsage(java.lang.Object id, java.lang.Object external) Remove an external usage of a state object.
void	removeJavaRootObject(java.lang.Object object) Remove a Java object from root objects.
void	removeStateListener(jadex.rules.state.IOAVStateListener listener) Remove a state listener.
void	setAttributeValue(java.lang.Object object, jadex.rules.state.OAVAttributeType attribute, java.lang.Object value) Set an attribute of an object to the given value.
void	setProfiler(jadex.rules.state.IProfiler profiler) Set the profiler.
void	setSynchronizator(jadex.commons.concurrent.ISynchronizator synchronizator) Set the synchronizator.

Methods inherited from class java.lang.Object

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

Field Detail

copy

protected java.util.Map copy

The state copy.

tmodel

protected jadex.rules.state.OAVTypeModel tmodel

The typemodel.

rootobjects

protected java.util.Set rootobjects

The root objects.

synchronizator

protected jadex.commons.concurrent.ISynchronizator synchronizator

The synchronizator (e.g. swing sync.).

state

protected jadex.rules.state.IOAVState state

The original state.

listener

protected jadex.rules.state.IOAVStateListener listener

The listener on the original state.

listeners

protected java.util.List listeners

The listeners.

Constructor Detail

CopyState

public CopyState(jadex.rules.state.IOAVState state,
                 jadex.commons.concurrent.ISynchronizator synchronizator)

Create a local copy state.

Parameters:

state - The original state.

synchronizator - The synchronizator used to reflect changes in the copy state.

Method Detail

dispose

public void dispose()

Dispose the state.

Specified by:

dispose in interface jadex.rules.state.IOAVState

copyObject

protected static java.util.Map copyObject(jadex.rules.state.IOAVState state,
                                          java.lang.Object id,
                                          jadex.rules.state.OAVObjectType type)

Copy an OAV object into a map.

getTypeModel

public jadex.rules.state.OAVTypeModel getTypeModel()

Get the type model.

Specified by:

getTypeModel in interface jadex.rules.state.IOAVState

Returns:

The type model.

createObject

public java.lang.Object createObject(jadex.rules.state.OAVObjectType type)

Create an object. Creates an object identifier that can be used to store/retrieve attribute values. May reuse old object identifiers for performance.

Specified by:

createObject in interface jadex.rules.state.IOAVState

Parameters:

type - The object type (null for defining meta types).

Returns:

An object identifier.

createRootObject

public java.lang.Object createRootObject(jadex.rules.state.OAVObjectType type)

Create a root object. A root object will not be automatically garbage collected when no references point to this object any longer. Creates an object identifier that can be used to store/retrieve attribute values. May reuse old object identifiers for performance.

Specified by:

createRootObject in interface jadex.rules.state.IOAVState

Returns:

An object identifier.

dropObject

public void dropObject(java.lang.Object object)

Drop an object from the state. Recursively removes the object and all connected objects that are not referenced elsewhere.

Specified by:

dropObject in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object to remove.

addJavaRootObject

public void addJavaRootObject(java.lang.Object object)

Add a Java object as root object.

Specified by:

addJavaRootObject in interface jadex.rules.state.IOAVState

Parameters:

object - The Java object.

removeJavaRootObject

public void removeJavaRootObject(java.lang.Object object)

Remove a Java object from root objects.

Specified by:

removeJavaRootObject in interface jadex.rules.state.IOAVState

Parameters:

object - The Java object.

containsObject

public boolean containsObject(java.lang.Object object)

Test if the state contains a specific object.

Specified by:

containsObject in interface jadex.rules.state.IOAVState

Parameters:

object - The object identifier.

Returns:

True, if contained.

isIdentifier

public boolean isIdentifier(java.lang.Object object)

Test if the object represents an identifier.

Specified by:

isIdentifier in interface jadex.rules.state.IOAVState

Parameters:

object - The suspected object identifier.

Returns:

True, if object identifier.

getType

public jadex.rules.state.OAVObjectType getType(java.lang.Object object)

Get the type of an object.

Specified by:

getType in interface jadex.rules.state.IOAVState

Parameters:

object - The object identifier.

getObjects

public java.util.Iterator getObjects()

Get all objects in the state.

Specified by:

getObjects in interface jadex.rules.state.IOAVState

getDeepObjects

public java.util.Iterator getDeepObjects()

Get all objects in the state and its substates.

Specified by:

getDeepObjects in interface jadex.rules.state.IOAVState

getRootObjects

public java.util.Iterator getRootObjects()

Get the root objects of the state.

Specified by:

getRootObjects in interface jadex.rules.state.IOAVState

getSize

public int getSize()

Get the number of objects in the state. Optional operation used for debugging only.

Specified by:

getSize in interface jadex.rules.state.IOAVState

getUnreferencedObjects

public java.util.Collection getUnreferencedObjects()

Get all unreferenced objects.

Specified by:

getUnreferencedObjects in interface jadex.rules.state.IOAVState

Returns:

All unreferenced objects of the state.

findCycle

public java.util.List findCycle(java.util.Collection objects)

Find a cycle in a given set of objects.

Specified by:

findCycle in interface jadex.rules.state.IOAVState

getReferencingObjects

public java.util.Collection getReferencingObjects(java.lang.Object value)

Get those objects referencing a given object.

Specified by:

getReferencingObjects in interface jadex.rules.state.IOAVState

addExternalObjectUsage

public void addExternalObjectUsage(java.lang.Object id,
                                   java.lang.Object external)

Add an external usage of a state object. This prevents the oav object of being garbage collected as long as external references are present.

Specified by:

addExternalObjectUsage in interface jadex.rules.state.IOAVState

Parameters:

id - The oav object id.

external - The user object.

removeExternalObjectUsage

public void removeExternalObjectUsage(java.lang.Object id,
                                      java.lang.Object external)

Remove an external usage of a state object. This allows the oav object of being garbage collected when no further external references and no internal references are present.

Specified by:

removeExternalObjectUsage in interface jadex.rules.state.IOAVState

Parameters:

id - The oav object id.

external - The state external object.

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.Object object,
                                          jadex.rules.state.OAVAttributeType attribute)

Get an attribute value of an object.

Specified by:

getAttributeValue in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object.

attribute - The attribute identifier.

Returns:

The value (basic, object id or java object).

setAttributeValue

public void setAttributeValue(java.lang.Object object,
                              jadex.rules.state.OAVAttributeType attribute,
                              java.lang.Object value)

Set an attribute of an object to the given value.

Specified by:

setAttributeValue in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object.

attribute - The attribute identifier.

value - The value (basic, object id or java object).

getAttributeValues

public java.util.Collection getAttributeValues(java.lang.Object object,
                                               jadex.rules.state.OAVAttributeType attribute)

Get the values of an attribute of an object.

Specified by:

getAttributeValues in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object.

attribute - The attribute identifier.

Returns:

The values (basic, object ids or java objects).

getAttributeKeys

public java.util.Collection getAttributeKeys(java.lang.Object object,
                                             jadex.rules.state.OAVAttributeType attribute)

Get the keys of an attribute of an object.

Specified by:

getAttributeKeys in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object.

attribute - The attribute identifier.

Returns:

The keys for which values are stored.

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.Object object,
                                          jadex.rules.state.OAVAttributeType attribute,
                                          java.lang.Object key)

Get an attribute value of an object. Method only applicable for map attribute type.

Specified by:

getAttributeValue in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object.

attribute - The attribute identifier.

key - The key.

Returns:

The value (basic, object id or java object).

containsKey

public boolean containsKey(java.lang.Object object,
                           jadex.rules.state.OAVAttributeType attribute,
                           java.lang.Object key)

Test if a key is contained in the map attribute.

Specified by:

containsKey in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object.

attribute - The attribute identifier.

key - The key.

Returns:

True if key is available.

addAttributeValue

public void addAttributeValue(java.lang.Object object,
                              jadex.rules.state.OAVAttributeType attribute,
                              java.lang.Object value)

Add an attribute of an object to the given value.

Specified by:

addAttributeValue in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object.

attribute - The attribute identifier.

value - The value (basic, object id or java object).

removeAttributeValue

public void removeAttributeValue(java.lang.Object object,
                                 jadex.rules.state.OAVAttributeType attribute,
                                 java.lang.Object value)

Remove an attribute of an object to the given value.

Specified by:

removeAttributeValue in interface jadex.rules.state.IOAVState

Parameters:

object - The identifier of the object.

attribute - The attribute identifier.

value - The value (basic, object id or java object).

addStateListener

public void addStateListener(jadex.rules.state.IOAVStateListener listener,
                             boolean bunch)

Add a new state listener.

Specified by:

addStateListener in interface jadex.rules.state.IOAVState

Parameters:

listener - The state listener.

bunch - True, for adding a bunch listener.

removeStateListener

public void removeStateListener(jadex.rules.state.IOAVStateListener listener)

Remove a state listener.

Specified by:

removeStateListener in interface jadex.rules.state.IOAVState

Parameters:

listener - The state listener.

notifyEventListeners

public void notifyEventListeners()

Throw collected events and notify the listeners. Necessary if in event collecting mode.

Specified by:

notifyEventListeners in interface jadex.rules.state.IOAVState

expungeStaleObjects

public void expungeStaleObjects()

Expunge stale objects.

Specified by:

expungeStaleObjects in interface jadex.rules.state.IOAVState

setSynchronizator

public void setSynchronizator(jadex.commons.concurrent.ISynchronizator synchronizator)

Set the synchronizator. For the copy state, setting a synchronizator is required, as it is used to forward changes of the original state to the copy.

Specified by:

setSynchronizator in interface jadex.rules.state.IOAVState

getSynchronizator

public jadex.commons.concurrent.ISynchronizator getSynchronizator()

Get the synchronizator (if any). The synchronizator (if available) can be used to synchronize access to the state with internal and external modifications.

Specified by:

getSynchronizator in interface jadex.rules.state.IOAVState

getProfiler

public jadex.rules.state.IProfiler getProfiler()

Get the profiler.

Specified by:

getProfiler in interface jadex.rules.state.IOAVState

setProfiler

public void setProfiler(jadex.rules.state.IProfiler profiler)

Set the profiler.

Specified by:

setProfiler in interface jadex.rules.state.IOAVState

addSubstate

public void addSubstate(jadex.rules.state.IOAVState substate)

Add a substate. Read accesses will be transparently mapped to substates. Write accesses to substates need not be supported and may generate UnsupportedOperationException. Also it can not be assumed that addition of substates will generate object added events.

Specified by:

addSubstate in interface jadex.rules.state.IOAVState

getSubstates

public jadex.rules.state.IOAVState[] getSubstates()

Get the substates.

Specified by:

getSubstates in interface jadex.rules.state.IOAVState

equals

public boolean equals(java.lang.Object a,
                      java.lang.Object b)

Test if two values are equal according to current identity/equality settings.

Specified by:

equals in interface jadex.rules.state.IOAVState

isJavaIdentity

public boolean isJavaIdentity()

Flag indicating that java objects are stored by identity instead of equality.

Specified by:

isJavaIdentity in interface jadex.rules.state.IOAVState