org.eclipse.scada.da.client

Class DataItemValue

java.lang.Object

org.eclipse.scada.da.client.DataItemValue

public class DataItemValue
extends Object

A current value snapshot of the DataItem

Author:

Jens Reimann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataItemValue.Builder A mutable version of DataItemValue

Field Summary

Fields

Modifier and Type	Field and Description
static DataItemValue	DISCONNECTED A default instance that means disconnected

Constructor Summary

Constructors

Constructor and Description
DataItemValue(DataItemValue div)
DataItemValue(Variant value, Map<String,Variant> attributes, SubscriptionState subscriptionState)
DataItemValue(Variant value, Map<String,Variant> attributes, SubscriptionState subscriptionState, Throwable subscriptionError)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Calendar	getAsTimestamp(Map<String,Variant> attributes, String attributeName) get an attribute as timestamp
Calendar	getAsTimestamp(String attributeName) get an attribute as timestamp
boolean	getAttributeAsBoolean(String attributeName) Get an attribute as boolean value
Boolean	getAttributeAsBoolean(String attributeName, Boolean defaultValue)
Map<String,Variant>	getAttributes() Get an unmodifiable map of the attributes
Throwable	getSubscriptionError()
String	getSubscriptionErrorString() Get the message of the subscription error
SubscriptionState	getSubscriptionState()
Calendar	getTimestamp() get the timestamp of the value
Variant	getValue()
int	hashCode()
boolean	isAlarm()
Boolean	isAttribute(String attributeName) Get the value of the attribute
boolean	isAttribute(String attributeName, boolean defaultValue) Get the boolean value of the named attribute
boolean	isBlocked()
boolean	isConnected()
boolean	isError()
boolean	isManual() Check if the value has the manual override attribute set
boolean	isWarning()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DISCONNECTED

public static final DataItemValue DISCONNECTED

A default instance that means disconnected

Since:

0.17.0

Constructor Detail

DataItemValue

public DataItemValue(Variant value,
                     Map<String,Variant> attributes,
                     SubscriptionState subscriptionState)

DataItemValue

public DataItemValue(Variant value,
                     Map<String,Variant> attributes,
                     SubscriptionState subscriptionState,
                     Throwable subscriptionError)

DataItemValue

public DataItemValue(DataItemValue div)

Method Detail

getValue

public Variant getValue()

getAttributes

public Map<String,Variant> getAttributes()

Get an unmodifiable map of the attributes

Returns:

an unmodifiable map of the attributes

getSubscriptionState

public SubscriptionState getSubscriptionState()

getSubscriptionErrorString

public String getSubscriptionErrorString()

Get the message of the subscription error

Returns:

the message of the subscription error or null if no subscription error is known

getSubscriptionError

public Throwable getSubscriptionError()

isAttribute

public Boolean isAttribute(String attributeName)

Get the value of the attribute

Parameters:

attributeName - the name of the attribute

Returns:

the value of the attribute or null if the attribute is not set

isAttribute

public boolean isAttribute(String attributeName,
                           boolean defaultValue)

Get the boolean value of the named attribute

Parameters:

attributeName - the attribute name to check

defaultValue - the default value, if the attribute is not set

Returns:

the attribute value or the default value it the attribute is not available

isManual

public boolean isManual()

Check if the value has the manual override attribute set

Returns:

true if the value is manually overridden, false otherwise

isAlarm

public boolean isAlarm()

isBlocked

public boolean isBlocked()

isWarning

public boolean isWarning()

isConnected

public boolean isConnected()

isError

public boolean isError()

getAsTimestamp

public static Calendar getAsTimestamp(Map<String,Variant> attributes,
                                      String attributeName)

get an attribute as timestamp

Parameters:

attributeName - the attribute to get

Returns:

the timestamp or null if the timestamp property is not set

getAsTimestamp

public Calendar getAsTimestamp(String attributeName)

get an attribute as timestamp

Parameters:

attributeName - the attribute to get

Returns:

the timestamp or null if the timestamp property is not set

getAttributeAsBoolean

public boolean getAttributeAsBoolean(String attributeName)

Get an attribute as boolean value

Parameters:

attributeName - the name of the attribute to fetch

Returns:

the value of the attribute or false if the attribute is not set

See Also:

Variant.asBoolean()

getAttributeAsBoolean

public Boolean getAttributeAsBoolean(String attributeName,
                                     Boolean defaultValue)

getTimestamp

public Calendar getTimestamp()

get the timestamp of the value

Returns:

the timestamp or null if the timestamp property is not set

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object