Package com.activeviam.copper

Class DataCubeHelper

java.lang.Object
com.activeviam.copper.private_.util.CubeHelper
com.activeviam.copper.DataCubeHelper
All Implemented Interfaces:
com.activeviam.copper.private_.ICubeHelper
@Deprecated(since="6.0.6", forRemoval=true) public class DataCubeHelper extends com.activeviam.copper.private_.util.CubeHelper
Deprecated, for removal: This API element is subject to removal in a future version.
Data cube implementation of an ICubeHelper.

  • Field Details

    • DEFAULT_LEVEL_COMPARATOR

      public static final IComparator<Object> DEFAULT_LEVEL_COMPARATOR
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default comparator, used when no comparator is specified.

  • Constructor Details

    • DataCubeHelper

      public DataCubeHelper(DatabaseSelectionHelper dsSelectionHelper, IActivePivotDescription pivotDescription, DataCubeContext context)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor.
      Parameters:
      dsSelectionHelper - DatabaseSelectionHelper attached to this instance
      pivotDescription - The description of the target cube before any change is brought
      context - Copper context

  • Method Details

    • getLevelIdentifier

      public LevelIdentifier getLevelIdentifier(IInternalCopperLevel internalCopperLevel)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the LevelIdentifier corresponding to the given IInternalCopperLevel for the given context.
      Parameters:
      internalCopperLevel - the level
      Returns:
      the LevelIdentifier

    • getLevelInformation

      public LevelInformation getLevelInformation(IInternalCopperLevel level)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the LevelInformation of the given level.
      Parameters:
      level - the level
      Returns:
      the level's information

    • getHierarchyInformation

      public HierarchyInformation getHierarchyInformation(IInternalCopperHierarchy hierarchy)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the HierarchyInformation of the given hierarchy.
      Parameters:
      hierarchy - the copper hierarchy
      Returns:
      the hierarchy's information

    • getHierarchyCoordinate

      public HierarchyIdentifier getHierarchyCoordinate(IInternalCopperHierarchy hierarchy)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the HierarchyIdentifier of the given levels.
      Parameters:
      hierarchy - the copper hierarchy
      Returns:
      the hierarchy's information

    • alreadyExistsInCube

      public boolean alreadyExistsInCube(IInternalCopperHierarchy hierarchy)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns true if the given hierarchy was already present in the cube before Copper calculations.
      Parameters:
      hierarchy - the copper hierarchy
      Returns:
      a boolean

    • hasBeenPublished

      public boolean hasBeenPublished(IInternalCopperHierarchy hierarchy)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Indicates whether the hierarchy and dimension name of the given hierarchy clashes with any previously published Copper measure or any measure in the cube description.
      Parameters:
      hierarchy - the copper hierarchy
      Returns:
      true if the hierarchy already exists

    • getMeasuresDescription

      public IMeasuresDescription getMeasuresDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the pivot measure description.
      Returns:
      The measure description

    • retrieveExistingMeasureByName

      public IMeasureMemberDescription retrieveExistingMeasureByName(String measureName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: com.activeviam.copper.private_.ICubeHelper
      Search for an existing measure in the cube.
      Specified by:
      retrieveExistingMeasureByName in interface com.activeviam.copper.private_.ICubeHelper
      Overrides:
      retrieveExistingMeasureByName in class com.activeviam.copper.private_.util.CubeHelper
      Parameters:
      measureName - the name of the measure to retrieve.
      Returns:
      the measure description or null if it doesn't exist.

    • getPostProcessorOutputType

      public static int getPostProcessorOutputType(IPostProcessorDescription description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the output type of a postprocessor.
      Parameters:
      description - The postprocessor description.
      Returns:
      the output type of the postprocessor.

    • getLevelComparator

      public IComparator<Object> getLevelComparator(LevelIdentifier coordinate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      For a given level, it retrieves its comparator from the cube description.

      If none is defined, it returns null.

      Parameters:
      coordinate - the level
      Returns:
      the comparator of the level or null

    • getExistingAggregationProcedure

      public IAnalysisAggregationProcedureDescription getExistingAggregationProcedure(JoinKey joinKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns an existing IAnalysisAggregationProcedureDescription that has already been published in the cube by an earlier Copper run.
      Parameters:
      joinKey - The JoinKey that was used to create the procedure description.
      Returns:
      The matching procedure description, or null if none exists.