Package org.kigalisim.engine.recalc.util

Class DemandAnalysis

java.lang.Object

org.kigalisim.engine.recalc.util.DemandAnalysis

public class DemandAnalysis
extends Object

Immutable result of a demand analysis calculation.

Constructor Summary

Constructors

Constructor	Description
DemandAnalysis(BigDecimal totalDemand, boolean hadUnitBasedSpecs, BigDecimal requiredVirginMaterial, BigDecimal rechargeResidualKg)	Create a new DemandAnalysis.

Method Summary

Modifier and Type	Method	Description
boolean	getHadUnitBasedSpecs()	Check if unit-based specifications should be preserved.
BigDecimal	getRechargeResidualKg()	Get the recharge residual.
BigDecimal	getRequiredVirginMaterial()	Get the required virgin material.
BigDecimal	getTotalDemand()	Get the total substance demand.

Methods inherited from class java.lang.Object

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

Constructor Details

DemandAnalysis

public DemandAnalysis(BigDecimal totalDemand,
 boolean hadUnitBasedSpecs,
 BigDecimal requiredVirginMaterial,
 BigDecimal rechargeResidualKg)

Create a new DemandAnalysis.

Parameters:

totalDemand - The total substance demand minus implicit servicing in kg

hadUnitBasedSpecs - True if unit-based specifications should be preserved

requiredVirginMaterial - The required virgin material in kg after recycling effects

rechargeResidualKg - The recharge volume minus implicit recharge in kg

Method Details

getTotalDemand

public BigDecimal getTotalDemand()

Get the total substance demand.

Returns:

The total demand minus implicit servicing in kg

getHadUnitBasedSpecs

public boolean getHadUnitBasedSpecs()

Check if unit-based specifications should be preserved.

Returns:

True if unit-based specifications should be preserved, false otherwise

getRequiredVirginMaterial

public BigDecimal getRequiredVirginMaterial()

Get the required virgin material.

Returns:

The required virgin material in kg after accounting for recycling and induction

getRechargeResidualKg

public BigDecimal getRechargeResidualKg()

Get the recharge residual.

Returns:

The recharge volume minus implicit recharge in kg