| PROPERTY_IS_VISIBLE |
- DBTYPE_BOOL |
+ boolean |
A Boolean that indicates whether the property is
visible.
@@ -2913,34 +2918,34 @@
- | Column name |
- Type indicator |
+ Column name |
+ Type |
Description |
| CATALOG_NAME |
- DBTYPE_WSTR |
+ String |
The name of the database. |
| SCHEMA_NAME |
- DBTYPE_WSTR |
+ String |
Not supported. |
| CUBE_NAME |
- DBTYPE_WSTR |
+ String |
The name of the cube. |
| SET_NAME |
- DBTYPE_WSTR |
+ String |
The name of the set, as specified in the
CREATE SET statement. |
| SCOPE |
- DBTYPE_I4 |
+ int |
The scope of the set:
- MDSET_SCOPE_GLOBAL (1)
- MDSET_SCOPE_SESSION (2)
@@ -2949,30 +2954,30 @@
|
| DESCRIPTION |
- DBTYPE_WSTR |
+ String |
Not supported. |
| EXPRESSION |
- DBTYPE_WSTR |
+ String |
The expression for the set. |
| DIMENSIONS |
- DBTYPE_WSTR |
+ String |
A comma delimited list of hierarchies included
in the set. |
| SET_CAPTION |
- DBTYPE_WSTR |
+ String |
A label or caption associated with the set. The
label or caption is used primarily for display
purposes. |
| SET_DISPLAY_FOLDER |
- DBTYPE_WSTR |
+ String |
The path to be used by the user interface when
displaying the set. Folder names are separated by a
backslash (\), folders are separated by a
@@ -2991,8 +2996,15 @@
| Description |
- getMdxKeywords() |
- Returns |
+
+ getDatabase() |
+ Returns the one and only Database. |
+
+
+
+ getMdxKeywords() |
+ Returns the keywords of this dialect of MDX, as a comma-separated
+ string. |
diff --git a/lib/spring.jar b/lib/spring.jar
new file mode 100755
index 0000000..e6b517d
Binary files /dev/null and b/lib/spring.jar differ
diff --git a/src/org/olap4j/OlapConnection.java b/src/org/olap4j/OlapConnection.java
index 1a29a41..c4e37e3 100644
--- a/src/org/olap4j/OlapConnection.java
+++ b/src/org/olap4j/OlapConnection.java
@@ -10,10 +10,9 @@
package org.olap4j;
import org.olap4j.mdx.parser.MdxParserFactory;
+import org.olap4j.metadata.Schema;
import java.sql.Connection;
-import java.sql.SQLException;
-import java.sql.Statement;
/**
* Connection to an OLAP server.
@@ -24,21 +23,27 @@
*/
public interface OlapConnection extends Connection {
+ // overrides Connection, with refined return type and throws list
+ OlapDatabaseMetaData getMetaData() throws OlapException;
+
/**
* Creates a prepared OLAP Statement.
*/
- PreparedOlapStatement prepareOlapStatement(String mdx) throws SQLException;
+ PreparedOlapStatement prepareOlapStatement(String mdx) throws OlapException;
/**
* Returns the factory used to create MDX parsers in this connection.
*/
MdxParserFactory getParserFactory();
+ // overrides Connection, with refined return type and throws list
+ OlapStatement createStatement() throws OlapException;
+
/**
- * Override {@link java.sql.Connection#createStatement()} with refined
- * result type.
+ * Returns the current {@link org.olap4j.metadata.Schema} of this
+ * connection.
*/
- OlapStatement createStatement() throws SQLException;
+ Schema getSchema() throws OlapException;
}
// End OlapConnection.java
diff --git a/src/org/olap4j/OlapDatabaseMetaData.java b/src/org/olap4j/OlapDatabaseMetaData.java
index d7c7340..a22af8c 100644
--- a/src/org/olap4j/OlapDatabaseMetaData.java
+++ b/src/org/olap4j/OlapDatabaseMetaData.java
@@ -13,7 +13,6 @@
import java.sql.DatabaseMetaData;
import java.sql.ResultSet;
-import java.sql.SQLException;
/**
* Information about an OLAP database.
@@ -44,7 +43,7 @@ public interface OlapDatabaseMetaData extends DatabaseMetaData {
*
* todo: document parameters and result set columns
*/
- ResultSet getActions() throws SQLException;
+ ResultSet getActions() throws OlapException;
/**
* Retrives a list of olap4j data sources that are available on the server.
@@ -54,7 +53,7 @@ public interface OlapDatabaseMetaData extends DatabaseMetaData {
* todo: document parameters and result set columns
*/
ResultSet getDatasources(
- String dataSourceName) throws SQLException;
+ String dataSourceName) throws OlapException;
/**
* Retrieves a list of information on supported literals, including data
@@ -64,7 +63,7 @@ ResultSet getDatasources(
*
* todo: document parameters and result set columns
*/
- ResultSet getLiterals() throws SQLException;
+ ResultSet getLiterals() throws OlapException;
/**
* Retrieves a list of the standard and provider-specific properties
@@ -78,7 +77,7 @@ ResultSet getDatasources(
* todo: document parameters and result set columns
*/
ResultSet getDatabaseProperties(
- String dataSourceName) throws SQLException;
+ String dataSourceName) throws OlapException;
/**
* Retrieves a list of descriptions of member and cell Properties.
@@ -89,15 +88,15 @@ ResultSet getDatabaseProperties(
*
* todo: document parameters and result set columns
*/
- ResultSet getProperties() throws SQLException;
+ ResultSet getProperties() throws OlapException;
/**
* Retrieves a comma-separated list of all of this database's MDX keywords.
*
* @return the list of this database's MDX keywords
- * @exception java.sql.SQLException if a database access error occurs
+ * @exception OlapException if a database access error occurs
*/
- String getMdxKeywords() throws SQLException;
+ String getMdxKeywords() throws OlapException;
/**
* Retrieves a description of a cube.
@@ -117,7 +116,7 @@ ResultSet getDatabaseProperties(
public ResultSet getCubes(
String catalog,
String schemaPattern,
- String cubeNamePattern) throws SQLException;
+ String cubeNamePattern) throws OlapException;
/**
* Retrieves a result set describing the shared and private dimensions
* within a database.
@@ -126,7 +125,7 @@ public ResultSet getCubes(
*
* todo: document parameters and result set columns
*/
- ResultSet getDimensions() throws SQLException;
+ ResultSet getDimensions() throws OlapException;
/**
* Retrieves a result set describing the functions available to client
@@ -136,7 +135,7 @@ public ResultSet getCubes(
*
* todo: document parameters and result set columns
*/
- ResultSet getFunctions() throws SQLException;
+ ResultSet getFunctions() throws OlapException;
/**
* Retrieves a result set describing each hierarchy within a particular
@@ -146,7 +145,7 @@ public ResultSet getCubes(
*
* todo: document parameters and result set columns
*/
- ResultSet getHierarchies() throws SQLException;
+ ResultSet getHierarchies() throws OlapException;
/**
* Retrieves a result set describing each measure within a cube.
@@ -155,7 +154,7 @@ public ResultSet getCubes(
*
* todo: document parameters and result set columns
*/
- ResultSet getMeasures() throws SQLException;
+ ResultSet getMeasures() throws OlapException;
/**
* Retrieves a result set describing the members within a database.
@@ -164,7 +163,7 @@ public ResultSet getCubes(
*
* todo: document parameters and result set columns
*/
- ResultSet getMembers() throws SQLException;
+ ResultSet getMembers() throws OlapException;
/**
* Retrieves a result set describing each level within a particular
@@ -174,7 +173,7 @@ public ResultSet getCubes(
*
* todo: document parameters and result set columns
*/
- ResultSet getLevels() throws SQLException;
+ ResultSet getLevels() throws OlapException;
/**
* Retrieves a result set describing each calculated set.
@@ -183,7 +182,7 @@ public ResultSet getCubes(
*
* todo: document parameters and result set columns
*/
- ResultSet getSets() throws SQLException;
+ ResultSet getSets() throws OlapException;
}
// End OlapDatabaseMetaData.java
diff --git a/src/org/olap4j/OlapParameterMetaData.java b/src/org/olap4j/OlapParameterMetaData.java
index 6e24b6a..fd210b7 100755
--- a/src/org/olap4j/OlapParameterMetaData.java
+++ b/src/org/olap4j/OlapParameterMetaData.java
@@ -12,7 +12,6 @@
import org.olap4j.type.Type;
import java.sql.ParameterMetaData;
-import java.sql.SQLException;
/**
* Extension to {@link ParameterMetaData} for parameters of OLAP statements.
@@ -44,9 +43,9 @@ public interface OlapParameterMetaData extends ParameterMetaData {
*
* @param param the first parameter is 1, the second is 2, ...
* @return OLAP type
- * @exception SQLException if a database access error occurs
+ * @exception OlapException if a database access error occurs
*/
- Type getOlapType(int param) throws SQLException;
+ Type getOlapType(int param) throws OlapException;
}
// End OlapParameterMetaData.java
diff --git a/src/org/olap4j/OlapResultSet.java b/src/org/olap4j/OlapResultSet.java
index 8effae4..3884744 100644
--- a/src/org/olap4j/OlapResultSet.java
+++ b/src/org/olap4j/OlapResultSet.java
@@ -9,13 +9,8 @@
*/
package org.olap4j;
-import org.olap4j.metadata.Property;
-import org.olap4j.metadata.Cube;
-
import java.util.List;
import java.sql.ResultSet;
-import java.sql.ResultSetMetaData;
-import java.sql.SQLException;
/**
* Result of executing an OLAP Statement.
diff --git a/src/org/olap4j/OlapStatement.java b/src/org/olap4j/OlapStatement.java
index a49f0f4..bc732b4 100644
--- a/src/org/olap4j/OlapStatement.java
+++ b/src/org/olap4j/OlapStatement.java
@@ -9,12 +9,9 @@
*/
package org.olap4j;
-import org.olap4j.metadata.Cube;
+import mondrian.olap.Query;
import java.sql.Statement;
-import java.sql.SQLException;
-
-import mondrian.olap.Query;
/**
* Object used for statically executing an MDX statement and returning an
@@ -31,7 +28,7 @@ public interface OlapStatement extends Statement {
/**
* Executes an OLAP statement.
*/
- OlapResultSet executeOlapQuery(String mdx) throws SQLException;
+ OlapResultSet executeOlapQuery(String mdx) throws OlapException;
/**
* Executes an OLAP statement expressed as a parse tree.
diff --git a/src/org/olap4j/PreparedOlapStatement.java b/src/org/olap4j/PreparedOlapStatement.java
index 9727ac4..4c7f2e3 100644
--- a/src/org/olap4j/PreparedOlapStatement.java
+++ b/src/org/olap4j/PreparedOlapStatement.java
@@ -12,25 +12,24 @@
import org.olap4j.metadata.Cube;
import java.sql.PreparedStatement;
-import java.sql.SQLException;
/**
* An object that represents a precompiled OLAP statement.
*
- * An OLAP statement is precompiled and stored in a
+ * An OLAP statement is precompiled and stored in a
* PreparedOlapStatement object. This object can then be used to
- * efficiently execute this statement multiple times.
+ * efficiently execute this statement multiple times.
*
- * Note: The setter methods (setShort,
+ * Note: The setter methods (setShort,
* setString, and so on) for setting IN parameter values
* must specify types that are compatible with the defined type of
* the input parameter. For instance, if the IN parameter has type
- * INTEGER, then the method setInt should be used.
+ * INTEGER, then the method setInt should be used.
*
* If a parameter has Member type, use the {@link #setObject(int, Object)}
- * method to set it. A {@link SQLException} will be thrown if the object is not
+ * method to set it. A {@link OlapException} will be thrown if the object is not
* an instance of {@link org.olap4j.metadata.Member} or does not belong to the
- * correct {@link org.olap4j.metadata.Hierarchy}.
+ * correct {@link org.olap4j.metadata.Hierarchy}.
*
* The method {@link #getParameterMetaData()} returns a description of the
* parameters, as in JDBC. The result is an {@link OlapParameterMetaData}.
@@ -55,9 +54,9 @@ public interface PreparedOlapStatement
*
* @return an OlapResultSet object that contains the data produced
* by the query; never null
- * @exception SQLException if a database access error occurs
+ * @exception OlapException if a database access error occurs
*/
- OlapResultSet executeQuery() throws SQLException;
+ OlapResultSet executeQuery() throws OlapException;
/**
* Retrieves the number, types and properties of this
@@ -66,10 +65,10 @@ public interface PreparedOlapStatement
* @return an OlapParameterMetaData object that contains
* information about the number, types and properties of this
* PreparedOlapStatement object's parameters
- * @exception SQLException if a database access error occurs
+ * @exception OlapException if a database access error occurs
* @see OlapParameterMetaData
*/
- OlapParameterMetaData getParameterMetaData() throws SQLException;
+ OlapParameterMetaData getParameterMetaData() throws OlapException;
/**
* Returns the cube (or virtual cube) which this statement is based upon.
diff --git a/src/org/olap4j/metadata/Cube.java b/src/org/olap4j/metadata/Cube.java
index 6d808f7..5259580 100644
--- a/src/org/olap4j/metadata/Cube.java
+++ b/src/org/olap4j/metadata/Cube.java
@@ -40,6 +40,13 @@ public interface Cube extends MetadataElement {
*/
List getMeasures();
+ /**
+ * Returns a list of {@link NamedSet} objects in this Cube.
+ *
+ * @see org.olap4j.OlapDatabaseMetaData#getSets()
+ */
+ NamedList getSets();
+
/**
* Returns a collection of {@link java.util.Locale} objects for which this
* Cube has been localized.
diff --git a/src/org/olap4j/metadata/Database.java b/src/org/olap4j/metadata/Database.java
index e67a120..86a86b3 100644
--- a/src/org/olap4j/metadata/Database.java
+++ b/src/org/olap4j/metadata/Database.java
@@ -9,8 +9,47 @@
*/
package org.olap4j.metadata;
+import org.olap4j.OlapDatabaseMetaData;
+
/**
- * Database ...
+ *
+ * A Database is the root object in the hierarchy of metadata
+ * objects:
+ *
+ *
+ * - {@link Database}
+ * - {@link Catalog}
+ * - {@link Schema}
+ * - {@link Cube}
+ * - {@link Dimension}
+ * - {@link Hierarchy}
+ * - {@link Level}
+ * - {@link Member}
+ * - {@link Property}
+ *
+ *
+ *
+ * - {@link NamedSet}
+ *
+ * - Dimension (shared)
+ *
+ *
+ *
+ *
+ *
+ * A Database is usually accessed from a connection via its
+ * metadata:
+ *
+ * OlapConnection connection;
+ * Database database = connection.getMetaData().getDatabase();
+ *
+ *
+ * or from a schema:
+ *
+ *
+ * OlapConnection connection;
+ * Database database = connection.getSchema().getCatalog().getDatabase();
+ *
*
* @author jhyde
* @version $Id: $
@@ -25,6 +64,11 @@ public interface Database {
* @return List of Catalogs in this Database
*/
NamedList getCatalogs();
+
+ /**
+ * Retrieves the metadata describing this Database.
+ */
+ OlapDatabaseMetaData getMetaData();
}
// End Database.java
diff --git a/src/org/olap4j/metadata/Hierarchy.java b/src/org/olap4j/metadata/Hierarchy.java
index 873065f..f766686 100644
--- a/src/org/olap4j/metadata/Hierarchy.java
+++ b/src/org/olap4j/metadata/Hierarchy.java
@@ -18,24 +18,20 @@
*/
public interface Hierarchy extends MetadataElement {
/**
- * Returns the {@link Dimension} this Hierarchy belongs to.
+ * Returns the {@link Dimension} this Hierarchy belongs to.
*/
Dimension getDimension();
/**
- * Returns the name of this Hierarchy.
- */
- String getName();
-
- /**
- * Returns a list of the {@link Level}s in this Hierarchy.
+ * Returns a list of the {@link Level} objects in this
+ * Hierarchy.
*
* @see org.olap4j.OlapDatabaseMetaData#getLevels
*/
NamedList getLevels();
/**
- * Returns whether this Hierarchy has an 'all' member.
+ * Returns whether this Hierarchy has an 'all' member.
*/
boolean hasAll();
}
diff --git a/src/org/olap4j/metadata/Level.java b/src/org/olap4j/metadata/Level.java
index c86172c..7e29d73 100644
--- a/src/org/olap4j/metadata/Level.java
+++ b/src/org/olap4j/metadata/Level.java
@@ -19,7 +19,7 @@
*/
public interface Level extends MetadataElement {
/**
- * Returns the depth of this level.
+ * Returns the depth of this Level.
*
* Note #1: In an access-controlled context, the first visible level of
* a hierarchy may not have a depth of 0.
@@ -30,24 +30,24 @@ public interface Level extends MetadataElement {
int getDepth();
/**
- * Returns the Hierarchy this Level belongs to.
+ * Returns the {@link Hierarchy} this Level belongs to.
*/
Hierarchy getHierarchy();
/**
- * Returns the Dimension this Level belongs to.
+ * Returns the Dimension this Level belongs to.
* (Always equivalent to getHierarchy().getDimension().)
*/
Dimension getDimension();
/**
- * Returns the type of this Level.
+ * Returns the type of this Level.
*/
Level.Type getLevelType();
/**
* Returns a list of definitions for the properties available to members
- * of this Level.
+ * of this Level.
*
* @see org.olap4j.OlapDatabaseMetaData#getProperties()
*/
diff --git a/src/org/olap4j/metadata/Member.java b/src/org/olap4j/metadata/Member.java
index 69a8d0f..f324687 100644
--- a/src/org/olap4j/metadata/Member.java
+++ b/src/org/olap4j/metadata/Member.java
@@ -12,9 +12,10 @@
import mondrian.olap.Exp;
import mondrian.olap.Property;
-import java.sql.SQLException;
import java.util.List;
+import org.olap4j.OlapException;
+
/**
* Member is a data value in an OLAP Dimension.
*
@@ -153,10 +154,10 @@ private Type(int ordinal) {
*
* @param name Property name
* @param value Property value
- * @throws java.sql.SQLException if the value not valid for this property
+ * @throws OlapException if the value not valid for this property
* (for example, a String value assigned to a Boolean property)
*/
- void setProperty(String name, Object value) throws SQLException;
+ void setProperty(String name, Object value) throws OlapException;
/**
* Returns the definitions of the properties this member may have.
diff --git a/src/org/olap4j/metadata/NamedSet.java b/src/org/olap4j/metadata/NamedSet.java
new file mode 100644
index 0000000..c5b3f83
--- /dev/null
+++ b/src/org/olap4j/metadata/NamedSet.java
@@ -0,0 +1,26 @@
+/*
+// $Id: $
+// This software is subject to the terms of the Common Public License
+// Agreement, available at the following URL:
+// http://www.opensource.org/licenses/cpl.html.
+// Copyright (C) 2006-2006 Julian Hyde
+// All Rights Reserved.
+// You must accept the terms of that agreement to use this software.
+*/
+package org.olap4j.metadata;
+
+/**
+ * Metadata object describing a named set defined against a {@link Cube}.
+ *
+ * @author jhyde
+ * @version $Id: $
+ * @since Oct 24, 2006
+ */
+public interface NamedSet extends MetadataElement {
+ /**
+ * Returns the Cube that this NamedSet belongs to.
+ */
+ Cube getCube();
+}
+
+// End NamedSet.java
diff --git a/src/org/olap4j/metadata/Property.java b/src/org/olap4j/metadata/Property.java
index ed99def..1b35289 100644
--- a/src/org/olap4j/metadata/Property.java
+++ b/src/org/olap4j/metadata/Property.java
@@ -14,7 +14,8 @@
import java.util.Locale;
/**
- * Definition of a property of a Member or Cell.
+ * Definition of a property of a {@link Member} or
+ * {@link org.olap4j.ResultCell}.
*
* @author jhyde
* @version $Id$
diff --git a/src/org/olap4j/sample/SimpleQuerySample.java b/src/org/olap4j/sample/SimpleQuerySample.java
index 547c086..319e7db 100644
--- a/src/org/olap4j/sample/SimpleQuerySample.java
+++ b/src/org/olap4j/sample/SimpleQuerySample.java
@@ -9,18 +9,21 @@
*/
package org.olap4j.sample;
+import mondrian.olap.Query;
+
import org.olap4j.*;
-import org.olap4j.type.MemberType;
import org.olap4j.mdx.parser.MdxParser;
import org.olap4j.mdx.parser.MdxParserFactory;
-import org.olap4j.metadata.Member;
import org.olap4j.metadata.Dimension;
+import org.olap4j.metadata.Member;
+import org.olap4j.type.MemberType;
-import java.sql.*;
-import java.util.List;
+import java.sql.DriverManager;
+import java.sql.PreparedStatement;
+import java.sql.SQLException;
+import java.sql.Statement;
import java.util.ArrayList;
-
-import mondrian.olap.Query;
+import java.util.List;
/**
* Collection of olap4j samples illustrating connections and statements.
@@ -33,6 +36,8 @@ public class SimpleQuerySample {
public static void main(String[] args) {
try {
new SimpleQuerySample().simpleStatement();
+ } catch (OlapException e) {
+ e.printStackTrace();
} catch (SQLException e) {
e.printStackTrace();
} catch (ClassNotFoundException e) {
@@ -44,7 +49,9 @@ public static void main(String[] args) {
* Simple example which connects to an OLAP server, executes an OLAP
* statement and prints the result.
*/
- void simpleStatement() throws SQLException, ClassNotFoundException {
+ void simpleStatement()
+ throws OlapException, SQLException, ClassNotFoundException
+ {
// Register driver.
Class.forName("mondrian.olap4j.Driver");
diff --git a/src/org/olap4j/sample/SpringSample.java b/src/org/olap4j/sample/SpringSample.java
index 56c6c9a..0550f22 100644
--- a/src/org/olap4j/sample/SpringSample.java
+++ b/src/org/olap4j/sample/SpringSample.java
@@ -11,12 +11,10 @@
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.ResultSetExtractor;
-import org.springframework.dao.DataAccessException;
import org.olap4j.OlapResultSet;
import javax.sql.DataSource;
import java.sql.ResultSet;
-import java.sql.SQLException;
/**
* Example of olap4j code running inside Spring framework.
@@ -41,7 +39,6 @@ public static void example(DataSource dataSource) {
"from [Sales]",
new ResultSetExtractor() {
public Object extractData(ResultSet resultSet)
- throws SQLException, DataAccessException
{
OlapResultSet olapResult = (OlapResultSet) resultSet;
return "Result has " +
|
+