Package app.valuationcontrol.multimodule.library.entities

Class Variable

java.lang.Object
app.valuationcontrol.multimodule.library.entities.Variable
All Implemented Interfaces:
DataTransformer<VariableData>, ModelProvider
@Entity public class Variable extends Object implements DataTransformer<VariableData>, ModelProvider
This class is an entity that a variable within a model
Author:
thomas

  • Field Details

  • Constructor Details

    • Variable

      public Variable()

    • Variable

      public Variable(Variable existingVariable)

    • Variable

      public Variable(VariableData variableData, Model model, Area area, SubArea subArea)

    • Variable

      public Variable(Variable templateVariable, SubArea variableSubArea)

  • Method Details

    • updateFromVariableData

      public void updateFromVariableData(VariableData variableData, Area area, SubArea subArea)

    • generateHistoricalRange

      public String generateHistoricalRange(DataPeriod dataPeriod)

    • generateProjectionRange

      public String generateProjectionRange(DataPeriod dataPeriod)

    • generateAllPeriodsRange

      public String generateAllPeriodsRange(DataPeriod dataPeriod)

    • generateLastPeriodRange

      public String generateLastPeriodRange(DataPeriod dataPeriod)

    • generateFirstPeriodRange

      public String generateFirstPeriodRange(DataPeriod dataPeriod)

    • getVariableValuesForAScenario

      public List<VariableValue> getVariableValuesForAScenario(SCENARIO scenario)
      Returns all @VariableValue attached to the specified scenario
      Parameters:
      scenario - the scenario to be assessed
      Returns:
      A list of @VariableValue

    • isSingleOrConstantValue

      public boolean isSingleOrConstantValue()
      Indicates whether the variable is a constant or a single result
      Returns:
      a boolean

    • getPrimaryColumn

      public int getPrimaryColumn()
      Return the primary column
      Returns:
      the primary column as int

    • getRow

      public int getRow()

    • getVariableAreaId

      public Long getVariableAreaId()

    • getVariableSubAreaId

      public Long getVariableSubAreaId()

    • isModelledAtSegment

      public boolean isModelledAtSegment()

    • asData

      public VariableData asData()
      Specified by:
      asData in interface DataTransformer<VariableData>

    • isConstant

      public boolean isConstant()

    • getModelId

      public Long getModelId()
      Specified by:
      getModelId in interface ModelProvider

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • columnOfSegmentAndPeriod

      public int columnOfSegmentAndPeriod(int segmentIndex, Integer period)
      Calculates column index based on segment
      Parameters:
      segmentIndex - zero based segment index, -1 means aggregation
      period - the period index relative to the startYear. If this variable is a single_result or constant the period sent in is disregarded
      Returns:
      the column for the period and segment

    • columnOfSegmentAndPeriod

      public int columnOfSegmentAndPeriod(Segment segment, Integer period)
      Calculates column index based on segment
      Parameters:
      segment - The segment to be checked
      period - the period index relative to the startYear
      Returns:
      the column for the period and segment

    • isPercentOrKPI

      public boolean isPercentOrKPI()

    • isTypeTotal

      public boolean isTypeTotal()