heart

Class WorkingMemory

java.lang.Object

heart.WorkingMemory

public class WorkingMemory
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WorkingMemory.AVEntry

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_HISTORY_SIZE This constant defines maximal number of states stored in the historyLog.

Constructor Summary

Constructors

Constructor and Description
WorkingMemory() Default constructor for the working memory object.

Method Summary

Modifier and Type	Method and Description
State	findHistoricalState(java.util.LinkedList<State> states, RelativeTimestamp rt) It returns the historical state from the point in time indicated by the #rt parameter.
Value	findHistoricalValue(java.util.LinkedList<State> states, java.lang.String attributeName, RelativeTimestamp rt) It returns the historical value of the attribute which name was passed as the parameter from the point in time indicated by the #rt parameter.
java.util.LinkedList<Value>	findHistoricalValues(java.util.LinkedList<State> states, RelativeTimePeriod period, java.lang.String attributeName) The methods searches for values of an attribute given as a parameter in a specified time period.
AmbiguityResolver	getAmbiguityResolver() Returns ambiguity resolver that is currently set.
Attribute	getAttribute(java.lang.String attributeName)
Value	getAttributeValue(Attribute attr) The method return a value of an attribute of a given name.
Value	getAttributeValue(java.lang.String attributeName) The method return a value of an attribute of a given name.
State	getCurrentState() The method returns values of all registered attributes in a form of State object.
State	getCurrentState(XTTModel model) Returns the state of the system only for the registered attributes within the model
long	getCurrentTimestamp()
java.util.LinkedList<State>	getHistoryLog() It returns the entire history log with all the records made.
State	getSnapshot(java.lang.String snapshotName) It returns the state that represents the snapshot of a given name.
java.util.LinkedList<State>	getSnapshots() The method returns list of all snapshots made with the makeSnapshot(String) method.
boolean	isTimeLocked()
void	lockTime()
void	makeSnapshot(java.lang.String snapshotName) The method makes a snapshot of a current system state, by saving all the values of the registered attributes.
void	recordLog() It saves the state of the system at the time of the method is being call to the history log.
void	registerAllAttributes(XTTModel model) It registers all attributes from a given model Registering and unregistering is based on attributes names, not object refferences.
void	registerAttribute(Attribute attribute) It registers the attribute that later will be accessible and will be included in snapshots and current state.
void	registerAttribute(java.lang.String name, XTTModel model) It registers the attribute that later will be accessible and will be included in snapshots and current state.
void	resolveAmbiguousAttributesValues() A method that resolves all the ambiguous assignments that are present in the working memory.
void	setAmbiguityResolver(AmbiguityResolver ar) The method sets ambiguity resolver that resolves ambiguous assignments of values to the same attribute.
void	setAttributeValue(Attribute attribute, Value value, boolean autoregister) The method sets a given value to the attribute which is passed as a parameter.
void	setAttributeValue(java.lang.String attributeName, Value value) The method sets a given value to the attribute which name is passed as a parameter.
void	setCurrentState(State state, XTTModel model, boolean autoregister) The method sets values of the attributes defined by state parameter.
protected void	setCurrentTimestamp(long currentTimestamp)
void	unlockTime()
void	unregisterAll(XTTModel model) The method unregisters all the attribute from a model given as a parameter.
void	unregisterAttribute(java.lang.String name) It unregisters the attribute of a given name.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_HISTORY_SIZE

public static final int MAX_HISTORY_SIZE

This constant defines maximal number of states stored in the historyLog. This limit does not apply to snapshots.

See Also:

Constant Field Values

Constructor Detail

WorkingMemory

public WorkingMemory()

Default constructor for the working memory object.

Method Detail

setCurrentState

public void setCurrentState(State state,
                            XTTModel model,
                            boolean autoregister)
                     throws NotInTheDomainException,
                            AttributeNotRegisteredException

The method sets values of the attributes defined by state parameter. Depending on the autoregister parameter, the system registers all the attributes from the model.

Parameters:

state - a state to be set

model - the model from which the attributes values re to be set

autoregister - the parameter indicating if the method should register all the attributes from the model (if true) or none (if false).

Throws:

NotInTheDomainException

AttributeNotRegisteredException

getCurrentState

public State getCurrentState()

The method returns values of all registered attributes in a form of State object.

Returns:

the state that contains values of all registered attributes.

getCurrentState

public State getCurrentState(XTTModel model)

Returns the state of the system only for the registered attributes within the model

Parameters:

model - a model which attributes should be returned as a state

Returns:

the current state of the attributes values from the model given as a parameter

registerAttribute

public void registerAttribute(Attribute attribute)

It registers the attribute that later will be accessible and will be included in snapshots and current state. Registering and unregistering is based on attributes names, not object refferences.

Parameters:

attribute - an attribute to be registered

registerAttribute

public void registerAttribute(java.lang.String name,
                              XTTModel model)

It registers the attribute that later will be accessible and will be included in snapshots and current state. Registering and unregistering is based on attributes names, not object refferences.

Parameters:

name - a name of the attribute to register

model - a model where the attribute is located

registerAllAttributes

public void registerAllAttributes(XTTModel model)

It registers all attributes from a given model Registering and unregistering is based on attributes names, not object refferences.

Parameters:

model - a model from which the attributes have to be regisered

unregisterAttribute

public void unregisterAttribute(java.lang.String name)

It unregisters the attribute of a given name. If such attribute is no present in the register, nothing happens. Registering and unregistering is based on attributes names, not object refferences.

Parameters:

name - a name of the attribute to unregister

unregisterAll

public void unregisterAll(XTTModel model)

The method unregisters all the attribute from a model given as a parameter. Registering and unregistering is based on attributes names, not object refferences.

Parameters:

model - a model with attributes to unregister

getAttribute

public Attribute getAttribute(java.lang.String attributeName)

getAttributeValue

public Value getAttributeValue(java.lang.String attributeName)

The method return a value of an attribute of a given name. If the attribute is not registered, Null is returned.

Parameters:

attributeName - the attribute name which value is needed

Returns:

the value of the attribute or Null id the attribute is not registered

getAttributeValue

public Value getAttributeValue(Attribute attr)

The method return a value of an attribute of a given name. If the attribute is not registered, Null is returned.

Parameters:

attr - the attribute which value is needed

Returns:

the value of the attribute or Null if it is not registered

findHistoricalValue

public Value findHistoricalValue(java.util.LinkedList<State> states,
                                 java.lang.String attributeName,
                                 RelativeTimestamp rt)

It returns the historical value of the attribute which name was passed as the parameter from the point in time indicated by the #rt parameter. In case the relative timestamp is given as the number of milliseconds, the method may return a value that timestamp does not equal exactly the desired timestamp. This may happen when there is no such state in the registry. If there is no state of the given timestamp, the value from the state right before the timestamp is returned. When the relative timestamp is given in a form of state difference, the methods searches for the closest state that contains the value of the attribute of a name given as the parameters.

Parameters:

states - list of states where the value of the attribute is searched

attributeName - the name of the attribute which value should be found

rt - the number of states or milliseconds (counting backward from current state) where the search should begin

Returns:

the value of the attribute, or Null if such value does not exist

findHistoricalState

public State findHistoricalState(java.util.LinkedList<State> states,
                                 RelativeTimestamp rt)

It returns the historical state from the point in time indicated by the #rt parameter. In case the relative timestamp is given as the number of milliseconds, the method may return a state that timestamp does not equal exactly the desired timestamp. This may happen when there is no such state in the registry. If there is no state of the given timestamp, the state from right before the timestamp is returned. When the relative timestamp is given in a form of state difference, the method returns exactly the state of an index (counting backward) given by the relative timestamp.

Parameters:

states - list of states where the value of the attribute is searched

rt - the number of states or milliseconds (counting backward from current state) where the search should begin

Returns:

the state from a given point in time

findHistoricalValues

public java.util.LinkedList<Value> findHistoricalValues(java.util.LinkedList<State> states,
                                                        RelativeTimePeriod period,
                                                        java.lang.String attributeName)

The methods searches for values of an attribute given as a parameter in a specified time period. Time period is given as a relative time period with a step. If the step is smaller than intervals at which the states were saved, the virtual sampling is triggered.

Parameters:

states - list of states where the value of the attribute is searched

period - relative time period

attributeName - name of the attribute which values has to be found

Returns:

list of values of the attribute in a given period

setAttributeValue

public void setAttributeValue(java.lang.String attributeName,
                              Value value)
                       throws AttributeNotRegisteredException,
                              NotInTheDomainException

The method sets a given value to the attribute which name is passed as a parameter. It the attribute is not present in the WorkingMemmory registry, the AttributeNotRegisteredException is thrown.

Parameters:

attributeName - name of the attribute which value has to be set

value - the value to set

Throws:

AttributeNotRegisteredException

NotInTheDomainException

setAttributeValue

public void setAttributeValue(Attribute attribute,
                              Value value,
                              boolean autoregister)
                       throws AttributeNotRegisteredException,
                              NotInTheDomainException

The method sets a given value to the attribute which is passed as a parameter. It the attribute is not present in the WorkingMemmory registry, the AttributeNotRegisteredException is thrown in case when autoregister is set to false. In case when autoregister is set to true, the Attribute will be automatically registered in Working Memory registry.

Parameters:

attribute - the attribute which value has to be set

value - the value to set

autoregister - the parameter indicating if the method should register the attribute (if true) or none (if false).

Throws:

AttributeNotRegisteredException

NotInTheDomainException

resolveAmbiguousAttributesValues

public void resolveAmbiguousAttributesValues()

A method that resolves all the ambiguous assignments that are present in the working memory. This method is automatically called before reasoning process starts and in InferenceAlgorithm.onPostExecute() method. Before the reasoning, the ambiguity resolution is performed with the ambiguity resolver provided for the inference process. This methods clears the ambiguous values list.

setAmbiguityResolver

public void setAmbiguityResolver(AmbiguityResolver ar)

The method sets ambiguity resolver that resolves ambiguous assignments of values to the same attribute. It is not suggested to use this method while setting attributes values for the initial state as The ambiguity resolver will be used only during the inference process (when isTimeLocked() returns true. For other cases, calling setAttributeValue(String, Value) would override current attribute value without making the assignment ambiguous, even if called several times.

Parameters:

ar - Ambiguity resolver to be used. By default it is DefaultAmbiguityResolver

getAmbiguityResolver

public AmbiguityResolver getAmbiguityResolver()

Returns ambiguity resolver that is currently set.

Returns:

current ambiguity resolver

See Also:

#setAmbiguityResolver(AmbiguityResolver)}

makeSnapshot

public void makeSnapshot(java.lang.String snapshotName)

The method makes a snapshot of a current system state, by saving all the values of the registered attributes. It also automatically invokes recordLog() method.

Parameters:

snapshotName - the name of the snapshot.

getSnapshot

public State getSnapshot(java.lang.String snapshotName)

It returns the state that represents the snapshot of a given name.

Parameters:

snapshotName - a name of the snapshot to return

Returns:

a state representing the snapshot or null if the snapshot of a given name is not present

recordLog

public void recordLog()

It saves the state of the system at the time of the method is being call to the history log. It differs from the makeSnapshot(String) method as the logs are more anonymous, as they cannot have custom names, and what is more logs may be recorded automatically be the logging mechanism, whereas snapshots can only be made by the programmer explicitly with the makeSnapshot(String) call.

getHistoryLog

public java.util.LinkedList<State> getHistoryLog()

It returns the entire history log with all the records made.

Returns:

the list of all States made with the recordLog() method.

getSnapshots

public java.util.LinkedList<State> getSnapshots()

The method returns list of all snapshots made with the makeSnapshot(String) method.

Returns:

the list of all the snapshots made.

getCurrentTimestamp

public long getCurrentTimestamp()

setCurrentTimestamp

protected void setCurrentTimestamp(long currentTimestamp)

lockTime

public void lockTime()

unlockTime

public void unlockTime()

isTimeLocked

public boolean isTimeLocked()