heart

Class StateElement

java.lang.Object

heart.StateElement

public class StateElement
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	attributeName The name of the attribute that the value is stored by this state element.
protected java.lang.String	id This field is used by the SQL module while storing/restoring model into/from database.
protected long	timestamp Timestamp in milliseconds indicating when the attribute value was assigned.
protected Value	value The value of the attribute.

Constructor Summary

Constructors

Constructor and Description
StateElement() default constructor.
StateElement(java.lang.String attributeName, Value value) The constructor creates StateElement object, and it sets the timestamp to the current system time.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeName() The method that retrievs the attribute name that value is retained in this state element
long	getTimestamp() A method returns the timestamp of the state element.
Value	getValue() The method returns the value of the attribute
void	setAttributeName(java.lang.String attributeName) The method sets the attribute name for this state element.
void	setCurrentTimestamp() The method sets the timestam of the state element to the current system time.
void	setTimestamp(long timestamp) The method allow to set the timestamp for the state element.
void	setValue(Value value) The method that sets the value for the attribute in this state element.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.String id

This field is used by the SQL module while storing/restoring model into/from database. If not provided, this should be null;

attributeName

protected java.lang.String attributeName

The name of the attribute that the value is stored by this state element.

value

protected Value value

The value of the attribute.

timestamp

protected long timestamp

Timestamp in milliseconds indicating when the attribute value was assigned. This is the copy of a timestamp from the Attribute object.

Constructor Detail

StateElement

public StateElement()

default constructor. It sets timestampto the current system time and leaves all the other fields to be null

StateElement

public StateElement(java.lang.String attributeName,
                    Value value)

The constructor creates StateElement object, and it sets the timestamp to the current system time.

Parameters:

attributeName - the attribute name that value should be tored in the state element

value - the value of the attribute that should be assigned to it

Method Detail

getAttributeName

public java.lang.String getAttributeName()

The method that retrievs the attribute name that value is retained in this state element

Returns:

the attributes name that value is stored within this state element.

setAttributeName

public void setAttributeName(java.lang.String attributeName)

The method sets the attribute name for this state element.

Parameters:

attributeName - a name to be set

getValue

public Value getValue()

The method returns the value of the attribute

Returns:

the value of the attribute

setValue

public void setValue(Value value)

The method that sets the value for the attribute in this state element. Note, that his method does not check if the value can be assigned to the attribute. In particular you can assign a SetValue to a simple attribute and it will pass. The exception will be thrown only when you try to assign this state to the model.

Parameters:

value -

setCurrentTimestamp

public void setCurrentTimestamp()

The method sets the timestam of the state element to the current system time. It uses System.currentTimeMillis() method.

getTimestamp

public long getTimestamp()

A method returns the timestamp of the state element.

Returns:

the timestam of the state element

setTimestamp

public void setTimestamp(long timestamp)

The method allow to set the timestamp for the state element. In most cases you would preffer to use setCurrentTimestamp() instead.

Parameters:

timestamp - a timestamp to set