KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > mondrian > rolap > RolapConnectionProperties


1 /*
2 // $Id: //open/mondrian/src/main/mondrian/rolap/RolapConnectionProperties.java#16 $
3 // This software is subject to the terms of the Common Public License
4 // Agreement, available at the following URL:
5 // http://www.opensource.org/licenses/cpl.html.
6 // Copyright (C) 2003-2007 Julian Hyde
7 // All Rights Reserved.
8 // You must accept the terms of that agreement to use this software.
9 //
10 // jhyde, Mar 18, 2003
11 */
12 package mondrian.rolap;
13
14 /**
15  * <code>RolapConnectionProperties</code> enumerates the allowable values of
16  * keywords in a Mondrian connect string.
17  */
18 public enum RolapConnectionProperties {
19     /**
20      * The "Provider" property must have the value <code>"Mondrian"</code>.
21      */
22     Provider,
23
24     /**
25      * The "Jdbc" property is the URL of the JDBC database where the data is
26      * stored. You must specify either {@link #DataSource} or {@link #Jdbc}.
27      */
28     Jdbc,
29
30     /**
31      * The "JdbcDrivers" property is a comma-separated list of JDBC driver
32      * classes, for example,
33      * <code>"sun.jdbc.odbc.JdbcOdbcDriver,oracle.jdbc.OracleDriver"</code>.
34      */
35     JdbcDrivers,
36
37     /**
38      * The "JdbcUser" property is the name of the user to log on to the JDBC
39      * database. (You don't need to specify this parameter if it is already
40      * specified in the JDBC URL.)
41      */
42     JdbcUser,
43
44     /**
45      * The "JdbcPassword" property is the password to log on to the JDBC
46      * database. (You don't need to specify this parameter if it is already
47      * specified in the JDBC URL.)
48      */
49     JdbcPassword,
50
51     /**
52      * The "Catalog" property is the URL of the catalog, an XML file which
53      * describes the schema: cubes, hierarchies, and so forth.
54      * Catalogs are described in <a target="_top"
55      * HREF="{@docRoot}/../schema.html">the Schema Guide</a>.
56      * See also {@link #CatalogContent}.
57      */
58     Catalog,
59
60     /**
61      * The "CatalogContent" property is an XML string representing the schema:
62      * cubes, hierarchies, and so forth.
63      * Catalogs are described in <a target="_top"
64      * HREF="{@docRoot}/../schema.html">the Schema Guide</a>.
65      * See also {@link #Catalog}.
66      */
67     CatalogContent,
68
69     /**
70      * The "CatalogName" property is not used. If, in future, we support
71      * multiple catalogs, this property will specify which catalog to use.
72      * See also {@link #Catalog}.
73      */
74     CatalogName,
75
76     /**
77      * The "DataSource" property is the name of a data source class. It must
78      * implement the {@link javax.sql.DataSource} interface.
79      * You must specify either {@link #DataSource} or {@link #Jdbc}.
80      */
81     DataSource,
82
83     /**
84      * The "PoolNeeded" property tells Mondrian whether to add a layer of
85      * connection pooling.
86      *
87      * <p>If no value is specified, we assume that:<ul>
88      * <li>connections created via the {@link #Jdbc} property are not pooled,
89      * and therefore need to be pooled,
90      * <li>connections created via the {@link #DataSource} are already pooled.
91      * </ul>
92      */
93     PoolNeeded,
94
95     /**
96      * The "Role" property is the name of the {@link mondrian.olap.Role role}
97      * to adopt. If not specified, the connection uses a role which has access
98      * to every object in the schema.
99      */
100     Role,
101
102     /**
103      * Allows to work with dynamically changing schema. If this property is set
104      * to <code>true</code> and schema content has changed (previous checksum
105      * doesn't equal with current), schema would be reloaded. Could be used in
106      * combination with <code>DynamicSchemaProcessor</code> property
107      */
108     UseContentChecksum,
109
110     /**
111      * The name of a class implementing the
112      * {@link mondrian.rolap.DynamicSchemaProcessor} interface.
113      * A dynamic schema processor is called at runtime in order to modify the
114      * schema content.
115      */
116     DynamicSchemaProcessor,
117
118     /**
119      * The "Locale" property is the requested Locale for the
120      * LocalizingDynamicSchemaProcessor. Example values are "en",
121      * "en_US", "hu". If Locale is not specified, then the name of system's
122      * default will be used, as per {@link java.util.Locale#getDefault()}.
123      */
124     Locale,
125
126     /**
127      * The name of a class implementing the
128      * {@link mondrian.spi.DataSourceChangeListener} interface.
129      * A data source change listener is used to flush the cache of
130      * mondrian every time the datasource is changed.
131      */
132     DataSourceChangeListener;
133     /**
134      * Any property beginning with this value will be added to the
135      * JDBC connection properties, after removing this prefix. This
136      * allows you to specify connection properties without a URL.
137      */
138     public static final String JavaDoc JdbcPropertyPrefix = "jdbc.";
139
140     }
141
142 // End RolapConnectionProperties.java
143
Popular Tags