Package org.olap4j

Interface OlapStatement

    • Field Summary

      • Fields inherited from interface java.sql.Statement

        CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addListener​(CellSetListener.Granularity granularity, CellSetListener listener)
      Adds a listener to be notified of events to CellSets created by this statement.
      CellSet executeOlapQuery​(java.lang.String mdx)
      Executes an OLAP statement.
      CellSet executeOlapQuery​(SelectNode selectNode)
      Executes an OLAP statement expressed as a parse tree.
      OlapConnection getConnection()
      Retrieves the OlapConnection object that produced this OlapStatement object.
      • Methods inherited from interface java.sql.Statement

        addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
      • Methods inherited from interface java.sql.Wrapper

        isWrapperFor, unwrap
    • Method Detail

      • getConnection

        OlapConnection getConnection()
                              throws java.sql.SQLException
        Retrieves the OlapConnection object that produced this OlapStatement object.
        Specified by:
        getConnection in interface java.sql.Statement
        Throws:
        java.sql.SQLException
      • executeOlapQuery

        CellSet executeOlapQuery​(java.lang.String mdx)
                          throws OlapException
        Executes an OLAP statement.
        Parameters:
        mdx - MDX SELECT statement
        Returns:
        Cell set
        Throws:
        OlapException - if a database access error occurs, this method is called on a closed OlapStatement, the query times out (see Statement.setQueryTimeout(int)) or another thread cancels the statement (see Statement.cancel())
      • executeOlapQuery

        CellSet executeOlapQuery​(SelectNode selectNode)
                          throws OlapException
        Executes an OLAP statement expressed as a parse tree.

        Validates the parse tree before executing it.

        Parameters:
        selectNode - Parse tree of MDX SELECT statement
        Returns:
        Cell set
        Throws:
        OlapException - if a database access error occurs, this method is called on a closed OlapStatement, the query times out (see Statement.setQueryTimeout(int)) or another thread cancels the statement (see Statement.cancel())
      • addListener

        void addListener​(CellSetListener.Granularity granularity,
                         CellSetListener listener)
                  throws OlapException
        Adds a listener to be notified of events to CellSets created by this statement.

        NOTE: You may wonder why this method belongs to the OlapStatement class and not CellSet. If the method belonged to CellSet there would be a window between creation and registering a listener during which events might be lost, whereas registering the listener with the statement ensures that the listener is attached immediately that the cell set is opened. It follows that registering a listener does not affect the cell set currently open (if any), and that no events will be received if the statement has no open cell sets.

        Parameters:
        granularity - Granularity of cell set events to listen for
        listener - Listener to be notified of changes
        Throws:
        OlapException - if granularity is not one supported by this server, per the OlapDatabaseMetaData.getSupportedCellSetListenerGranularities() method