LevelType (Pentaho Community Edition Project: mondrian 8.3.0.1-377 API)

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

All Implemented Interfaces:

Serializable, Comparable<LevelType>

Deprecated.
Will be replaced with Level.Type before mondrian-4.0.
```
public enum LevelType
extends Enum<LevelType>
```
Enumerates the types of levels.

Since:

5 April, 2004

Author:

jhyde

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Null` Deprecated. Indicates that a level holds the null member.
`Regular` Deprecated. Indicates that the level is not related to time.
`TimeDays` Deprecated. Indicates that a level refers to days.
`TimeHalfYears` Deprecated. Indicates that a level refers to half years.
`TimeHours` Deprecated. Indicates that a level refers to hours.
`TimeMinutes` Deprecated. Indicates that a level refers to minutes.
`TimeMonths` Deprecated. Indicates that a level refers to months.
`TimeQuarters` Deprecated. Indicates that a level refers to quarters.
`TimeSeconds` Deprecated. Indicates that a level refers to seconds.
`TimeUndefined` Deprecated. Indicates that a level is an unspecified time period.
`TimeWeeks` Deprecated. Indicates that a level refers to weeks.
`TimeYears` Deprecated. Indicates that a level refers to years.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`isTime()` Deprecated. Returns whether this is a time level.
`static LevelType`	`valueOf(String name)` Deprecated. Returns the enum constant of this type with the specified name.
`static LevelType[]`	`values()` Deprecated. 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
```
    Deprecated.
    
    Indicates that the level is not related to time.
  - TimeYears
```
public static final LevelType TimeYears
```
    Deprecated.
    
    Indicates that a level refers to years. It must be used in a dimension whose type is DimensionType.TimeDimension.
  - TimeHalfYears
```
public static final LevelType TimeHalfYears
```
    Deprecated.
    
    Indicates that a level refers to half years. It must be used in a dimension whose type is DimensionType.TimeDimension.
  - TimeQuarters
```
public static final LevelType TimeQuarters
```
    Deprecated.
    
    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
```
    Deprecated.
    
    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
```
    Deprecated.
    
    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
```
    Deprecated.
    
    Indicates that a level refers to days. It must be used in a dimension whose type is DimensionType.TimeDimension.
  - TimeHours
```
public static final LevelType TimeHours
```
    Deprecated.
    
    Indicates that a level refers to hours. It must be used in a dimension whose type is DimensionType.TimeDimension.
  - TimeMinutes
```
public static final LevelType TimeMinutes
```
    Deprecated.
    
    Indicates that a level refers to minutes. It must be used in a dimension whose type is DimensionType.TimeDimension.
  - TimeSeconds
```
public static final LevelType TimeSeconds
```
    Deprecated.
    
    Indicates that a level refers to seconds. It must be used in a dimension whose type is DimensionType.TimeDimension.
  - TimeUndefined
```
public static final LevelType TimeUndefined
```
    Deprecated.
    
    Indicates that a level is an unspecified time period. It must be used in a dimension whose type is DimensionType.TimeDimension.
  - Null
```
public static final LevelType Null
```
    Deprecated.
    
    Indicates that a level holds the null member.
- Method Detail
  - values
```
public static LevelType[] values()
```
    Deprecated.
    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)
```
    Deprecated.
    
    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.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isTime
```
public boolean isTime()
```
    Deprecated.
    
    Returns whether this is a time level.
    
    Returns:
    
    Whether this is a time level.

Enum LevelType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Regular

TimeYears

TimeHalfYears

TimeQuarters

TimeMonths

TimeWeeks

TimeDays

TimeHours

TimeMinutes

TimeSeconds

TimeUndefined

Null

Method Detail

values

valueOf

isTime