Package net.pricefx.formulaengine.optimization

Interface ModelFormulaContextReadOnly

All Known Subinterfaces:
ModelCalculationFormulaContext, ModelEvaluationFormulaContext, ModelFormulaContextReadWrite, ModelParallelCalculationFormulaInitContext, ModelParallelCalculationFormulaItemContext, ModelParallelCalculationFormulaSummaryContext
public interface ModelFormulaContextReadOnly

  • Method Details

    • typedId

      String typedId()
      Returns:
      The typed id of this model
      Since:
      11.1 Paper Plane

    • uniqueName

      String uniqueName()
      Returns:
      The unique name of this model
      Since:
      8.0 Godfather

    • label

      String label()
      Returns:
      The label of this model
      Since:
      8.0 Godfather

    • currentStep

      String currentStep()
      Returns:
      The current step this model is at
      Since:
      11.1 Paper Plane

    • inputs

      Map<String,Object> inputs(String stepName, String tabName)
      This gives access to the previous steps saved inputs.

      Those inputs are organized per step and per tab in the step.

      From a given step, it is not possible to access its inputs (for this PublicGroovyAPI.input(String) or the input binding can be used) or the next step's inputs.

      Parameters:
      stepName - The name of the step as defined in the model class
      tabName - The name of the tab as defined in the model class
      Returns:
      The unmodifiable inputs of the tab in the step
      Since:
      8.0 Godfather

    • outputs

      Map<String,Object> outputs(String stepName, String calculationName)
      This method gives access to the results of calculations of this Model object, that is:
      • Formula Calculations that produce a result per element.
      • Job Trigger Calculations that may produce an arbitrary map of results, depending on the image used.

      The name of the calculation is the one specified in the Model Class or for Job Trigger Calculations, a name of the form calculationName:jobName (see ModelFormulaContextReadWrite.startJobTriggerCalculation(String, String, String, String)).

      Those outputs are made available per step and per calculation name in the step.

      From a given step, it is not possible to access the next steps' calculations' outputs.

      From a given calculation in a sequence, it is not possible to access the next calculations' outputs.

      Parameters:
      stepName - The name of the step as defined in the model class
      calculationName - The name of the calculation as defined above
      Returns:
      The unmodifiable ordered results of the calculation
      Since:
      8.0 Godfather

    • table

      DatamartContext.Table table(String name)
      Parameters:
      name - The table name in this model
      Returns:
      The existing model table or null if it doesn't exist
      Since:
      8.0 Godfather

    • lookupTablesContext

      ModelLookupTablesContextReadOnly lookupTablesContext()
      Returns:
      a context for read operations on the lookup tables of this model
      Since:
      9.0 Hurricane

    • filterTreesContext

      ModelFilterTreesContextReadOnly filterTreesContext()
      Returns:
      a context for read operations on the filter trees of this model
      Since:
      9.0 Hurricane

    • pmmlContext

      ModelPMMLContext pmmlContext()
      Returns:
      a context for evaluation of pmml models attached to this model
      Since:
      9.0 Hurricane

    • rContext

      RContext rContext()
      Returns:
      a context for evaluation of arbitrary R code
      Since:
      9.0 Hurricane

    • schedulesContext

      ModelSchedulesContextReadOnly schedulesContext()
      Returns:
      a context for reading Model Schedules
      Since:
      11.0 Paper Plane

    • attachmentDownloadURL

      String attachmentDownloadURL(String name)
      Returns the attachment download URL.

      Example:

      • pricefx/${partition}/bdmanager.downloaddata/${bdId}?output=file
      • ex: pricefx/mustard/bdmanager.downloaddata/3393?output=file
      Parameters:
      name - The attachment filename in this model
      Returns:
      the attachment download URL
      Since:
      13.1 Rampur