mondrian.olap
Enum LevelType

java.lang.Object
  java.lang.Enum<LevelType>
      mondrian.olap.LevelType

All Implemented Interfaces:

Serializable, Comparable<LevelType>

public enum LevelType
extends Enum<LevelType>

Enumerates the types of levels.

Since:

5 April, 2004

Author:

jhyde

Enum Constant Summary

Null
Indicates that a level holds the null member.

Regular
Indicates that the level is not related to time.

TimeDays
Indicates that a level refers to days.

TimeMonths
Indicates that a level refers to months.

TimeQuarters
Indicates that a level refers to quarters.

TimeWeeks
Indicates that a level refers to weeks.

TimeYears
Indicates that a level refers to years.

Method Summary

boolean	isTime()
static LevelType	valueOf(String name) Returns the enum constant of this type with the specified name.
static LevelType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Regular

public static final LevelType Regular

Indicates that the level is not related to time.

TimeYears

public static final LevelType TimeYears

Indicates that a level refers to years. It must be used in a dimension whose type is DimensionType.TimeDimension.

TimeQuarters

public static final LevelType TimeQuarters

Indicates that a level refers to quarters. It must be used in a dimension whose type is DimensionType.TimeDimension.

TimeMonths

public static final LevelType TimeMonths

Indicates that a level refers to months. It must be used in a dimension whose type is DimensionType.TimeDimension.

TimeWeeks

public static final LevelType TimeWeeks

Indicates that a level refers to weeks. It must be used in a dimension whose type is DimensionType.TimeDimension.

TimeDays

public static final LevelType TimeDays

Indicates that a level refers to days. It must be used in a dimension whose type is DimensionType.TimeDimension.

Null

public static final LevelType Null

Indicates that a level holds the null member.

Method Detail

values

public static LevelType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LevelType c : LevelType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LevelType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

isTime

public boolean isTime()