com.activeviam.frtb.core.postprocessor.fxconversion.impl

Class FXVector

java.lang.Object

com.quartetfs.biz.pivot.postprocessing.impl.AAdvancedPostProcessor<OutputType>

com.quartetfs.biz.pivot.postprocessing.impl.ABaseDynamicAggregationPostProcessor<LeafType,OutputType>

com.quartetfs.biz.pivot.postprocessing.impl.ADynamicAggregationPostProcessor<com.qfs.vector.IVector,com.qfs.vector.IVector>

com.activeviam.frtb.core.postprocessor.fxconversion.impl.FXVector

All Implemented Interfaces:

IPostProcessorPartitioningManagerAware, com.quartetfs.biz.pivot.postprocessing.IAggregatedMeasureAware, com.quartetfs.biz.pivot.postprocessing.IPartitionedPostProcessor<com.qfs.vector.IVector>, com.quartetfs.biz.pivot.postprocessing.IPostProcessor<com.qfs.vector.IVector>, com.quartetfs.fwk.types.IExtendedPluginValue, Serializable

@QuartetExtendedPluginValue(intf=com.quartetfs.biz.pivot.postprocessing.IPostProcessor.class,
                            key="FXVector")
public class FXVector
extends com.quartetfs.biz.pivot.postprocessing.impl.ADynamicAggregationPostProcessor<com.qfs.vector.IVector,com.qfs.vector.IVector>
implements IPostProcessorPartitioningManagerAware

Provides dynamic aggregation of values in multiple currencies, with conversion into a contextual reference currency. Applied to vectors.

Author:

ActiveViam

See Also:

Serialized Form

Nested Class Summary

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

com.quartetfs.biz.pivot.postprocessing.impl.ADynamicAggregationPostProcessor.TransformationProcedure

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

com.quartetfs.biz.pivot.postprocessing.impl.ABaseDynamicAggregationPostProcessor.DynamicAggregationPostProcessorPrefetcher

Field Summary

Fields

Modifier and Type	Field and Description
protected com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo	currencyLevelInfo currency level info
protected com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo	dateLevelInfo
protected IFxRates	fxRates
protected List<com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo>	fxRatesLevelInfo
protected IPostProcessorPartitioningManager	partitioningManager
protected IPostProcessorPartitioningManager.Factory	partitioningManagerFactory
static String	PLUGIN_KEY post processor plugin key

Fields inherited from class com.quartetfs.biz.pivot.postprocessing.impl.ABaseDynamicAggregationPostProcessor

AGGREGATION_FUNCTION, aggregationFunction, DYNAMIC_AGGREGATION_POST_PROCESSOR_PREFETCHER, hierarchiesInfo, isPartitionedOnRangeLevels, LEAF_LEVELS, LEAF_TYPE, leafLevelsInfo, leafType, partitioningLevelsInfo

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.activeviam.frtb.core.postprocessor.IPostProcessorPartitioningManagerAware

PROPERTY_NAME

Fields inherited from interface com.quartetfs.biz.pivot.postprocessing.IPartitionedPostProcessor

DEFAULT_PARTITIONING_ON_RANGE_LEVELS

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 and Description
FXVector(String name, com.quartetfs.biz.pivot.cube.hierarchy.measures.IPostProcessorCreationContext creationContext) constructor

Method Summary

Modifier and Type	Method and Description
protected com.qfs.vector.IVector	evaluateLeaf(com.quartetfs.biz.pivot.ILocation leafLocation, Object[] underlyingMeasures) Perform the evaluation of the post processor on a leaf (as defined in the properties).
static com.quartetfs.biz.pivot.definitions.IPostProcessorDescription	getPostProcessorDescription(Properties env, String measureName, String underlyingMeasures, String folder, boolean visible, String currencyLevelProperty) The postprocessor definition for FX conversion with a vector underlying measure
protected Double	getRate(LocalDate date, String currency, String refCurrency, List<Object> leafCoordinates)
String	getType()
void	init(Properties properties) post processor initialization
void	setFxRates(IFxRates fxRates)
void	setPartitioningLevels(com.quartetfs.biz.pivot.ILocation location, Collection<com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo> partitioningLevels)
void	setPartitioningManagerFactory(IPostProcessorPartitioningManager.Factory partitioningManagerFactory)

Methods inherited from class com.quartetfs.biz.pivot.postprocessing.impl.ADynamicAggregationPostProcessor

createLeafEvaluationProcedure, evaluateLeaf

Methods inherited from class com.quartetfs.biz.pivot.postprocessing.impl.ABaseDynamicAggregationPostProcessor

checkLeafType, checkPrefetchers, compute, computeLeafType, computeLeafTypeFromGenericType, computePartitioningLevels, computePrefetchFilter, createAggregationFunction, createPrefetchers, getAggregationFunction, getHierarchiesInfo, getLeafLevelsInfo, getLeafType, getTypeFromLiteralType, handleNoLeafLevel, initializeLeafLevels, initializeUnderlyingMeasures, reduce, reduceLeavesAndContribute, retrieveLeaves, 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getContextDependencies, getContinuousQueryHandlerKeys, getName, getOutputType, getPrefetchers, getProperties, isPartitionedOnRangeLevelsFromProperties

Field Detail

PLUGIN_KEY

public static final String PLUGIN_KEY

post processor plugin key

See Also:

Constant Field Values

currencyLevelInfo

protected com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo currencyLevelInfo

currency level info

dateLevelInfo

protected com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo dateLevelInfo

fxRatesLevelInfo

protected List<com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo> fxRatesLevelInfo

fxRates

protected IFxRates fxRates

partitioningManagerFactory

protected IPostProcessorPartitioningManager.Factory partitioningManagerFactory

partitioningManager

protected IPostProcessorPartitioningManager partitioningManager

Constructor Detail

FXVector

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

constructor

Parameters:

name - name

creationContext - creationContext

Method Detail

getPostProcessorDescription

public static com.quartetfs.biz.pivot.definitions.IPostProcessorDescription getPostProcessorDescription(Properties env,
                                                                                                        String measureName,
                                                                                                        String underlyingMeasures,
                                                                                                        String folder,
                                                                                                        boolean visible,
                                                                                                        String currencyLevelProperty)

The postprocessor definition for FX conversion with a vector underlying measure

Parameters:

env - The properties to help construct the definition

measureName - The name of the measure

underlyingMeasures - The underlying measures

folder - The folder to put this measure in

visible - The visibility of this measure

currencyLevelProperty - The currency level to use in the conversion

Returns:

The postprocessor definition

setFxRates

public void setFxRates(IFxRates fxRates)

setPartitioningManagerFactory

public void setPartitioningManagerFactory(IPostProcessorPartitioningManager.Factory partitioningManagerFactory)

Specified by:

setPartitioningManagerFactory in interface IPostProcessorPartitioningManagerAware

init

public void init(Properties properties)
          throws com.quartetfs.fwk.QuartetException

post processor initialization

Specified by:

init in interface com.quartetfs.biz.pivot.postprocessing.IPostProcessor<com.qfs.vector.IVector>

Overrides:

init in class com.quartetfs.biz.pivot.postprocessing.impl.ABaseDynamicAggregationPostProcessor<com.qfs.vector.IVector,com.qfs.vector.IVector>

Throws:

com.quartetfs.fwk.QuartetException

setPartitioningLevels

public void setPartitioningLevels(com.quartetfs.biz.pivot.ILocation location,
                                  Collection<com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo> partitioningLevels)

Specified by:

setPartitioningLevels in interface com.quartetfs.biz.pivot.postprocessing.IPartitionedPostProcessor<com.qfs.vector.IVector>

Specified by:

setPartitioningLevels in interface com.quartetfs.biz.pivot.postprocessing.IPostProcessor<com.qfs.vector.IVector>

Overrides:

setPartitioningLevels in class com.quartetfs.biz.pivot.postprocessing.impl.ABaseDynamicAggregationPostProcessor<com.qfs.vector.IVector,com.qfs.vector.IVector>

evaluateLeaf

protected com.qfs.vector.IVector evaluateLeaf(com.quartetfs.biz.pivot.ILocation leafLocation,
                                              Object[] underlyingMeasures)

Perform the evaluation of the post processor on a leaf (as defined in the properties). Here the leaf level is the UnderlierCurrency level in the Underlyings hierarchy .

Specified by:

evaluateLeaf in class com.quartetfs.biz.pivot.postprocessing.impl.ADynamicAggregationPostProcessor<com.qfs.vector.IVector,com.qfs.vector.IVector>

getRate

protected Double getRate(LocalDate date,
                         String currency,
                         String refCurrency,
                         List<Object> leafCoordinates)

getType

public String getType()

Specified by:

getType in interface com.quartetfs.fwk.types.IExtendedPluginValue

Returns:

the type of this post processor, within the post processor extended plugin.