mondrian.rolap
Enum RolapConnectionProperties

java.lang.Object
  java.lang.Enum<RolapConnectionProperties>
      mondrian.rolap.RolapConnectionProperties

All Implemented Interfaces:

Serializable, Comparable<RolapConnectionProperties>

public enum RolapConnectionProperties
extends Enum<RolapConnectionProperties>

RolapConnectionProperties enumerates the allowable values of keywords in a Mondrian connect string.

Note to developers: If you add or modify a connection-string property, you must also modify the Configuration Specification.

Author:

jhyde

Enum Constant Summary

Catalog
The "Catalog" property is the URL of the catalog, an XML file which describes the schema: cubes, hierarchies, and so forth.

CatalogContent
The "CatalogContent" property is an XML string representing the schema: cubes, hierarchies, and so forth.

CatalogName
The "CatalogName" property is not used.

DataSource
The "DataSource" property is the name of a data source class.

DataSourceChangeListener
The name of a class implementing the DataSourceChangeListener interface.

DynamicSchemaProcessor
The name of a class implementing the DynamicSchemaProcessor interface.

Ignore
The "Ignore" property is a boolean value.

Jdbc
The "Jdbc" property is the URL of the JDBC database where the data is stored.

JdbcDrivers
The "JdbcDrivers" property is a comma-separated list of JDBC driver classes, for example, "sun.jdbc.odbc.JdbcOdbcDriver,oracle.jdbc.OracleDriver".

JdbcPassword
The "JdbcPassword" property is the password to log on to the JDBC database.

JdbcUser
The "JdbcUser" property is the name of the user to log on to the JDBC database.

Locale
The "Locale" property is the requested Locale for the LocalizingDynamicSchemaProcessor.

PoolNeeded
The "PoolNeeded" property tells Mondrian whether to add a layer of connection pooling.

Provider
The "Provider" property must have the value "Mondrian".

Role
The "Role" property is the name of the role to adopt.

UseContentChecksum
Allows to work with dynamically changing schema.

UseSchemaPool
The "UseSchemaPool" property disables the schema cache.

Field Summary

static String

JdbcPropertyPrefix Any property beginning with this value will be added to the JDBC connection properties, after removing this prefix.

Method Summary

static RolapConnectionProperties	valueOf(String name) Returns the enum constant of this type with the specified name.
static RolapConnectionProperties[]	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

Provider

public static final RolapConnectionProperties Provider

The "Provider" property must have the value "Mondrian".

Jdbc

public static final RolapConnectionProperties Jdbc

The "Jdbc" property is the URL of the JDBC database where the data is stored. You must specify either DataSource or Jdbc.

JdbcDrivers

public static final RolapConnectionProperties JdbcDrivers

The "JdbcDrivers" property is a comma-separated list of JDBC driver classes, for example, "sun.jdbc.odbc.JdbcOdbcDriver,oracle.jdbc.OracleDriver".

JdbcUser

public static final RolapConnectionProperties JdbcUser

The "JdbcUser" property is the name of the user to log on to the JDBC database. (You don't need to specify this parameter if it is already specified in the JDBC URL.)

JdbcPassword

public static final RolapConnectionProperties JdbcPassword

The "JdbcPassword" property is the password to log on to the JDBC database. (You don't need to specify this parameter if it is already specified in the JDBC URL.)

Catalog

public static final RolapConnectionProperties Catalog

The "Catalog" property is the URL of the catalog, an XML file which describes the schema: cubes, hierarchies, and so forth. Catalogs are described in the Schema Guide. See also CatalogContent.

CatalogContent

public static final RolapConnectionProperties CatalogContent

The "CatalogContent" property is an XML string representing the schema: cubes, hierarchies, and so forth. Catalogs are described in the Schema Guide. See also Catalog.

CatalogName

public static final RolapConnectionProperties CatalogName

The "CatalogName" property is not used. If, in future, we support multiple catalogs, this property will specify which catalog to use. See also Catalog.

DataSource

public static final RolapConnectionProperties DataSource

The "DataSource" property is the name of a data source class. It must implement the DataSource interface. You must specify either DataSource or Jdbc.

PoolNeeded

public static final RolapConnectionProperties PoolNeeded

The "PoolNeeded" property tells Mondrian whether to add a layer of connection pooling.

If no value is specified, we assume that:

• connections created via the Jdbc property are not pooled, and therefore need to be pooled,
• connections created via the DataSource are already pooled.

Role

public static final RolapConnectionProperties Role

The "Role" property is the name of the role to adopt. If not specified, the connection uses a role which has access to every object in the schema.

UseContentChecksum

public static final RolapConnectionProperties UseContentChecksum

Allows to work with dynamically changing schema. If this property is set to true and schema content has changed (previous checksum doesn't equal with current), schema would be reloaded. Could be used in combination with DynamicSchemaProcessor property

UseSchemaPool

public static final RolapConnectionProperties UseSchemaPool

The "UseSchemaPool" property disables the schema cache. If false, the schema is not shared with connections which have a textually identical schema. Default is "true".

DynamicSchemaProcessor

public static final RolapConnectionProperties DynamicSchemaProcessor

The name of a class implementing the DynamicSchemaProcessor interface. A dynamic schema processor is called at runtime in order to modify the schema content.

Locale

public static final RolapConnectionProperties Locale

The "Locale" property is the requested Locale for the LocalizingDynamicSchemaProcessor. Example values are "en", "en_US", "hu". If Locale is not specified, then the name of system's default will be used, as per Locale.getDefault().

DataSourceChangeListener

public static final RolapConnectionProperties DataSourceChangeListener

The name of a class implementing the DataSourceChangeListener interface. A data source change listener is used to flush the cache of mondrian every time the datasource is changed.

Ignore

public static final RolapConnectionProperties Ignore

The "Ignore" property is a boolean value. If true, mondrian ignores warnings and non-fatal errors while loading the schema. The resulting errors can be obtained by calling Schema.getWarnings().

Field Detail

JdbcPropertyPrefix

public static final String JdbcPropertyPrefix

Any property beginning with this value will be added to the JDBC connection properties, after removing this prefix. This allows you to specify connection properties without a URL.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static RolapConnectionProperties 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