org.flexiblepower.ral.values

Class Commodity<BQ extends javax.measure.quantity.Quantity,FQ extends javax.measure.quantity.Quantity>

java.lang.Object

org.flexiblepower.ral.values.Commodity<BQ,FQ>

Type Parameters:

BQ - Quantity of the Billable Unit

FQ - Quantity of the Flow Unit

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Commodity.Electricity, Commodity.Gas, Commodity.Heat

public abstract class Commodity<BQ extends javax.measure.quantity.Quantity,FQ extends javax.measure.quantity.Quantity>
extends java.lang.Object
implements java.io.Serializable

This abstract class contains information about the units that are used for a particular commodity. There are currently implementations for the commodities ELECTRICITY and GAS.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Commodity.Electricity The Commodity.Electricity commodity.
static class	Commodity.Gas The Commodity.Gas commodity.
static class	Commodity.Heat The Commodity.Heat commodity.

Field Summary

Fields

Modifier and Type	Field and Description
static Commodity.Electricity	ELECTRICITY The singleton object for Commodity.Electricity.
static Commodity.Gas	GAS The singleton object for Commodity.Gas.
static Commodity.Heat	HEAT The singleton object for Commodity.Heat.

Method Summary

Methods

Modifier and Type	Method and Description
abstract javax.measure.Measurable<BQ>	amount(javax.measure.Measurable<FQ> average, javax.measure.Measurable<javax.measure.quantity.Duration> duration)
abstract javax.measure.Measurable<FQ>	average(javax.measure.Measurable<BQ> amount, javax.measure.Measurable<javax.measure.quantity.Duration> duration)
javax.measure.unit.Unit<BQ>	getBillableUnit()
javax.measure.unit.Unit<FQ>	getFlowUnit()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GAS

public static final Commodity.Gas GAS

The singleton object for Commodity.Gas.

ELECTRICITY

public static final Commodity.Electricity ELECTRICITY

The singleton object for Commodity.Electricity.

HEAT

public static final Commodity.Heat HEAT

The singleton object for Commodity.Heat.

Method Detail

getBillableUnit

public javax.measure.unit.Unit<BQ> getBillableUnit()

Returns:

The unit that is used for billing purposes. E.g. for electricity this is kWh, for gas m^3 is used. There will be helper methods to transform the flowUnit into billableUnit (see amount(Measurable, Measurable) and average(Measurable, Measurable)).

getFlowUnit

public javax.measure.unit.Unit<FQ> getFlowUnit()

Returns:

The unit that indicates the rate at which a commodity is being consumed or produced. E.g. for electricity this would be power expressed in the watt unit (W), for gas m^3/s is used.

average

public abstract javax.measure.Measurable<FQ> average(javax.measure.Measurable<BQ> amount,
                                   javax.measure.Measurable<javax.measure.quantity.Duration> duration)

Parameters:

amount - The billable amount of this commodity

duration - The duration over which the amount has been measured

Returns:

The flow amount that represents the average flow, using the total amount sent over the given duration.

amount

public abstract javax.measure.Measurable<BQ> amount(javax.measure.Measurable<FQ> average,
                                  javax.measure.Measurable<javax.measure.quantity.Duration> duration)

Parameters:

average - The average flow amount of this commodity

duration - The duration over which the flow has been measured

Returns:

The billable amount that represents the total amount that has been measured

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object