Package org.olap4j

Class OlapException

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<java.lang.Throwable>
    Direct Known Subclasses:
    XmlaOlap4jInvalidStateException

    public class OlapException
    extends java.sql.SQLException

    An exception describing an error accessing an OLAP database.

    Since olap4j extends JDBC, it is natural that OlapException should extend JDBC's SQLException. The implementation by an olap4j driver of a JDBC method which is declared to throw a SQLException may, if the driver chooses, throw instead an OlapException.

    OlapException provides some additional information to help an OLAP client identify the location of the error. This information is

    Since:
    Oct 23, 2006
    Author:
    jhyde
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OlapException.Region
      Description of the position of a syntax or validation error in the source MDX string.
    • Constructor Summary

      Constructors 
      Constructor Description
      OlapException()
      Constructs an OlapException object; the reason field defaults to null, the sqlState field defaults to null, and the vendorCode field defaults to 0.
      OlapException​(java.lang.String reason)
      Constructs an OlapException object with a reason; the sqlState field defaults to null, and the vendorCode field defaults to 0.
      OlapException​(java.lang.String reason, java.lang.String sqlState)
      Constructs an OlapException object with the given reason and SQLState; the vendorCode field defaults to 0.
      OlapException​(java.lang.String reason, java.lang.String sqlState, int vendorCode)
      Constructs an OlapException object with a given reason, SQLState and vendorCode.
      OlapException​(java.lang.String reason, java.lang.String sqlState, int vendorCode, java.lang.Throwable cause)
      Constructs an OlapException object with a given reason, SQLState, vendorCode and cause.
      OlapException​(java.lang.String reason, java.lang.String sqlState, java.lang.Throwable cause)
      Constructs an OlapException object with a given reason, SQLState and cause.
      OlapException​(java.lang.String reason, java.lang.Throwable cause)
      Constructs an OlapException object with a given reason and cause.
      OlapException​(java.lang.Throwable cause)
      Constructs an OlapException object with a given cause.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object getContext()
      Returns the context where the exception occurred.
      OlapException.Region getRegion()
      Returns the textual region where the exception occurred, or null if no region can be identified.
      void setContext​(java.lang.Object context)
      Sets the context where the exception occurred.
      void setRegion​(OlapException.Region region)
      Sets the textual region where the exception occurred.
      • Methods inherited from class java.sql.SQLException

        getErrorCode, getNextException, getSQLState, iterator, setNextException
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Constructor Detail

      • OlapException

        public OlapException​(java.lang.String reason,
                             java.lang.String sqlState,
                             int vendorCode)
        Constructs an OlapException object with a given reason, SQLState and vendorCode.
        Parameters:
        reason - a description of the exception
        sqlState - an XOPEN or SQL 99 code identifying the exception
        vendorCode - a database vendor-specific exception code
      • OlapException

        public OlapException​(java.lang.String reason,
                             java.lang.String sqlState)
        Constructs an OlapException object with the given reason and SQLState; the vendorCode field defaults to 0.
        Parameters:
        reason - a description of the exception
        sqlState - an XOPEN or SQL 99 code identifying the exception
      • OlapException

        public OlapException​(java.lang.String reason)
        Constructs an OlapException object with a reason; the sqlState field defaults to null, and the vendorCode field defaults to 0.
        Parameters:
        reason - a description of the exception
      • OlapException

        public OlapException()
        Constructs an OlapException object; the reason field defaults to null, the sqlState field defaults to null, and the vendorCode field defaults to 0.
      • OlapException

        public OlapException​(java.lang.Throwable cause)
        Constructs an OlapException object with a given cause. The SQLState is initialized to null and the vendor code is initialized to 0. The reason is initialized to null if cause==null or to cause.toString() if cause!=null.

        Parameters:
        cause - the underlying reason for this OlapException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
      • OlapException

        public OlapException​(java.lang.String reason,
                             java.lang.Throwable cause)
        Constructs an OlapException object with a given reason and cause.
        Parameters:
        reason - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
        cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
      • OlapException

        public OlapException​(java.lang.String reason,
                             java.lang.String sqlState,
                             java.lang.Throwable cause)
        Constructs an OlapException object with a given reason, SQLState and cause. The vendor code is initialized to 0.
        Parameters:
        reason - a description of the exception.
        sqlState - an XOPEN or SQL:2003 code identifying the exception
        cause - the underlying reason for this OlapException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
      • OlapException

        public OlapException​(java.lang.String reason,
                             java.lang.String sqlState,
                             int vendorCode,
                             java.lang.Throwable cause)
        Constructs an OlapException object with a given reason, SQLState, vendorCode and cause.
        Parameters:
        reason - a description of the exception
        sqlState - an XOPEN or SQL:2003 code identifying the exception
        vendorCode - a database vendor-specific exception code
        cause - the underlying reason for this OlapException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
    • Method Detail

      • setRegion

        public void setRegion​(OlapException.Region region)
        Sets the textual region where the exception occurred.
        Parameters:
        region - Textual region
      • getRegion

        public OlapException.Region getRegion()
        Returns the textual region where the exception occurred, or null if no region can be identified.
        Returns:
        Region where the exception occurred
      • setContext

        public void setContext​(java.lang.Object context)
        Sets the context where the exception occurred.
        Parameters:
        context - Context where the exception occurred
        Throws:
        java.lang.IllegalArgumentException - If context is not a Cell or a Position
      • getContext

        public java.lang.Object getContext()
        Returns the context where the exception occurred. Typically a Cell or a Position, or null.
        Returns:
        context where the exception occurred, or null