Package app.valuationcontrol.multimodule.library.entities

Class Model

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

  • Constructor Details

    • Model

      public Model(String modelName, Integer numberOfHistoricalPeriods, Integer numberOfProjectionPeriod)
      Parameters:
      modelName - is the areaName of the new model to be created
      numberOfHistoricalPeriods - indicates the number of historical periods to be managed in the model
      numberOfProjectionPeriod - indicates the number of projection periods in the model

    • Model

      public Model(ModelData modelData)

    • Model

      public Model()

  • Method Details

    • getArraySize

      public Integer getArraySize()

    • indexOfLastColumn

      public int indexOfLastColumn()

    • getConstantColumn

      public int getConstantColumn()

    • setUseAreaAddress

      public void setUseAreaAddress(boolean useAreaAddress)

    • getFirstProjectionColumn

      public Integer getFirstProjectionColumn()

    • getTotalNumberOfColumns

      public int getTotalNumberOfColumns(boolean startingAtZero)

    • getNumberOfPeriodsAndValue

      public int getNumberOfPeriodsAndValue()

    • getNumberOfVariables

      public int getNumberOfVariables()

    • getMaxVariableOrder

      public Integer getMaxVariableOrder()
      Iterates through all existing variables and return the highest existing variable areaOrder
      Returns:
      the highest existing variable_order

    • getVariableWithID

      public Optional<Variable> getVariableWithID(long variableId)

    • asData

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

    • getModelId

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

    • forceModelId

      public void forceModelId(Long modelId)

    • getKeyVariablesForModel

      public Set<Long> getKeyVariablesForModel()

    • getVariableValuesUsedInScenarios

      public List<VariableValue> getVariableValuesUsedInScenarios()