Package org.olap4j

Enum Class AllocationPolicy

java.lang.Object
java.lang.Enum<AllocationPolicy>
org.olap4j.AllocationPolicy
All Implemented Interfaces:
Serializable, Comparable<AllocationPolicy>, Constable

public enum AllocationPolicy extends Enum<AllocationPolicy>
Enumeration of the policies that can be used to modify the values of child cells when their parent cell is modified in a writeback operation.
Since:
Aug 22, 2006
Author:
jhyde
See Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Every atomic cell that contributes to the updated cell will be assigned an equal value that is: <atomic cell value> = <value> / Count(atomic cells contained in <tuple>)
    Every atomic cell that contributes to the updated cell will be changed according to: <atomic cell value> = <atomic cell value> + (<value> - <existing value>) / Count(atomic cells contained in <tuple>)
    Every atomic cell that contributes to the updated cell will be assigned an equal value that is: <atomic cell value> = <value> * <weight value expression>
    Every atomic cell that contributes to the updated cell will be changed according to: <atomic cell value> = <atomic cell value> + (<value> - <existing value>) * <weight value expression>
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • EQUAL_ALLOCATION

      public static final AllocationPolicy EQUAL_ALLOCATION
      Every atomic cell that contributes to the updated cell will be assigned an equal value that is:
      <atomic cell value> = <value> / Count(atomic cells contained in <tuple>)
    • EQUAL_INCREMENT

      public static final AllocationPolicy EQUAL_INCREMENT
      Every atomic cell that contributes to the updated cell will be changed according to:
      <atomic cell value> = <atomic cell value> + (<value> - <existing value>) / Count(atomic cells contained in <tuple>)
    • WEIGHTED_ALLOCATION

      public static final AllocationPolicy WEIGHTED_ALLOCATION
      Every atomic cell that contributes to the updated cell will be assigned an equal value that is:
      <atomic cell value> = <value> * <weight value expression>

      Takes an optional argument, weight_value_expression. If weight_value_expression is not provided, the following expression is assigned to it by default:

      <weight value expression> = <atomic cell value> / <existing value>

      The value of weight value expression should be expressed as a value between 0 and 1. This value specifies the ratio of the allocated value you want to assign to the atomic cells that are affected by the allocation. It is the client application programmer's responsibilffity to create expressions whose rollup aggregate values will equal the allocated value of the expression.

    • WEIGHTED_INCREMENT

      public static final AllocationPolicy WEIGHTED_INCREMENT
      Every atomic cell that contributes to the updated cell will be changed according to:
      <atomic cell value> = <atomic cell value> + (<value> - <existing value>) * <weight value expression>

      Takes an optional argument, weight_value_expression. If weight_value_expression is not provided, the following expression is assigned to it by default:

      <weight value expression> = <atomic cell value> / <existing value>

      The value of weight value expression should be expressed as a value between 0 and 1. This value specifies the ratio of the allocated value you want to assign to the atomic cells that are affected by the allocation. It is the client application programmer's responsibility to create expressions whose rollup aggregate values will equal the allocated value of the expression.

  • Method Details

    • values

      public static AllocationPolicy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static AllocationPolicy valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null