org.rvpf.content

Class UnitValueContent

Object

Proxied.Abstract

AbstractContent

NumberContent

FloatingPointContent

DoubleContent

UnitValueContent

All Implemented Interfaces:

Content, Proxied

Direct Known Subclasses:

TemperatureContent

public class UnitValueContent
extends DoubleContent

Unit value content converter.

This content converter extends the DoubleContent content converter by specifying a multiplier whose value comes from the 'Multiplier' param. This multiplier is used as a divisor during denormalization.

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIPLIER_PARAM Conversion factor.

Constructor Summary

Constructors

Constructor and Description
UnitValueContent()

Method Summary

Modifier and Type	Method and Description
Double	denormalize(NormalizedValue normalizedValue) Denormalizes the value of a point value.
protected double	getMultiplier() Gets the multiplier.
Double	normalize(PointValue pointValue) Normalizes the value of a point value.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.

Methods inherited from class DoubleContent

decode, getDouble

Methods inherited from class AbstractContent

encode, getInstance, warnBadValue

Methods inherited from class Proxied.Abstract

getMetadata, getName, getParams, getProxyEntity, getThisLogger, tearDown

Methods inherited from class Object

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

Field Detail

MULTIPLIER_PARAM

public static final String MULTIPLIER_PARAM

Conversion factor.

See Also:

Constant Field Values

Constructor Detail

UnitValueContent

public UnitValueContent()

Method Detail

denormalize

public Double denormalize(NormalizedValue normalizedValue)

Denormalizes the value of a point value.

Converts from an internal unit to an external unit.

Specified by:

denormalize in interface Content

Overrides:

denormalize in class DoubleContent

Parameters:

normalizedValue - The point value associated with the value to be denormalized.

Returns:

The denormalized value.

normalize

public Double normalize(PointValue pointValue)

Normalizes the value of a point value.

Converts from an external unit to an internal unit.

Specified by:

normalize in interface Content

Overrides:

normalize in class DoubleContent

Parameters:

pointValue - The point value associated with the value to be normalized.

Returns:

A normalized value.

setUp

public boolean setUp(Metadata metadata,
                     ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Overrides:

setUp in class Proxied.Abstract

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

getMultiplier

@CheckReturnValue
protected final double getMultiplier()

Gets the multiplier.

Returns:

The multiplier.