Package com.activeviam.copper

Class PropertiesCodec

java.lang.Object
com.activeviam.copper.PropertiesCodec
@Deprecated(since="6.0.7", forRemoval=true) public class PropertiesCodec extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Read and write post processor information in Properties.
Author:
ActiveViam

  • Constructor Details

    • PropertiesCodec

      public PropertiesCodec(Properties target)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor.
      Parameters:
      target - the properties to read from and write to

  • Method Details

    • getTarget

      public Properties getTarget()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the underlying Properties.
      Returns:
      the edited underlying properties

    • readLevels

      public List<LevelIdentifier> readLevels(String key)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reads levels identifiers from the underlying Properties.
      Parameters:
      key - the key where the levels are stored in the property
      Returns:
      the level identifiers

    • readLevels

      public List<ILevelInfo> readLevels(String key, IActivePivot pivot)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Resolves the levels used in a post-processor description. This method assumes its input is valid (all levels are found in the cube) because it is called from Copper which validates beforehand the levels.
      Parameters:
      key - the key where the levels are stored in the property
      pivot - the cube where to search for the levels
      Returns:
      the resolved levels

    • readUnderlyingMeasures

      public List<IMeasureMember> readUnderlyingMeasures(IMeasuresProvider measuresProvider)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reads and collects measure members from their name read from the Properties and retrieved from the given IMeasuresProvider.
      Parameters:
      measuresProvider - the container that allows finding actual measure members with their measure name
      Returns:
      the list of measure members

    • readAndInitCopperFunction

      public ICopperFunction readAndInitCopperFunction(String key, IActivePivot pivot)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reads an ICopperFunction from the underlying Properties. It also calls ICopperFunction.init(IActivePivot).
      Parameters:
      key - the key where the function is in the property
      pivot - the pivot used to initialize the ICopperFunction
      Returns:
      the function

    • write

      public PropertiesCodec write(String key, String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Maps the specified key to the specified value in the underlying Properties.
      Parameters:
      key - the key
      value - the value
      Returns:
      itself for chained calls

    • write

      public PropertiesCodec write(Object key, Object value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Maps the specified key to the specified value in the underlying Properties.
      Parameters:
      key - the key
      value - the value
      Returns:
      itself for chained calls

    • writeLevels

      public PropertiesCodec writeLevels(String key, List<LevelIdentifier> levels)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Writes level identifiers to the underlying Properties.
      Parameters:
      key - the key where to write at
      levels - the levels to write
      Returns:
      itself for chained calls

    • writeUnderlyingMeasures

      public PropertiesCodec writeUnderlyingMeasures(List<String> underlyingMeasures)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Writes underlyingMeasures to the underlying Properties.
      Parameters:
      underlyingMeasures - the name of the underlying measures to write
      Returns:
      itself for chained calls

    • writeUnderlyingMeasure

      public PropertiesCodec writeUnderlyingMeasure(String underlyingMeasure)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Writes underlyingMeasure to the underlying Properties.
      Parameters:
      underlyingMeasure - the name of the underlying measure to write
      Returns:
      itself for chained calls

    • addContinuousQueryHandlerKeys

      public PropertiesCodec addContinuousQueryHandlerKeys(String handlersToAppend)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Appends the handlerKeys from the given handlersToAppend to the underlying Properties.
      Parameters:
      handlersToAppend - the handlers to append
      Returns:
      itself for chained calls

    • writeAggregationFunction

      public PropertiesCodec writeAggregationFunction(String outputTypeString)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Writes the aggregation function to use when executing a dynamic aggregation.
      Parameters:
      outputTypeString - the corresponding class in string format of a postprocessor's output type
      Returns:
      itself for chained calls