java.lang.Object
- com.activeviam.io.data.sink.output.impl.PivotDefinitionHelper

```
public class PivotDefinitionHelper
extends Object
```
Helper allowing to validate and retrieve the level and measure definitions from a cube

Author:

ActiveViam

Constructor Summary

Constructors
Constructor Description

PivotDefinitionHelper(com.quartetfs.biz.pivot.IMultiVersionActivePivot pivot, IDeeOrder order)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkLevelDefinition(String dimensionName, String hierarchyName, String levelName, String header, String taskId)`	Check if the level definition given in the DEE order exist in the cube or not.
`void`	`checkMeasureDefinition(String measureName, String header, String taskId)`	Check if the measure given in the DEE order exist in the cube or not.
`protected Map<String,com.activeviam.io.data.sink.output.impl.PivotDefinitionHelper.DeeDimensionInfo>`	`extractDimensionsInfo(com.quartetfs.biz.pivot.IMultiVersionActivePivot pivot)`
`protected Map<String,com.activeviam.io.data.sink.output.impl.PivotDefinitionHelper.DeeDimensionInfo>`	`getDimensionsInfo()`	Initialize the cube descriptions for the current pivot
`com.quartetfs.biz.pivot.cube.hierarchy.IHierarchyInfo`	`getHierarchyInfo(String dimensionName, String hierarchyName)`	Return the `IHierarchyInfo` corresponding to the given definition
`com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo`	`getLevelInfo(String dimensionName, String hierarchyName, String levelName)`	Return the `ILevelInfo` corresponding to the given definition
`protected Set<String>`	`getMeasuresInfo()`	Initialize the measure descriptions for the current pivot
`protected Set<String>`	`processCalculatedMeasures(IDeeOrder order)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PivotDefinitionHelper

public PivotDefinitionHelper(com.quartetfs.biz.pivot.IMultiVersionActivePivot pivot,
                             IDeeOrder order)

Method Detail

processCalculatedMeasures

protected Set<String> processCalculatedMeasures(IDeeOrder order)

checkLevelDefinition

public void checkLevelDefinition(String dimensionName,
                                 String hierarchyName,
                                 String levelName,
                                 String header,
                                 String taskId)
                          throws DeeException

Check if the level definition given in the DEE order exist in the cube or not. A DeeException is raised if one of the element cannot be found.

Parameters:: dimensionName - name of the dimension; hierarchyName - name of the hierarchy; levelName - name of the level; header - name of header in the DEE order; taskId - current processing task id
Throws:: DeeException - if one of the element given to find the level does not exist in the cube

getHierarchyInfo

public com.quartetfs.biz.pivot.cube.hierarchy.IHierarchyInfo getHierarchyInfo(String dimensionName,
                                                                              String hierarchyName)

Return the IHierarchyInfo corresponding to the given definition

Parameters:: dimensionName - name of the dimension; hierarchyName - name of the hierarchy
Returns:: the core hierarchy info object

getLevelInfo

public com.quartetfs.biz.pivot.cube.hierarchy.ILevelInfo getLevelInfo(String dimensionName,
                                                                      String hierarchyName,
                                                                      String levelName)

Return the ILevelInfo corresponding to the given definition

Parameters:: dimensionName - name of the dimension; hierarchyName - name of the hierarchy; levelName - name of the level
Returns:: the core level info object

checkMeasureDefinition
```
public void checkMeasureDefinition(String measureName,
                                   String header,
                                   String taskId)
                            throws DeeException
```
Check if the measure given in the DEE order exist in the cube or not. A DeeException is raised if it cannot be found.

Parameters:

measureName - name of the measure

header - name of header in the DEE order

taskId - current processing task id

Throws:

DeeException - if one of the measure does not exist in the cube

getDimensionsInfo

protected Map<String,com.activeviam.io.data.sink.output.impl.PivotDefinitionHelper.DeeDimensionInfo> getDimensionsInfo()

Initialize the cube descriptions for the current pivot

Returns:: the cube description

getMeasuresInfo
```
protected Set<String> getMeasuresInfo()
```
Initialize the measure descriptions for the current pivot

Returns:

the measure description

extractDimensionsInfo

protected Map<String,com.activeviam.io.data.sink.output.impl.PivotDefinitionHelper.DeeDimensionInfo> extractDimensionsInfo(com.quartetfs.biz.pivot.IMultiVersionActivePivot pivot)

Class PivotDefinitionHelper

Constructor Summary