PointValue (RVPF-Core API Documentation)

Object
- PointValue

All Implemented Interfaces:

Externalizable, Serializable, Mappable, Streamer.Validated

Direct Known Subclasses:

NormalizedValue, PointValue.Null, RecalcTrigger, ResultValue, SynthesizedValue, VersionedValue
```
@NotThreadSafe
public class PointValue
extends Object
implements Externalizable, Mappable, Streamer.Validated
```
Point value.
Instances of this class and subclasses represent point values inside and between the services. They hold a reference to a point definition, a time stamp, a state and a value. The point definition may be referenced by its UUID or by a point object holding at least the name of the point. The state and value may be null.

The Externalizable interface is implemented for transit thru RMI calls; transit as XML text is supported by the Mappable interface.

Convenience methods are supplied for encoding / decoding, normalization denormalization and for store updates.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PointValue.Null
Null.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PointValue.Null` Null.

Field Summary

Fields
Modifier and Type	Field and Description
`static PointValue`	`NULL` The null point value.
`static String`	`POINT_FIELD` Point field key.
`static String`	`STAMP_FIELD` Stamp field key.
`static String`	`STATE_FIELD` State field key.
`static String`	`UUID_FIELD` UUID field key.
`static String`	`VALUE_FIELD` Value field key.

Fields inherited from interface Mappable
SERIALIZABLE_MODE, SIMPLE_STRING_MODE

Constructor Summary

Constructors
Constructor and Description
`PointValue()` Constructs an instance.
`PointValue(Point point, Optional<DateTime> stamp, Serializable state, Serializable value)` Constructs an instance.
`PointValue(PointValue other)` Constructs an instance from an other.
`PointValue(String point, Optional<DateTime> stamp, Serializable state, Serializable value)` Constructs an instance.
`PointValue(UUID uuid, Optional<DateTime> stamp, Serializable state, Serializable value)` Constructs an instance from raw data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkNotFrozen()` Checks that the point value is not frozen.
`void`	`clearStamp()` Clears this value's time stamp.
`boolean`	`confirm(boolean confirmValue)` Confirms this.
`PointValue`	`copy()` Creates a copy of this point value.
`void`	`copyValueFrom(PointValue pointValue)` Copies the value from an other point value.
`PointValue`	`decoded()` Returns this or a decoded clone of this.
`PointValue`	`denormalized()` Denormalizes this.
`PointValue`	`encoded()` Returns this or an encoded clone of this.
`boolean`	`equals(Object object)`
`void`	`freeze()` Freezes this point value.
`PointValue`	`frozen()` Returns a frozen instance of this.
`Point`	`getNullablePoint()` Gets the point definition.
`Optional<Point>`	`getPoint()` Gets the point definition.
`Optional<String>`	`getPointName()` Gets the point's name.
`UUID`	`getPointUUID()` Gets the point's UUID.
`DateTime`	`getStamp()` Gets this value's time stamp.
`protected String`	`getStampString(DateTime.Context dateTimeContext)` Gets the time stamp string.
`Serializable`	`getState()` Gets this point value's state.
`protected String`	`getSynthesizedString()` Gets the 'synthesized' string.
`protected Logger`	`getThisLogger()` Gets the logger for this instance.
`Serializable`	`getValue()` Gets the actual value.
`protected DateTime`	`getVersion()` Gets this value's version.
`int`	`hashCode()`
`boolean`	`hasPointUUID()` Asks if this has a point UUID.
`boolean`	`hasStamp()` Asks if this has a stamp.
`boolean`	`isAbsent()` Asks if this point value is absent.
`boolean`	`isCacheable()` Asks if this point value may be cached.
`boolean`	`isDeleted()` Asks if this point value is (going to be) deleted.
`boolean`	`isExtrapolated()` Asks if this point value is extrapolated.
`boolean`	`isFrozen()` Gets the frozen indicator.
`boolean`	`isInterpolated()` Asks if this point value is interpolated.
`boolean`	`isNormalized()` Asks if this point value is normalized.
`boolean`	`isPresent()` Asks if this point value is present.
`boolean`	`isSynthesized()` Asks if this point value is synthesized.
`PointValue`	`morph(Optional<Point> point, Optional<DateTime> stamp)` Morphs this into a point value for an other point and/or an other time.
`PointValue`	`morph(Optional<UUID> uuid)` Morphs this into a point value for an other point.
`NormalizedValue`	`normalized()` Normalizes this point value.
`String`	`pointString()` Returns a string identification of the point.
`void`	`readExternal(ObjectInput input)`
`void`	`readMap(Map<String,Serializable> map)` Reads a map of the fields.
`PointValue`	`reset()` Substitutes serialization/deserialization.
`PointValue`	`restore(Point point)` Restores the reference to the point definition.
`PointValue`	`restore(Points points)` Restores the reference to the point definition.
`boolean`	`sameValueAs(PointValue pointValue)` Asks if an other point value has the same value.
`protected void`	`setFrozen()` Sets the frozen indicator.
`void`	`setPointName(String name)` Sets the point's name.
`void`	`setPointUUID(UUID uuid)` Sets the point's UUID.
`void`	`setStamp(DateTime stamp)` Sets this value's time stamp.
`void`	`setState(Serializable state)` Sets this value's state.
`void`	`setValue(Serializable value)` Sets the actual value.
`protected void`	`setVersion(DateTime version)` Sets this value's version.
`PointValue`	`thawed()` Returns a thawed instance of this.
`Double`	`toDouble()` Returns the value as a double floating-point value.
`Long`	`toLong()` Returns the value as a long value.
`String`	`toString()`
`String`	`toString(DateTime.Context dateTimeContext)` Returns a string representation of itself.
`boolean`	`updateStore()` Updates the store with this.
`boolean`	`validate()` Validates.
`String`	`valueString()` Returns a simple representation of the value.
`void`	`writeExternal(ObjectOutput output)`
`void`	`writeMap(Map<String,Serializable> map)` Writes a map of the fields.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NULL
```
public static final PointValue NULL
```
    The null point value.
  - POINT_FIELD
```
public static final String POINT_FIELD
```
    Point field key.
    
    See Also:
    
    Constant Field Values
  - STAMP_FIELD
```
public static final String STAMP_FIELD
```
    Stamp field key.
    
    See Also:
    
    Constant Field Values
  - STATE_FIELD
```
public static final String STATE_FIELD
```
    State field key.
    
    See Also:
    
    Constant Field Values
  - UUID_FIELD
```
public static final String UUID_FIELD
```
    UUID field key.
    
    See Also:
    
    Constant Field Values
  - VALUE_FIELD
```
public static final String VALUE_FIELD
```
    Value field key.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PointValue
```
public PointValue()
```
    Constructs an instance.
    This is needed for an Externalizable implementation. It is also used as a never matching reference.
  - PointValue
```
public PointValue(@Nonnull
                  PointValue other)
```
    Constructs an instance from an other.
    The copy will be a shallow clone of the original.
    
    Parameters:
    
    other - The other point value.
  - PointValue
```
public PointValue(@Nonnull
                  Point point,
                  @Nonnull
                  Optional<DateTime> stamp,
                  @Nullable
                  Serializable state,
                  @Nullable
                  Serializable value)
```
    Constructs an instance.
    
    Parameters:
    
    point - The point definition.
    
    stamp - The optional time stamp of the value.
    
    state - The state.
    
    value - The value.
  - PointValue
```
public PointValue(@Nonnull
                  String point,
                  @Nonnull
                  Optional<DateTime> stamp,
                  @Nullable
                  Serializable state,
                  @Nullable
                  Serializable value)
```
    Constructs an instance.
    
    Parameters:
    
    point - A string identifying the point.
    
    stamp - The optional time stamp of the value.
    
    state - The state.
    
    value - The value.
  - PointValue
```
public PointValue(@Nonnull
                  UUID uuid,
                  @Nonnull
                  Optional<DateTime> stamp,
                  @Nullable
                  Serializable state,
                  @Nullable
                  Serializable value)
```
    Constructs an instance from raw data.
    
    Parameters:
    
    uuid - The UUID of the point definition.
    
    stamp - The optional time stamp of the value.
    
    state - The state.
    
    value - The value.
- Method Detail
  - clearStamp
```
public final void clearStamp()
```
    Clears this value's time stamp.
  - confirm
```
@CheckReturnValue
public final boolean confirm(boolean confirmValue)
                                         throws InterruptedException,
                                                StoreAccessException
```
    Confirms this.
    Note: the point reference must be set and its store must be able to confirm.
    
    Parameters:
    
    confirmValue - When true, sameValueAs(org.rvpf.base.value.PointValue) should be called.
    
    Returns:
    
    True when confirmed.
    
    Throws:
    
    InterruptedException - When interrupted.
    
    StoreAccessException - When store access fails.
  - copy
```
@Nonnull
 @CheckReturnValue
public PointValue copy()
```
    Creates a copy of this point value.
    
    Returns:
    
    The copy.
  - copyValueFrom
```
public void copyValueFrom(@Nonnull
                          PointValue pointValue)
```
    Copies the value from an other point value.
    A subclass supporting additional value informations should override this method.
    
    Used by the processor's batch.
    
    Parameters:
    
    pointValue - The source point value.
  - decoded
```
@Nonnull
 @CheckReturnValue
public final PointValue decoded()
```
    Returns this or a decoded clone of this.
    
    Returns:
    
    A decoded point value.
  - denormalized
```
@Nonnull
 @CheckReturnValue
public PointValue denormalized()
```
    Denormalizes this.
    This method is overriden by NormalizedValue. Other point value classes, including this one, assume that their value is not normalized.
    
    Returns:
    
    The denormalized value.
  - encoded
```
@Nonnull
 @CheckReturnValue
public final PointValue encoded()
```
    Returns this or an encoded clone of this.
    
    Returns:
    
    A encoded point value.
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - freeze
```
public final void freeze()
```
    Freezes this point value.
  - frozen
```
@Nonnull
 @CheckReturnValue
public PointValue frozen()
```
    Returns a frozen instance of this.
    
    Returns:
    
    This if frozen, or a frozen clone.
  - getNullablePoint
```
@Nullable
 @CheckReturnValue
public final Point getNullablePoint()
```
    Gets the point definition.
    Needed by a comparator.
    
    Returns:
    
    The point definition (null if missing).
  - getPoint
```
@Nonnull
 @CheckReturnValue
public final Optional<Point> getPoint()
```
    Gets the point definition.
    
    Returns:
    
    The optional point definition.
  - getPointName
```
@Nonnull
 @CheckReturnValue
public final Optional<String> getPointName()
```
    Gets the point's name.
    
    Returns:
    
    The optional point's name.
  - getPointUUID
```
@Nonnull
 @CheckReturnValue
public final UUID getPointUUID()
```
    Gets the point's UUID.
    
    Returns:
    
    The point's UUID.
  - getStamp
```
@Nonnull
 @CheckReturnValue
public final DateTime getStamp()
```
    Gets this value's time stamp.
    
    Returns:
    
    The time stamp.
  - getState
```
@Nullable
 @CheckReturnValue
public final Serializable getState()
```
    Gets this point value's state.
    
    Returns:
    
    The state (may have a null value).
  - getValue
```
@Nullable
 @CheckReturnValue
public final Serializable getValue()
```
    Gets the actual value.
    
    Returns:
    
    The value (may have a null value).
  - hasPointUUID
```
@CheckReturnValue
public boolean hasPointUUID()
```
    Asks if this has a point UUID.
    
    Returns:
    
    True if this has a point UUID.
  - hasStamp
```
@CheckReturnValue
public boolean hasStamp()
```
    Asks if this has a stamp.
    
    Returns:
    
    True if this has a stamp.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isAbsent
```
@CheckReturnValue
public boolean isAbsent()
```
    Asks if this point value is absent.
    
    Returns:
    
    True if absent.
  - isCacheable
```
@CheckReturnValue
public final boolean isCacheable()
```
    Asks if this point value may be cached.
    
    Returns:
    
    True if it may be cached.
  - isDeleted
```
@CheckReturnValue
public boolean isDeleted()
```
    Asks if this point value is (going to be) deleted.
    A subclass may override this method to supply this functionality.
    
    Returns:
    
    True when this is (going to be) deleted.
    
    See Also:
    
    VersionedValue.Deleted.isDeleted()
  - isExtrapolated
```
@CheckReturnValue
public boolean isExtrapolated()
```
    Asks if this point value is extrapolated.
    
    Returns:
    
    True if this value is extrapolated.
  - isFrozen
```
@CheckReturnValue
public final boolean isFrozen()
```
    Gets the frozen indicator.
    
    Returns:
    
    The frozen indicator.
  - isInterpolated
```
@CheckReturnValue
public boolean isInterpolated()
```
    Asks if this point value is interpolated.
    
    Returns:
    
    True if this value is interpolated.
  - isNormalized
```
@CheckReturnValue
public boolean isNormalized()
```
    Asks if this point value is normalized.
    
    Returns:
    
    True if this value is normalized.
  - isPresent
```
@CheckReturnValue
public final boolean isPresent()
```
    Asks if this point value is present.
    
    Returns:
    
    True if present.
  - isSynthesized
```
@CheckReturnValue
public boolean isSynthesized()
```
    Asks if this point value is synthesized.
    
    Returns:
    
    True if this value is synthesized.
  - morph
```
@Nonnull
 @CheckReturnValue
public PointValue morph(@Nonnull
                                                      Optional<UUID> uuid)
```
    Morphs this into a point value for an other point.
    
    Parameters:
    
    uuid - The other point's optional UUID.
    
    Returns:
    
    The morphed point value.
  - morph
```
@Nonnull
 @CheckReturnValue
public final PointValue morph(@Nonnull
                                                            Optional<Point> point,
                                                            @Nonnull
                                                            Optional<DateTime> stamp)
```
    Morphs this into a point value for an other point and/or an other time.
    
    Parameters:
    
    point - The other point (may be empty).
    
    stamp - The other time (may be empty).
    
    Returns:
    
    The morphed point value (this if same).
  - normalized
```
@Nonnull
 @CheckReturnValue
public NormalizedValue normalized()
```
    Normalizes this point value.
    The point's content instance is called to perform the actual normalization.
    
    Returns:
    
    The normalized value.
  - pointString
```
@Nonnull
 @CheckReturnValue
public final String pointString()
```
    Returns a string identification of the point.
    
    Returns:
    
    The string identification.
  - readExternal
```
public void readExternal(ObjectInput input)
                  throws IOException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
  - readMap
```
public void readMap(Map<String,Serializable> map)
```
    Reads a map of the fields.
    
    Specified by:
    
    readMap in interface Mappable
    
    Parameters:
    
    map - The source map.
  - reset
```
@Nonnull
 @CheckReturnValue
public final PointValue reset()
```
    Substitutes serialization/deserialization.
    
    Returns:
    
    The reset clone.
  - restore
```
@Nonnull
 @CheckReturnValue
public final PointValue restore(@Nullable
                                                              Point point)
```
    Restores the reference to the point definition.
    This is used in the deserialization process.
    
    Parameters:
    
    point - The point's definition.
    
    Returns:
    
    The point value.
  - restore
```
@Nonnull
 @CheckReturnValue
public final PointValue restore(@Nonnull
                                                              Points points)
```
    Restores the reference to the point definition.
    
    Parameters:
    
    points - The points from which to get the point's definition.
    
    Returns:
    
    The point value.
  - sameValueAs
```
@CheckReturnValue
public boolean sameValueAs(@Nonnull
                                              PointValue pointValue)
```
    Asks if an other point value has the same value.
    A subclass supporting additional value informations should override this method.
    
    Parameters:
    
    pointValue - The other point value.
    
    Returns:
    
    True if the contained values are equal.
  - setPointName
```
public final void setPointName(@Nonnull
                               String name)
```
    Sets the point's name.
    
    Parameters:
    
    name - The point's name.
  - setPointUUID
```
public final void setPointUUID(@Nonnull
                               UUID uuid)
```
    Sets the point's UUID.
    
    Parameters:
    
    uuid - The point's UUID.
  - setStamp
```
public final void setStamp(@Nonnull
                           DateTime stamp)
```
    Sets this value's time stamp.
    
    Parameters:
    
    stamp - The time stamp.
  - setState
```
public final void setState(@Nullable
                           Serializable state)
```
    Sets this value's state.
    
    Parameters:
    
    state - The state.
  - setValue
```
public final void setValue(@Nullable
                           Serializable value)
```
    Sets the actual value.
    
    Parameters:
    
    value - The value.
  - thawed
```
@Nonnull
 @CheckReturnValue
public PointValue thawed()
```
    Returns a thawed instance of this.
    
    Returns:
    
    A clone if frozen, or this.
  - toDouble
```
@Nullable
 @CheckReturnValue
public Double toDouble()
```
    Returns the value as a double floating-point value.
    
    Returns:
    
    The value (may be null).
  - toLong
```
@Nullable
 @CheckReturnValue
public Long toLong()
```
    Returns the value as a long value.
    
    Returns:
    
    The value (null on failure).
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
@Nonnull
 @CheckReturnValue
public final String toString(@Nonnull
                                                           DateTime.Context dateTimeContext)
```
    Returns a string representation of itself.
    
    Parameters:
    
    dateTimeContext - The date-time context.
    
    Returns:
    
    The string representation of itsself.
  - updateStore
```
@CheckReturnValue
public final boolean updateStore()
                                             throws InterruptedException,
                                                    StoreAccessException
```
    Updates the store with this.
    
    Returns:
    
    True on success.
    
    Throws:
    
    InterruptedException - When the service is stopped.
    
    StoreAccessException - When store access fails.
  - validate
```
public boolean validate()
```
    Validates.
    
    Specified by:
    
    validate in interface Streamer.Validated
    
    Returns:
    
    True when valid.
  - valueString
```
@Nonnull
 @CheckReturnValue
public String valueString()
```
    Returns a simple representation of the value.
    
    Returns:
    
    A simple representation of the value.
  - writeExternal
```
public void writeExternal(ObjectOutput output)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - writeMap
```
public void writeMap(Map<String,Serializable> map)
```
    Writes a map of the fields.
    
    Specified by:
    
    writeMap in interface Mappable
    
    Parameters:
    
    map - The destination map.
  - checkNotFrozen
```
protected final void checkNotFrozen()
```
    Checks that the point value is not frozen.
  - getStampString
```
@Nonnull
 @CheckReturnValue
protected String getStampString(@Nonnull
                                                              DateTime.Context dateTimeContext)
```
    Gets the time stamp string.
    
    Parameters:
    
    dateTimeContext - The date-time context.
    
    Returns:
    
    The time stamp string.
  - getSynthesizedString
```
@Nonnull
 @CheckReturnValue
protected String getSynthesizedString()
```
    Gets the 'synthesized' string.
    
    Returns:
    
    The 'synthesized' string.
  - getThisLogger
```
@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()
```
    Gets the logger for this instance.
    
    Returns:
    
    The logger for this instance.
  - getVersion
```
@CheckReturnValue
protected DateTime getVersion()
```
    Gets this value's version.
    
    Returns:
    
    The version (null when not available).
  - setFrozen
```
protected final void setFrozen()
```
    Sets the frozen indicator.
  - setVersion
```
protected void setVersion(DateTime version)
```
    Sets this value's version.
    
    Parameters:
    
    version - The version.

Class PointValue

Nested Class Summary

Field Summary

Fields inherited from interface Mappable

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

NULL

POINT_FIELD

STAMP_FIELD

STATE_FIELD

UUID_FIELD

VALUE_FIELD

Constructor Detail

PointValue

PointValue

PointValue

PointValue

PointValue

Method Detail

clearStamp

confirm

copy

copyValueFrom

decoded

denormalized

encoded

equals

freeze

frozen

getNullablePoint

getPoint

getPointName

getPointUUID

getStamp

getState

getValue

hasPointUUID

hasStamp

hashCode

isAbsent

isCacheable

isDeleted

isExtrapolated

isFrozen

isInterpolated

isNormalized

isPresent

isSynthesized

morph

morph

normalized

pointString

readExternal

readMap

reset

restore

restore

sameValueAs

setPointName

setPointUUID

setStamp

setState

setValue

thawed

toDouble

toLong

toString

toString

updateStore

validate

valueString

writeExternal

writeMap

checkNotFrozen

getStampString

getSynthesizedString

getThisLogger

getVersion