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

Class TopPostProcessor

  • 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="TopPostProcessor")
public class TopPostProcessor
extends com.quartetfs.biz.pivot.postprocessing.impl.ALocationShiftPostProcessor<Object>
    A post-processor that goes "up" along a hierarchy to fetch the value of its underlying measure for parent (or higher level) members.
    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 CLEAR_FILTER  
      static String EXCLUDE  
      static String NULL_AT_TOP  
      static String PLUGIN_KEY
      The plugin key for this post-processor.

      • 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
      TopPostProcessor​(String name, com.quartetfs.biz.pivot.cube.hierarchy.measures.IPostProcessorCreationContext creationContext)
      Constructor

    • 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, boolean clearFilter, boolean nullAtTop, List<String> exclude)
      This will create a metric that gives the value of the underlying at top level
      protected com.quartetfs.biz.pivot.context.subcube.ICubeFilter shiftFilter​(com.quartetfs.biz.pivot.ILocation location, com.quartetfs.biz.pivot.context.subcube.ICubeFilter filter)  
      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

      • TopPostProcessor

        public TopPostProcessor​(String name,
                        com.quartetfs.biz.pivot.cube.hierarchy.measures.IPostProcessorCreationContext creationContext)
        Constructor
        Parameters:
        name - The name of the post-processor
        creationContext - The creation context of this post-processor.

    • Method Detail

      • measure

        public static com.activeviam.copper.api.CopperMeasure measure​(com.activeviam.copper.api.CopperMeasure underlying,
                                                              boolean clearFilter,
                                                              boolean nullAtTop,
                                                              List<String> exclude)
        This will create a metric that gives the value of the underlying at top level
        Parameters:
        underlying - The underlying measure
        clearFilter - filters need to be cleared in order to find top level
        nullAtTop - is the top displayed
        exclude - list of hierarchy members to exclude from the top computation
        Returns:
        A copper measure

      • 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

      • shiftLocation

        public 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>

      • getType

        public String getType()

      • 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>