Package com.appliedolap.essbase

Enum Class EssMember.DataStorage

java.lang.Object
java.lang.Enum<EssMember.DataStorage>
com.appliedolap.essbase.EssMember.DataStorage
All Implemented Interfaces:
Serializable, Comparable<EssMember.DataStorage>, Constable
Enclosing interface:
EssMember
public static enum EssMember.DataStorage extends Enum<EssMember.DataStorage>
How a member's data is held. The server writes these without separators - DYNAMICCALC, SHAREDMEMBER - and omits the field altogether for a plain stored member.

  • Enum Constant Details

    • STORED

      public static final EssMember.DataStorage STORED
      The default, and what an absent value means.

    • DYNAMIC_CALC

      public static final EssMember.DataStorage DYNAMIC_CALC
      Calculated on retrieval and not written to the cube.

    • DYNAMIC_CALC_AND_STORE

      public static final EssMember.DataStorage DYNAMIC_CALC_AND_STORE
      Calculated on retrieval and then written.

    • SHARED

      public static final EssMember.DataStorage SHARED
      A pointer to another member's data rather than data of its own.

    • LABEL_ONLY

      public static final EssMember.DataStorage LABEL_ONLY
      Carries no data at all; it exists to group the members under it.

    • NEVER_SHARE

      public static final EssMember.DataStorage NEVER_SHARE
      Stored, and never implicitly shared with a sole child.

    • UNKNOWN

      public static final EssMember.DataStorage UNKNOWN
      A storage this version of the client doesn't name; the raw value is in EssMember.getProperties().

  • Method Details

    • values

      public static EssMember.DataStorage[] 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 EssMember.DataStorage 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

    • getLabel

      public String getLabel()
      The storage as Essbase's own tools write it, for a caller putting it on screen.
      Returns:
      the display name

    • parse

      public static EssMember.DataStorage parse(String text)
      Reads the server's spelling, tolerating separators and case.
      Parameters:
      text - the value from the outline, or null for an absent one
      Returns:
      the storage it names, STORED for null, UNKNOWN for anything unrecognized