com.serotonin.mango.rt.dataImage

Class AnnotatedPointValueTime

java.lang.Object

com.serotonin.mango.rt.dataImage.PointValueTime

com.serotonin.mango.rt.dataImage.AnnotatedPointValueTime

All Implemented Interfaces:

com.serotonin.json.JsonSerializable, IValueTime, java.io.Serializable

public class AnnotatedPointValueTime
extends PointValueTime

This class provides a way of arbitrarily annotating a PointValue. Point value annotations should not be confused with Java annotations. A point value annotation will typically explain the source of the value when it did not simply come from data source.

Author:

Matthew Lohbihler

See Also:

SetPointSource, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID
private java.lang.String	sourceDescriptionArgument An arbitrary description of the source, human readable.
private int	sourceId The id of the source that created the annotation.
private int	sourceType The type of source that created the annotation.

Constructor Summary

Constructors

Constructor and Description
AnnotatedPointValueTime(MangoValue value, long time, int sourceType, int sourceId)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnnotation(java.util.ResourceBundle bundle)
java.lang.String	getSourceDescriptionArgument()
java.lang.String	getSourceDescriptionKey()
int	getSourceId()
int	getSourceType()
boolean	isAnnotated()
void	setSourceDescriptionArgument(java.lang.String sourceDescriptionArgument)

Methods inherited from class com.serotonin.mango.rt.dataImage.PointValueTime

equals, equalValues, getBooleanValue, getDoubleValue, getIntegerValue, getStringValue, getTime, getValue, getValue, jsonDeserialize, jsonSerialize, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

sourceType

private final int sourceType

The type of source that created the annotation.

See Also:

SetPointSource

sourceId

private final int sourceId

The id of the source that created the annotation.

See Also:

SetPointSource

sourceDescriptionArgument

private java.lang.String sourceDescriptionArgument

An arbitrary description of the source, human readable. This depends on the source type, but will typically be the source's name. For example, for a user source it would be the username.

See Also:

SetPointSource

Constructor Detail

AnnotatedPointValueTime

public AnnotatedPointValueTime(MangoValue value,
                               long time,
                               int sourceType,
                               int sourceId)

Method Detail

isAnnotated

public boolean isAnnotated()

Overrides:

isAnnotated in class PointValueTime

getSourceId

public int getSourceId()

getSourceType

public int getSourceType()

getSourceDescriptionKey

public java.lang.String getSourceDescriptionKey()

getSourceDescriptionArgument

public java.lang.String getSourceDescriptionArgument()

setSourceDescriptionArgument

public void setSourceDescriptionArgument(java.lang.String sourceDescriptionArgument)

getAnnotation

public java.lang.String getAnnotation(java.util.ResourceBundle bundle)