rle.core.data
Class RuntimeData

java.lang.Object
  rle.core.data.RuntimeData

public class RuntimeData
extends java.lang.Object

Class to manage a runtime data set of possibly related attributes. This class requires a list of InfoView objects specifying legal attributes.

 The parameters:
 dependencies - a List of legal attributes an attribute depends on
 type - COMPUTED attributes cannot be set directly, but must be computed
        using a PlugIn RuntimeComputer.
        CONSTANT attributes must be set by the Variant Manager, and can't change
        PERSISTENT attributes are saved in save files, and not computed.
 computer.classname - the RuntimeComputer for computed values
 computer.parameters - parameters to the RuntimeComputer
 

Field Summary

protected java.util.HashMap<java.lang.String,InfoView>	attributes
protected java.util.HashSet<java.lang.String>	disposedKeys
protected java.lang.Object	owner
protected java.util.HashMap<java.lang.String,java.lang.Object>	values

Constructor Summary

RuntimeData()
Constructor with null owner.

RuntimeData(java.lang.Object owner)
Constructor with owner.

RuntimeData(java.lang.Object owner, RuntimeData toCopy)
Constructor with owner and data to copy.

Method Summary

void	addDisposalListener(DisposalListener dl) Add a DisposalListener that will be notified of all property changes
void	addDisposalListener(java.lang.String prop, DisposalListener dl) Add a DisposalListener that will be notified only of changes to a single property.
void	addRuntimeDataListener(RuntimeDataListener pcl) Add a RuntimeDataListener that will be notified of all property changes
void	addRuntimeDataListener(java.lang.String prop, RuntimeDataListener pcl) Add a RuntimeDataListener that will be notified only of changes to a single property.
boolean	check(java.lang.String s) Attempt to retrieve the boolean value s.
protected java.lang.Object	compute(InfoView attribute) Determine the value for attribute using the specified RuntimeComputer.
void	disposeAllComputed() Dispose all computed attributes.
void	disposeComputed(InfoView attribute) Remove any existing value for this computed attribute.
void	disposeComputed(java.lang.String key) Dispose the attribute represented by key, which must be computed.
protected java.util.Set<InfoView>	findDependentAttributes(InfoView attribute) Find the attributes which depend on attribute.
void	fireDisposal(java.lang.String property) Notify all DisposalListeners that a value has changed.
void	firePropertyChange(java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue, Cause cause) Notify all RuntimeDataListeners that a value has changed.
java.lang.Object	get(java.lang.String key) Get the value for attribute key.
java.lang.Number	getConstant(java.lang.String key) Return a view of the lookup table attribute specified by key.
java.lang.Integer	getInt(java.lang.String s) Attempt to retrieve an int value using StringUtil.intValue()
LookupTableView	getLookupTable(java.lang.String key) Return a view of the lookup table attribute specified by key.
java.lang.Object	getOwner()
java.lang.String	getString(java.lang.String name) Get a "safe" String value.
protected void	putValue(java.lang.String key, java.lang.Object oldValue, java.lang.Object newValue, Cause cause) Directly sets a value, be it computed, costant or persistent, and calls firePropertyChange().
void	removeDisposalListener(DisposalListener dl) Remove a DisposalListener that was to be notified of all property changes
void	removeDisposalListener(java.lang.String prop, DisposalListener dl) Remove a DisposalListener that was to be notified only of changes to a single property.
void	removeRuntimeDataListener(RuntimeDataListener pcl) Remove a RuntimeDataListener that was to be notified of all property changes
void	removeRuntimeDataListener(java.lang.String prop, RuntimeDataListener pcl) Remove a RuntimeDataListener that was to be notified only of changes to a single property.
void	set(java.lang.String key, java.lang.Object value)
void	set(java.lang.String key, java.lang.Object value, Cause cause) Set the value for the attribute key.
void	setAttributeList(java.util.List<InfoView> list) Set the list of legal attributes.
void	setOwner(java.lang.Object owner)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

owner

protected java.lang.Object owner

values

protected java.util.HashMap<java.lang.String,java.lang.Object> values

attributes

protected java.util.HashMap<java.lang.String,InfoView> attributes

disposedKeys

protected java.util.HashSet<java.lang.String> disposedKeys

Constructor Detail

RuntimeData

public RuntimeData(java.lang.Object owner,
                   RuntimeData toCopy)

Constructor with owner and data to copy.

RuntimeData

public RuntimeData(java.lang.Object owner)

Constructor with owner.

RuntimeData

public RuntimeData()

Constructor with null owner.

Method Detail

getOwner

public java.lang.Object getOwner()

setOwner

public void setOwner(java.lang.Object owner)

setAttributeList

public void setAttributeList(java.util.List<InfoView> list)

Set the list of legal attributes.

getLookupTable

public LookupTableView getLookupTable(java.lang.String key)

Return a view of the lookup table attribute specified by key.

getConstant

public java.lang.Number getConstant(java.lang.String key)

Return a view of the lookup table attribute specified by key.

getString

public java.lang.String getString(java.lang.String name)

Get a "safe" String value. Will not return null; if get() returns null, will return "". If get() returns a non-String, toString() will be called.

Parameters:

name -

Returns:

getInt

public java.lang.Integer getInt(java.lang.String s)

Attempt to retrieve an int value using StringUtil.intValue()

Parameters:

s -

Returns:

check

public boolean check(java.lang.String s)

Attempt to retrieve the boolean value s.

Parameters:

s -

Returns:

get

public java.lang.Object get(java.lang.String key)

Get the value for attribute key. An invalid key will cause an IllegalArgumentException. If the attribute represented by key is "computed", the value will be found using compute() if necessary. Non-computed attributes simply return the current value, if any.

Parameters:

key -

Returns:

compute

protected java.lang.Object compute(InfoView attribute)

Determine the value for attribute using the specified RuntimeComputer.

Parameters:

attribute -

Returns:

putValue

protected void putValue(java.lang.String key,
                        java.lang.Object oldValue,
                        java.lang.Object newValue,
                        Cause cause)

Directly sets a value, be it computed, costant or persistent, and calls firePropertyChange(). Do not call this directly!

Parameters:

key -

oldValue -

newValue -

disposeComputed

public void disposeComputed(InfoView attribute)

Remove any existing value for this computed attribute. This will also dispose any attributes which depend on attribute.

Parameters:

attribute -

disposeComputed

public void disposeComputed(java.lang.String key)

Dispose the attribute represented by key, which must be computed.

Parameters:

key -

disposeAllComputed

public void disposeAllComputed()

Dispose all computed attributes. This should be called before persisting this data, because computed values by definition can be reconstituted later from persistent values.

set

public void set(java.lang.String key,
                java.lang.Object value)

set

public void set(java.lang.String key,
                java.lang.Object value,
                Cause cause)

Set the value for the attribute key. Attempting to call this for a computed attribute will cause an IllegalArgumentException. After setting the new value, all attributes which depend on key will be disposed.

Parameters:

key -

value -

findDependentAttributes

protected java.util.Set<InfoView> findDependentAttributes(InfoView attribute)

Find the attributes which depend on attribute.

fireDisposal

public void fireDisposal(java.lang.String property)

Notify all DisposalListeners that a value has changed.

Parameters:

property -

oldValue -

newValue -

addDisposalListener

public void addDisposalListener(DisposalListener dl)

Add a DisposalListener that will be notified of all property changes

Parameters:

dl -

removeDisposalListener

public void removeDisposalListener(DisposalListener dl)

Remove a DisposalListener that was to be notified of all property changes

Parameters:

dl -

addDisposalListener

public void addDisposalListener(java.lang.String prop,
                                DisposalListener dl)

Add a DisposalListener that will be notified only of changes to a single property.

Parameters:

prop - - the property we're interested in

dl -

removeDisposalListener

public void removeDisposalListener(java.lang.String prop,
                                   DisposalListener dl)

Remove a DisposalListener that was to be notified only of changes to a single property.

Parameters:

prop - - the property we're interested in

dl -

firePropertyChange

public void firePropertyChange(java.lang.String property,
                               java.lang.Object oldValue,
                               java.lang.Object newValue,
                               Cause cause)

Notify all RuntimeDataListeners that a value has changed.

Parameters:

property -

oldValue -

newValue -

addRuntimeDataListener

public void addRuntimeDataListener(RuntimeDataListener pcl)

Add a RuntimeDataListener that will be notified of all property changes

Parameters:

pcl -

removeRuntimeDataListener

public void removeRuntimeDataListener(RuntimeDataListener pcl)

Remove a RuntimeDataListener that was to be notified of all property changes

Parameters:

pcl -

addRuntimeDataListener

public void addRuntimeDataListener(java.lang.String prop,
                                   RuntimeDataListener pcl)

Add a RuntimeDataListener that will be notified only of changes to a single property.

Parameters:

prop - - the property we're interested in

pcl -

removeRuntimeDataListener

public void removeRuntimeDataListener(java.lang.String prop,
                                      RuntimeDataListener pcl)

Remove a RuntimeDataListener that was to be notified only of changes to a single property.

Parameters:

prop - - the property we're interested in

pcl -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object