energy

Class DisplayHelper

java.lang.Object

energy.DisplayHelper

public class DisplayHelper
extends java.lang.Object

This class contains some static methods for converting instances of energy flow, duration and other to text.

Constructor Summary

Constructors

Constructor and Description
DisplayHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDisplayTextForAbstractActualGoodFlow(AbstractActualGoodFlow abstractActualGoodFlow, boolean allowNull) Returns the display text for an AbstractActualGoodFlow.
static java.lang.String	getDisplayTextForAbstractActualGoodFlow(AbstractActualGoodFlow abstractActualGoodFlow, boolean allowNull, boolean returnUnitOnly) Returns the display text for an AbstractActualGoodFlow.
static java.lang.String	getDisplayTextForAbstractActualGoodFlow(AbstractActualGoodFlow abstractActualGoodFlow, boolean allowNull, java.lang.Integer roundPrecision) Returns the display text for an AbstractActualGoodFlow.
static java.lang.String	getDisplayTextForAbstractActualGoodFlow(AbstractActualGoodFlow abstractActualGoodFlow, boolean allowNull, java.lang.Integer roundPrecision, boolean returnUnitOnly) Returns the display text for an AbstractActualGoodFlow.
static java.lang.String	getDisplayTextForAbstractDuration(AbstractDuration abstractDuration, boolean allowNull) Returns the display text for an AbstractDuration.
static java.lang.String	getDisplayTextForAbstractEnergyFlowInWatt(AbstractEnergyFlowInWatt abstractEnergyFlowInWatt, boolean allowNull) Returns the display text for an AbstractEnergyFlowInWatt.
static java.lang.String	getDisplayTextForAbstractEnergyFlowInWatt(AbstractEnergyFlowInWatt abstractEnergyFlowInWatt, boolean allowNull, java.lang.Integer roundPrecision) Returns the display text for an AbstractEnergyFlowInWatt.
static java.lang.String	getDisplayTextForAmount(double amountValue, java.lang.String unit) Returns the display text for the specified amount.
static java.lang.String	getDisplayTextForAmount(double amountValue, java.lang.String unit, java.lang.Integer roundPrecision) Returns the display text for the specified amount.
static java.lang.String	getDisplayTextForEnergyAmount(EnergyAmount energyAmount) Returns the display text for a specified EnergyAmount.
static java.lang.String	getDisplayTextForEnergyAmount(EnergyAmount energyAmount, java.lang.Integer roundPrecision) Returns the display text for a specified EnergyAmount.
static java.lang.String	getDisplayTextForEnergyUnitFactorPrefixSI(EnergyUnitFactorPrefixSI siPrefixforWatt) Returns the text for a SI-Prefix that can be used e.g. for energy flows.
static java.lang.String	getDisplayTextForStateDuration(State state) Returns the display text for a specified state duration.
static java.lang.String	getDisplayTextForSystemVariableGradient(SystemVariableDefinition sysVarDef) Returns the display text for a gradient of a SystemVariableDefinition.
static java.lang.String	getDisplayTextForTimeUnit(TimeUnit timeUnit) Returns the display text for the specified TimeUnit.
static java.lang.String	getDisplayTextForVariableState(VariableState variableState) Returns the display text for VariableState that can be either a FixedVariable or a RangeVariable and one of their sub classes.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayHelper

public DisplayHelper()

Method Detail

getDisplayTextForTimeUnit

public static java.lang.String getDisplayTextForTimeUnit(TimeUnit timeUnit)

Returns the display text for the specified TimeUnit.

Parameters:

timeUnit - the TimeUnit

Returns:

the display text for time unit

getDisplayTextForEnergyUnitFactorPrefixSI

public static java.lang.String getDisplayTextForEnergyUnitFactorPrefixSI(EnergyUnitFactorPrefixSI siPrefixforWatt)

Returns the text for a SI-Prefix that can be used e.g. for energy flows.

Parameters:

siPrefixforWatt - the EnergyUnitFactorPrefixSI

Returns:

the text for the SI-prefix

getDisplayTextForAbstractDuration

public static java.lang.String getDisplayTextForAbstractDuration(AbstractDuration abstractDuration,
                                                                 boolean allowNull)

Returns the display text for an AbstractDuration.

Parameters:

abstractDuration - the abstract duration

allowNull - set true if null is allowed

Returns:

the display text for abstract duration

getDisplayTextForStateDuration

public static java.lang.String getDisplayTextForStateDuration(State state)

Returns the display text for a specified state duration.

Parameters:

state - the state

Returns:

the display text for state duration

getDisplayTextForAbstractEnergyFlowInWatt

public static java.lang.String getDisplayTextForAbstractEnergyFlowInWatt(AbstractEnergyFlowInWatt abstractEnergyFlowInWatt,
                                                                         boolean allowNull)

Returns the display text for an AbstractEnergyFlowInWatt.

Parameters:

abstractEnergyFlowInWatt - the abstract EnergyFlowInWatt

allowNull - set true if null is allowed

Returns:

the display text for abstract EnergyFlowInWatt

getDisplayTextForAbstractEnergyFlowInWatt

public static java.lang.String getDisplayTextForAbstractEnergyFlowInWatt(AbstractEnergyFlowInWatt abstractEnergyFlowInWatt,
                                                                         boolean allowNull,
                                                                         java.lang.Integer roundPrecision)

Returns the display text for an AbstractEnergyFlowInWatt.

Parameters:

abstractEnergyFlowInWatt - the abstract EnergyFlowInWatt

allowNull - the allow null

roundPrecision - the round precision

Returns:

the display text for abstract EnergyFlowInWatt

getDisplayTextForAbstractActualGoodFlow

public static java.lang.String getDisplayTextForAbstractActualGoodFlow(AbstractActualGoodFlow abstractActualGoodFlow,
                                                                       boolean allowNull)

Returns the display text for an AbstractActualGoodFlow.

Parameters:

abstractActualGoodFlow - the abstract actual good flow

allowNull - set true if null is allowed

Returns:

the display text for abstract EnergyFlowInWatt

getDisplayTextForAbstractActualGoodFlow

public static java.lang.String getDisplayTextForAbstractActualGoodFlow(AbstractActualGoodFlow abstractActualGoodFlow,
                                                                       boolean allowNull,
                                                                       boolean returnUnitOnly)

Returns the display text for an AbstractActualGoodFlow.

Parameters:

abstractActualGoodFlow - the abstract actual good flow

allowNull - set true if null is allowed

returnUnitOnly - set true, if only the unit should be returned

Returns:

the display text for abstract EnergyFlowInWatt

getDisplayTextForAbstractActualGoodFlow

public static java.lang.String getDisplayTextForAbstractActualGoodFlow(AbstractActualGoodFlow abstractActualGoodFlow,
                                                                       boolean allowNull,
                                                                       java.lang.Integer roundPrecision)

Returns the display text for an AbstractActualGoodFlow.

Parameters:

abstractActualGoodFlow - the abstract actual good flow

allowNull - the allow null

roundPrecision - the round precision

Returns:

the display text for abstract EnergyFlowInWatt

getDisplayTextForAbstractActualGoodFlow

public static java.lang.String getDisplayTextForAbstractActualGoodFlow(AbstractActualGoodFlow abstractActualGoodFlow,
                                                                       boolean allowNull,
                                                                       java.lang.Integer roundPrecision,
                                                                       boolean returnUnitOnly)

Returns the display text for an AbstractActualGoodFlow.

Parameters:

abstractActualGoodFlow - the abstract actual good flow

allowNull - the allow null

roundPrecision - the round precision

returnUnitOnly - set true, if only the unit should be returned

Returns:

the display text for abstract EnergyFlowInWatt

getDisplayTextForEnergyAmount

public static java.lang.String getDisplayTextForEnergyAmount(EnergyAmount energyAmount)

Returns the display text for a specified EnergyAmount.

Parameters:

energyAmount - the energy amount

Returns:

the display text for energy amount

getDisplayTextForEnergyAmount

public static java.lang.String getDisplayTextForEnergyAmount(EnergyAmount energyAmount,
                                                             java.lang.Integer roundPrecision)

Returns the display text for a specified EnergyAmount.

Parameters:

energyAmount - the energy amount

roundPrecision - the round precision

Returns:

the display text for energy amount

getDisplayTextForAmount

public static java.lang.String getDisplayTextForAmount(double amountValue,
                                                       java.lang.String unit)

Returns the display text for the specified amount.

Parameters:

amountValue - the amount value

unit - the unit

Returns:

the display text for amount

getDisplayTextForAmount

public static java.lang.String getDisplayTextForAmount(double amountValue,
                                                       java.lang.String unit,
                                                       java.lang.Integer roundPrecision)

Returns the display text for the specified amount.

Parameters:

amountValue - the amount value

unit - the unit

roundPrecision - the round precision

Returns:

the display text for amount

getDisplayTextForVariableState

public static java.lang.String getDisplayTextForVariableState(VariableState variableState)

Returns the display text for VariableState that can be either a FixedVariable or a RangeVariable and one of their sub classes.

Parameters:

variableState - the variable state

Returns:

the display text for variable state

getDisplayTextForSystemVariableGradient

public static java.lang.String getDisplayTextForSystemVariableGradient(SystemVariableDefinition sysVarDef)

Returns the display text for a gradient of a SystemVariableDefinition.

Parameters:

sysVarDef - the SystemVariableDefinition

Returns:

the display text for the gradient of a SystemVariableDefinition