diff --git a/build.xml b/build.xml index d1a91a0..cc3f00f 100644 --- a/build.xml +++ b/build.xml @@ -318,15 +318,16 @@ META-INF/**"/> - @@ -338,10 +339,41 @@ META-INF/**"/> scope="constructors,methods,types"/> - + + + + + + + + + + + + + + + + + diff --git a/doc/deployDoc.sh b/doc/deployDoc.sh index 5571a88..2ec39cf 100755 --- a/doc/deployDoc.sh +++ b/doc/deployDoc.sh @@ -59,10 +59,10 @@ EOF else - scp -oPort=8022 dist/doc.tar.gz jhyde@olap4j.org:/home/jhyde + scp -oPort=7022 dist/doc.tar.gz jhyde@olap4j.org:/home/jhyde GROUP_DIR=/home/jhyde/olap4j - ssh -p 8022 -T jhyde@olap4j.org < coordinates); /** - * Returns the Cell at a ordinal. + * Returns the Cell at an ordinal. * *

Equivalent to + * *

- * getCellFromStar(ordinalToCoordinates(ordinal) + * getCell(ordinalToCoordinates(ordinal)) *
* * @param ordinal 0-based ordinal of the cell @@ -116,7 +117,6 @@ public interface CellSet extends ResultSet, OlapWrapper { /** * Converts a list of cell coordinates to a cell ordinal. * - *

The mapping * @param coordinates Cell coordinates * @return Cell ordinal */ diff --git a/src/org/olap4j/CellSetAxisMetaData.java b/src/org/olap4j/CellSetAxisMetaData.java index 486ccf8..bd31f0c 100755 --- a/src/org/olap4j/CellSetAxisMetaData.java +++ b/src/org/olap4j/CellSetAxisMetaData.java @@ -17,21 +17,22 @@ /** * Description of structure of a particular axis of an {@link CellSet}. * - *

For example, in the MDX statement + *

For example, in the MDX statement

+ * *
- * - * SELECT
- * {[Measures].Members} ON COLUMNS,
- * CrossJoin([Store].Members, [Gender].Children)
- * DIMENSION PROPERTIES
- * MEMBER_ORDINAL,
- * MEMBER_UNIQUE_NAME,
- * DISPLAY_INFO ON ROWS
+ * 
+ * SELECT
+ *   {[Measures].Members} ON COLUMNS,
+ *   CrossJoin([Store].Members, [Gender].Children)
+ *   DIMENSION PROPERTIES
+ *      MEMBER_ORDINAL,
+ *      MEMBER_UNIQUE_NAME,
+ *      DISPLAY_INFO ON ROWS
  * FROM [Sales]
- * 
+ *
*
* - * the ROWS axis is described by the following metadata: + *

the ROWS axis is described by the following metadata:

* * * diff --git a/src/org/olap4j/CellSetMetaData.java b/src/org/olap4j/CellSetMetaData.java index 795a440..efed5db 100755 --- a/src/org/olap4j/CellSetMetaData.java +++ b/src/org/olap4j/CellSetMetaData.java @@ -41,17 +41,23 @@ */ public interface CellSetMetaData extends ResultSetMetaData, OlapWrapper { /** - * Returns a list of properties which each Cell may have. + * Returns a list of Property objects which each Cell may have. + * + * @return list of cell properties */ List getCellProperties(); /** * Returns the Cube which was referenced in this statement. + * + * @return cube referenced in this statement */ Cube getCube(); /** - * Returns a list of metadata describing each result axis. + * Returns a list of CellSetAxisMetaData describing each result axis. + * + * @return list of metadata describing each result axis */ List getAxesMetaData(); } diff --git a/src/org/olap4j/OlapConnection.java b/src/org/olap4j/OlapConnection.java index faf89c4..1191a00 100644 --- a/src/org/olap4j/OlapConnection.java +++ b/src/org/olap4j/OlapConnection.java @@ -26,24 +26,44 @@ public interface OlapConnection extends Connection, OlapWrapper { // overrides Connection, with refined return type and throws list + /** + * {@inheritDoc} + * @throws OlapException if database error occurs + */ OlapDatabaseMetaData getMetaData() throws OlapException; /** * Creates a prepared OLAP Statement. + * + *

This method is the equivalent, for OLAP, of the + * {@link Connection#prepareStatement(String)} JDBC method.

+ * + * @param mdx MDX query string + * @return prepared statement + * @throws OlapException if database error occurs */ PreparedOlapStatement prepareOlapStatement(String mdx) throws OlapException; /** * Returns the factory used to create MDX parsers in this connection. + * + * @return MDX parser factory */ MdxParserFactory getParserFactory(); // overrides Connection, with refined return type and throws list + /** + * {@inheritDoc} + * @throws OlapException if database error occurs + */ OlapStatement createStatement() throws OlapException; /** * Returns the current {@link org.olap4j.metadata.Schema} of this * connection. + * + * @return current Schema + * @throws OlapException if database error occurs */ Schema getSchema() throws OlapException; diff --git a/src/org/olap4j/OlapDatabaseMetaData.java b/src/org/olap4j/OlapDatabaseMetaData.java index eca543c..4af41e6 100644 --- a/src/org/olap4j/OlapDatabaseMetaData.java +++ b/src/org/olap4j/OlapDatabaseMetaData.java @@ -33,10 +33,13 @@ public interface OlapDatabaseMetaData extends DatabaseMetaData, OlapWrapper { // override return type + /** + * {@inheritDoc} + */ OlapConnection getConnection() throws SQLException; /** - * Retrieves a list of descriptions of an Action. + * Retrieves a result set describing the Actions in this database. * *

Specification as for XML/A MDSCHEMA_ACTIONS schema rowset. * @@ -206,7 +209,7 @@ ResultSet getDatabaseProperties( String propertyNamePattern) throws OlapException; /** - * Retrieves a list of descriptions of member and cell Properties. + * Retrieves a result set describing member and cell Properties. * *

Specification as for XML/A MDSCHEMA_PROPERTIES schema rowset. * @@ -285,6 +288,7 @@ ResultSet getDatabaseProperties( * @exception OlapException if a database access error occurs * * @see #getSearchStringEscape + * @see org.olap4j.metadata.Property */ ResultSet getProperties( String catalog, @@ -306,7 +310,7 @@ ResultSet getProperties( String getMdxKeywords() throws OlapException; /** - * Retrieves a description of a cube. + * Retrieves a result set describing the Cubes in this database. * *

Specification as for XML/A MDSCHEMA_CUBES schema rowset. * @@ -360,6 +364,7 @@ ResultSet getProperties( * @exception OlapException if a database access error occurs * * @see #getSearchStringEscape + * @see org.olap4j.metadata.Cube */ public ResultSet getCubes( String catalog, @@ -367,8 +372,8 @@ public ResultSet getCubes( String cubeNamePattern) throws OlapException; /** - * Retrieves a result set describing the shared and private dimensions - * within a database. + * Retrieves a result set describing the shared and private Dimensions + * in this database. * *

Specification as for XML/A MDSCHEMA_DIMENSIONS schema rowset. * @@ -435,6 +440,7 @@ public ResultSet getCubes( * @exception OlapException if a database access error occurs * * @see #getSearchStringEscape + * @see org.olap4j.metadata.Dimension */ ResultSet getDimensions( String catalog, @@ -443,7 +449,7 @@ ResultSet getDimensions( String dimensionNamePattern) throws OlapException; /** - * Retrieves a result set describing the functions available to client + * Retrieves a result set describing the Functions available to client * applications connected to the database. * *

Specification as for XML/A MDSCHEMA_FUNCTIONS schema rowset. @@ -484,8 +490,7 @@ ResultSet getOlapFunctions( String functionNamePattern) throws OlapException; /** - * Retrieves a result set describing each hierarchy within a particular - * dimension. + * Retrieves a result set describing the Hierarchies in this database. * *

Specification as for XML/A MDSCHEMA_HIERARCHIES schema rowset. * @@ -561,6 +566,7 @@ ResultSet getOlapFunctions( * @exception OlapException if a database access error occurs * * @see #getSearchStringEscape + * @see org.olap4j.metadata.Hierarchy */ ResultSet getHierarchies( String catalog, @@ -570,8 +576,7 @@ ResultSet getHierarchies( String hierarchyNamePattern) throws OlapException; /** - * Retrieves a result set describing each level within a particular - * hierarchy. + * Retrieves a result set describing the Levels in this database. * *

Specification as for XML/A MDSCHEMA_LEVELS schema rowset. * @@ -650,6 +655,7 @@ ResultSet getHierarchies( * @exception OlapException if a database access error occurs * * @see #getSearchStringEscape + * @see org.olap4j.metadata.Level */ ResultSet getLevels( String catalog, @@ -660,7 +666,7 @@ ResultSet getLevels( String levelNamePattern) throws OlapException; /** - * Retrieves a result set describing each measure within a cube. + * Retrieves a result set describing the Measures in this database. * *

Specification as for XML/A MDSCHEMA_MEASURES schema rowset. * @@ -721,6 +727,7 @@ ResultSet getLevels( * @exception OlapException if a database access error occurs * * @see #getSearchStringEscape + * @see org.olap4j.metadata.Measure */ ResultSet getMeasures( String catalog, @@ -730,7 +737,7 @@ ResultSet getMeasures( String measureUniqueName) throws OlapException; /** - * Retrieves a result set describing the members within a database. + * Retrieves a result set describing the Members in this database. * *

Specification as for XML/A MDSCHEMA_MEMBERS schema rowset. * @@ -839,6 +846,7 @@ ResultSet getMeasures( * @exception OlapException if a database access error occurs * * @see #getSearchStringEscape + * @see org.olap4j.metadata.Member */ ResultSet getMembers( String catalog, @@ -851,7 +859,7 @@ ResultSet getMembers( Set treeOps) throws OlapException; /** - * Retrieves a result set describing each named set. + * Retrieves a result set describing the named Sets in this database. * *

Specification as for XML/A MDSCHEMA_SETS schema rowset. * @@ -889,6 +897,7 @@ ResultSet getMembers( * @exception OlapException if a database access error occurs * * @see #getSearchStringEscape + * @see org.olap4j.metadata.NamedSet */ ResultSet getSets( String catalog, diff --git a/src/org/olap4j/OlapException.java b/src/org/olap4j/OlapException.java index 7df0848..10fa0ad 100644 --- a/src/org/olap4j/OlapException.java +++ b/src/org/olap4j/OlapException.java @@ -74,12 +74,15 @@ public OlapException() { } /** - * Constructs an OlapException object with a given + * Constructs an OlapException object with a given * reason and cause. - *

- * @param cause the underlying reason for this SQLException - * (which is saved for later retrieval by the getCause() method); - * may be null indicating the cause is non-existent or unknown. + * + * @param reason the detail message (which is saved for later retrieval + * by the {@link #getMessage()} method). + * @param cause the cause (which is saved for later retrieval by the + * {@link #getCause()} method). (A null value is + * permitted, and indicates that the cause is nonexistent or + * unknown.) */ public OlapException(String reason, Throwable cause) { // Cannot call super(reason, cause) because @@ -90,6 +93,8 @@ public OlapException(String reason, Throwable cause) { /** * Sets the textual region where the exception occurred. + * + * @param region Textual region */ public void setRegion(Region region) { this.region = region; @@ -98,6 +103,8 @@ public void setRegion(Region region) { /** * Returns the textual region where the exception occurred, or null if no * region can be identified. + * + * @return Region where the exception occurred */ public Region getRegion() { return region; @@ -122,6 +129,8 @@ public void setContext(Object context) { /** * Returns the context where the exception occurred. * Typically a {@link Cell} or a {@link Position}, or null. + * + * @return context where the exception occurred, or null */ public Object getContext() { return context; @@ -132,15 +141,19 @@ public Object getContext() { * MDX string. * *

Row and column positions are 1-based and inclusive. For example, - * in + * in

* *
- * SELECT { [Measures].MEMBERS } ON COLUMNS, { } ON ROWS FROM [Sales] + * 
+     * SELECT { [Measures].MEMBERS } ON COLUMNS,
+     *    { } ON ROWS
+     * FROM [Sales]
+     *
*
* - * the SELECT keyword occupies positions (1, 1) through (1, 6), - * and would have a Region(startLine=1, startColumn=1, endColumn=1, - * endLine=6). + *

the SELECT keyword occupies positions (1, 1) through + * (1, 6), and would have a Region(startLine=1, startColumn=1, + * endColumn=1, endLine=6).

*/ public static final class Region { public final int startLine; diff --git a/src/org/olap4j/OlapStatement.java b/src/org/olap4j/OlapStatement.java index 84daef5..689cae4 100644 --- a/src/org/olap4j/OlapStatement.java +++ b/src/org/olap4j/OlapStatement.java @@ -14,7 +14,7 @@ import org.olap4j.mdx.SelectNode; /** - * Object used for statically executing an MDX statement and returning an + * Object used for statically executing an MDX statement and returning a * {@link CellSet}. * * @see PreparedOlapStatement diff --git a/src/org/olap4j/Todo.java b/src/org/olap4j/Todo.java deleted file mode 100644 index ef92abc..0000000 --- a/src/org/olap4j/Todo.java +++ /dev/null @@ -1,22 +0,0 @@ -/* -// $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; - -/** - * Reference this class as a way of flagging todo items. - * - * @author jhyde - * @version $Id$ - * @since Aug 23, 2006 - */ -public class Todo { -} - -// End Todo.java