org.rvpf.content

Class SIContent

Object

Proxied.Abstract

AbstractContent

NumberContent

FloatingPointContent

SIContent

All Implemented Interfaces:

Content, Proxied

public final class SIContent
extends FloatingPointContent

SI content converter.

Instances of this class implements SI base units and derived units with special names. Using these instances avoids the specification of a large number of content definitions in the metadata.

Each point using this content will have a 'Unit' param holding an optional SI prefix and a mandatory SI symbol.

This implementation keeps a cache of the generated instances keyed by the value multiplier.

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNIT_PARAM Param holding the abbreviation of a base or derived unit, including an optional prefix.

Constructor Summary

Constructors

Constructor and Description
SIContent()

Method Summary

Modifier and Type	Method and Description
Serializable	decode(PointValue pointValue) Decodes the value of a point value.
Double	denormalize(NormalizedValue normalizedValue) Denormalizes the value of a point value.
Content	getInstance(Point point) Gets an appropriate instance of this content for the point.
Serializable	normalize(PointValue pointValue) Normalizes the value of a point value.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.
void	tearDown() Tears down what has been set up.

Methods inherited from class AbstractContent

encode, warnBadValue

Methods inherited from class Proxied.Abstract

getMetadata, getName, getParams, getProxyEntity, getThisLogger

Methods inherited from class Object

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

Field Detail

UNIT_PARAM

public static final String UNIT_PARAM

Param holding the abbreviation of a base or derived unit, including an optional prefix.

See Also:

Constant Field Values

Constructor Detail

SIContent

public SIContent()

Method Detail

decode

public Serializable decode(PointValue pointValue)

Decodes the value of a point value.

Converts from an external representation to an internal representation.

Specified by:

decode in interface Content

Overrides:

decode in class AbstractContent

Parameters:

pointValue - The point value associated with the value to decode.

Returns:

The decoded value.

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 AbstractContent

Parameters:

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

Returns:

The denormalized value.

getInstance

public Content getInstance(Point point)

Gets an appropriate instance of this content for the point.

Specified by:

getInstance in interface Content

Overrides:

getInstance in class AbstractContent

Parameters:

point - The point.

Returns:

A content instance (null on failure).

normalize

public Serializable 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 AbstractContent

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.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface Proxied

Overrides:

tearDown in class Proxied.Abstract