mondrian.xmla

Enum PropertyDefinition

java.lang.Object

java.lang.Enum<PropertyDefinition>

mondrian.xmla.PropertyDefinition

All Implemented Interfaces:

Serializable, Comparable<PropertyDefinition>

public enum PropertyDefinition
extends Enum<PropertyDefinition>

Defines an XML for Analysis Property.

Since:

May 2, 2003

Author:

jhyde

Enum Constant Summary

Enum Constants

Enum Constant and Description
AdvancedFlag
AxisFormat
BeginRange
Catalog
Content
Cube
DataSourceInfo
Deep
EmitInvisibleMembers
EndRange
Format
LocaleIdentifier
MDXSupport
Password
ProviderName
ProviderVersion
ResponseMimeType
StateSupport
TableFields
Timeout
UserName
VisualMode

Field Summary

Fields

Modifier and Type	Field and Description
(package private) XmlaConstants.Access	access
(package private) String	description
(package private) Set<? extends Enum>	enumSet
(package private) RowsetDefinition.Type	type
(package private) XmlaConstants.Method	usage
(package private) String	value

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description of this PropertyDefinition.
static PropertyDefinition	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropertyDefinition[]	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

AxisFormat

public static final PropertyDefinition AxisFormat

BeginRange

public static final PropertyDefinition BeginRange

Catalog

public static final PropertyDefinition Catalog

Content

public static final PropertyDefinition Content

Cube

public static final PropertyDefinition Cube

DataSourceInfo

public static final PropertyDefinition DataSourceInfo

Deep

public static final PropertyDefinition Deep

EmitInvisibleMembers

public static final PropertyDefinition EmitInvisibleMembers

EndRange

public static final PropertyDefinition EndRange

Format

public static final PropertyDefinition Format

LocaleIdentifier

public static final PropertyDefinition LocaleIdentifier

MDXSupport

public static final PropertyDefinition MDXSupport

Password

public static final PropertyDefinition Password

ProviderName

public static final PropertyDefinition ProviderName

ProviderVersion

public static final PropertyDefinition ProviderVersion

ResponseMimeType

public static final PropertyDefinition ResponseMimeType

See Also:

Enumeration.ResponseMimeType

StateSupport

public static final PropertyDefinition StateSupport

Timeout

public static final PropertyDefinition Timeout

UserName

public static final PropertyDefinition UserName

VisualMode

public static final PropertyDefinition VisualMode

TableFields

public static final PropertyDefinition TableFields

AdvancedFlag

public static final PropertyDefinition AdvancedFlag

Field Detail

type

final RowsetDefinition.Type type

enumSet

final Set<? extends Enum> enumSet

access

final XmlaConstants.Access access

usage

final XmlaConstants.Method usage

value

final String value

description

final String description

Method Detail

values

public static PropertyDefinition[] 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 (PropertyDefinition c : PropertyDefinition.values())
    System.out.println(c);

Returns:

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

valueOf

public static PropertyDefinition 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.)

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

getDescription

public String getDescription()

Returns the description of this PropertyDefinition.

Returns:

description