Class ScenarioNamePostProcessor

  • All Implemented Interfaces:
    com.quartetfs.biz.pivot.postprocessing.IAggregatedMeasureAware, com.quartetfs.biz.pivot.postprocessing.IBasicPostProcessor<String>, com.quartetfs.biz.pivot.postprocessing.IEvaluator<String>, com.quartetfs.biz.pivot.postprocessing.IPartitionedPostProcessor<String>, com.quartetfs.biz.pivot.postprocessing.IPostProcessor<String>, com.quartetfs.fwk.types.IExtendedPluginValue, Serializable

    @QuartetExtendedPluginValue(intf=com.quartetfs.biz.pivot.postprocessing.IPostProcessor.class,
                                key="ScenarioNamePostProcessor")
    public class ScenarioNamePostProcessor
    extends com.quartetfs.biz.pivot.postprocessing.impl.ABasicPostProcessor<String>
    Queries the datastore and returns the scenario names for an array of indices.
    Author:
    ActiveViam
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.quartetfs.biz.pivot.postprocessing.impl.ABasicPostProcessor

        com.quartetfs.biz.pivot.postprocessing.impl.ABasicPostProcessor.BasicPostProcessorPrefetcher, com.quartetfs.biz.pivot.postprocessing.impl.ABasicPostProcessor.TransformationProcedure
    • Constructor Summary

      Constructors 
      Constructor Description
      ScenarioNamePostProcessor​(String name, com.quartetfs.biz.pivot.cube.hierarchy.measures.IPostProcessorCreationContext creationContext)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String evaluate​(com.quartetfs.biz.pivot.ILocation location, Object[] underlyingMeasures)
      Queries and returns the scenario names for an array of vector indices from the datastore.
      static Function<com.activeviam.desc.build.ICanStartBuildingMeasures,​com.activeviam.desc.build.IHasAtLeastOneMeasure> getPostProcessorDescription​(String measureName, String underlyingMeasure, String asOfDataLevel, String scenarioSetLevel, String scenarioStoreName, String scenarioAsOfDateColumn, String scenarioScenarioSetColumn, String scenarioIndexColumn, String scenarioNameColumn, String folder)  
      String getType()  
      void init​(Properties properties)
      This post-processor requires two properties to be specified in its definintion: The asOfDateLevel property as a string representation of the AsOfDate level e.g.
      static com.activeviam.copper.api.CopperMeasure measure​(com.activeviam.copper.api.CopperMeasure underlyingMeasure, String asOfDataLevel, String scenarioSetLevel, String scenarioStoreName, String scenarioAsOfDateColumn, String scenarioScenarioSetColumn, String scenarioIndexColumn, String scenarioNameColumn)  
      • Methods inherited from class com.quartetfs.biz.pivot.postprocessing.impl.ABasicPostProcessor

        checkPrefetchers, compute, computePrefetchFilter, createPrefetchers, createProcedure, evaluate, initializeUnderlyingMeasures, reduce, setPartitioningLevels, supportsAnalysisLevels
      • Methods inherited from class com.quartetfs.biz.pivot.postprocessing.impl.AAdvancedPostProcessor

        addContextDependency, checkInterruption, checkOutputType, computeNamePath, computeOutputType, createEvaluator, expandResult, getActivePivot, getContext, getContextDependencies, getContinuousQueryHandlerKeys, getCurrentMeasure, getDatastoreVersion, getDerivedContextDependencies, getExpansionProcedure, getGenericOutputType, getMeasuresProvider, getName, getOutputType, getOutputTypeFromGenericClassParameter, getOutputTypeFromProperties, getPrefetchers, getProperties, getQueryCache, getTypeFromClass, handleCircularDependency, handleNotSupportedAnalysisLevels, handleUnknownUnderlyingMeasure, hideEvaluator, initializeContinuousQueryHandlerKeys, removeAnalysisLevelsFromFilter, restrictLocationAnalysisLevels, retrieveAnalysisLevelsToExpand, retrieveNamedPrefetchAggregatesWithAnalysisLevels, retrievePrefetchAggregates, retrievePrefetchAggregatesWithAnalysisLevels, setAggregatedMeasureName, toString
      • Methods inherited from interface com.quartetfs.biz.pivot.postprocessing.IPostProcessor

        getContextDependencies, getContinuousQueryHandlerKeys, getName, getOutputType, getPrefetchers, getProperties
    • Field Detail

      • asOfDateLevelInfo

        protected com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo asOfDateLevelInfo
      • scenarioSetLevelInfo

        protected com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo scenarioSetLevelInfo
      • scenarioStoreName

        protected String scenarioStoreName
      • scenarioAsOfDateColumn

        protected String scenarioAsOfDateColumn
      • scenarioScenarioSetColumn

        protected String scenarioScenarioSetColumn
      • scenarioIndexColumn

        protected String scenarioIndexColumn
      • scenarioNameColumn

        protected String scenarioNameColumn
    • Constructor Detail

      • ScenarioNamePostProcessor

        public ScenarioNamePostProcessor​(String name,
                                         com.quartetfs.biz.pivot.cube.hierarchy.measures.IPostProcessorCreationContext creationContext)
    • Method Detail

      • getPostProcessorDescription

        public static Function<com.activeviam.desc.build.ICanStartBuildingMeasures,​com.activeviam.desc.build.IHasAtLeastOneMeasure> getPostProcessorDescription​(String measureName,
                                                                                                                                                                      String underlyingMeasure,
                                                                                                                                                                      String asOfDataLevel,
                                                                                                                                                                      String scenarioSetLevel,
                                                                                                                                                                      String scenarioStoreName,
                                                                                                                                                                      String scenarioAsOfDateColumn,
                                                                                                                                                                      String scenarioScenarioSetColumn,
                                                                                                                                                                      String scenarioIndexColumn,
                                                                                                                                                                      String scenarioNameColumn,
                                                                                                                                                                      String folder)
      • measure

        public static com.activeviam.copper.api.CopperMeasure measure​(com.activeviam.copper.api.CopperMeasure underlyingMeasure,
                                                                      String asOfDataLevel,
                                                                      String scenarioSetLevel,
                                                                      String scenarioStoreName,
                                                                      String scenarioAsOfDateColumn,
                                                                      String scenarioScenarioSetColumn,
                                                                      String scenarioIndexColumn,
                                                                      String scenarioNameColumn)
      • init

        public void init​(Properties properties)
                  throws com.quartetfs.fwk.QuartetException
        This post-processor requires two properties to be specified in its definintion:
        • The asOfDateLevel property as a string representation of the AsOfDate level e.g. "AsOfDate@AsOfDate@AsOfDate".
        • The scenarioSetLevel property as a string representation of the ScenarioSet level e.g. "ScenarioSet@ScenarioSet@ScenarioSet".
        Specified by:
        init in interface com.quartetfs.biz.pivot.postprocessing.IEvaluator<String>
        Specified by:
        init in interface com.quartetfs.biz.pivot.postprocessing.IPostProcessor<String>
        Overrides:
        init in class com.quartetfs.biz.pivot.postprocessing.impl.ABasicPostProcessor<String>
        Throws:
        com.quartetfs.fwk.QuartetException
      • getType

        public String getType()
      • evaluate

        public String evaluate​(com.quartetfs.biz.pivot.ILocation location,
                               Object[] underlyingMeasures)
        Queries and returns the scenario names for an array of vector indices from the datastore. Takes one underlying measure:
        • The array of indices.
        Specified by:
        evaluate in interface com.quartetfs.biz.pivot.postprocessing.IEvaluator<String>
        Specified by:
        evaluate in class com.quartetfs.biz.pivot.postprocessing.impl.ABasicPostProcessor<String>