Package com.activeviam.risk.core.postprocessor.impl

Class ReferenceLevelLocationShift

  • All Implemented Interfaces:
    com.quartetfs.biz.pivot.postprocessing.IAggregatedMeasureAware, com.quartetfs.biz.pivot.postprocessing.IEvaluator<Object>, com.quartetfs.biz.pivot.postprocessing.IPostProcessor<Object>, com.quartetfs.fwk.types.IExtendedPluginValue, Serializable
    @QuartetExtendedPluginValue(intf=com.quartetfs.biz.pivot.postprocessing.IPostProcessor.class,
                            key="ReferenceLevelLocationShift")
public class ReferenceLevelLocationShift
extends com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor<Object>
    Evaluate the underlying measure at the reference level. The Reference Level is determined using ReferenceLevelContextVal.
    See Also:
    Serialized Form

    • Nested Class Summary

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

        com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor.EvaluationProcedure, com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor.LocationShiftPrefetcher

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String PLUGIN_KEY  

      • Fields inherited from class com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor

        EVALUATE_FOR_MEASURES_PROPERTY, SHIFT_PREFETCHER_NAME, targetMeasures, UNDERLYING_PREFETCHER_NAME

      • Fields inherited from class com.quartetfs.biz.pivot.postprocessing.impl.AAdvancedPostProcessor

        aggregatedMeasureName, ANALYSIS_LEVELS_PROPERTY, analysisLevelsToExpand, continuousQueryHandlerKeys, derivedContextDependencies, evaluator, EVALUATOR, explicitContextDependencies, logger, measuresProvider, name, OUTPUT_TYPE, outputType, pivot, prefetchers, PRINT_TIMINGS, printTimings, properties, underlyingMeasures

      • Fields inherited from interface com.quartetfs.biz.pivot.postprocessing.IPostProcessor

        CONTINUOUS_QUERY_HANDLER_KEYS, IS_PARTITIONED_ON_RANGE_LEVELS_PROPERTY, SEPARATOR, UNDERLYING_MEASURES

    • Constructor Summary

      Constructors 
      Constructor Description
      ReferenceLevelLocationShift​(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
      protected String[] getTargetMeasures​(Properties properties)  
      String getType()  
      void init​(Properties properties)  
      static com.activeviam.copper.api.CopperMeasure measure​(com.activeviam.copper.api.CopperMeasure underlying)
      This will create a metric that gives the value of the underlying at specified level
      protected com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo referenceLevel()
      Get the Reference Levels configuration.
      protected com.quartetfs.biz.pivot.context.subcube.ICubeFilter shiftFilter​(com.quartetfs.biz.pivot.ILocation location, com.quartetfs.biz.pivot.context.subcube.ICubeFilter filter)  
      protected com.quartetfs.biz.pivot.ILocation shiftLocation​(com.quartetfs.biz.pivot.ILocation location)  
      protected com.quartetfs.biz.pivot.IPointLocationReader shiftLocation​(com.quartetfs.biz.pivot.IPointLocationBuilder builder, com.quartetfs.biz.pivot.IPointLocationReader evaluationLocation)  

      • Methods inherited from class com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor

        compute, createProcedure, createShiftedLocationPrefetcher, evaluate, handleNoUnderlyinMeasure

      • 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, initializeUnderlyingMeasures, removeAnalysisLevelsFromFilter, restrictLocationAnalysisLevels, retrieveAnalysisLevelsToExpand, retrieveNamedPrefetchAggregatesWithAnalysisLevels, retrievePrefetchAggregates, retrievePrefetchAggregatesWithAnalysisLevels, setAggregatedMeasureName, supportsAnalysisLevels, toString

      • Methods inherited from interface com.quartetfs.biz.pivot.postprocessing.IPostProcessor

        setPartitioningLevels

    • Constructor Detail

      • ReferenceLevelLocationShift

        public ReferenceLevelLocationShift​(String name,
                                   com.quartetfs.biz.pivot.cube.hierarchy.measures.IPostProcessorCreationContext creationContext)

    • Method Detail

      • measure

        public static com.activeviam.copper.api.CopperMeasure measure​(com.activeviam.copper.api.CopperMeasure underlying)
        This will create a metric that gives the value of the underlying at specified level
        Parameters:
        underlying - The underlying measure
        Returns:
        A copper measure

      • getType

        public String getType()

      • init

        public void init​(Properties properties)
          throws com.quartetfs.fwk.QuartetException
        Specified by:
        init in interface com.quartetfs.biz.pivot.postprocessing.IEvaluator<Object>
        Specified by:
        init in interface com.quartetfs.biz.pivot.postprocessing.IPostProcessor<Object>
        Overrides:
        init in class com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor<Object>
        Throws:
        com.quartetfs.fwk.QuartetException

      • referenceLevel

        protected com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo referenceLevel()
        Get the Reference Levels configuration. Tries the post-processor configuration, use the ReferenceLevel context value.
        Returns:
        the reference level or null if we are at top level

      • shiftLocation

        protected com.quartetfs.biz.pivot.ILocation shiftLocation​(com.quartetfs.biz.pivot.ILocation location)
        Specified by:
        shiftLocation in class com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor<Object>

      • shiftFilter

        protected com.quartetfs.biz.pivot.context.subcube.ICubeFilter shiftFilter​(com.quartetfs.biz.pivot.ILocation location,
                                                                          com.quartetfs.biz.pivot.context.subcube.ICubeFilter filter)
        Overrides:
        shiftFilter in class com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor<Object>

      • getTargetMeasures

        protected String[] getTargetMeasures​(Properties properties)
        Overrides:
        getTargetMeasures in class com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor<Object>

      • shiftLocation

        protected com.quartetfs.biz.pivot.IPointLocationReader shiftLocation​(com.quartetfs.biz.pivot.IPointLocationBuilder builder,
                                                                     com.quartetfs.biz.pivot.IPointLocationReader evaluationLocation)
        Overrides:
        shiftLocation in class com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor<Object>