Package mondrian.xmla

Interface XmlaRequest

  • All Known Implementing Classes:
    DefaultXmlaRequest

    public interface XmlaRequest
    XML/A request interface.
    Author:
    Gang Chen
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      XmlaConstants.Method getMethod()
      Indicate DISCOVER or EXECUTE method.
      java.lang.String getPassword()
      The password to use to open the underlying olap4j connection.
      java.util.Map<java.lang.String,​java.lang.String> getProperties()
      Properties of XML/A request.
      java.lang.String getRequestType()
      Request type of DISCOVER method.
      java.util.Map<java.lang.String,​java.lang.Object> getRestrictions()
      Restrictions of DISCOVER method.
      java.lang.String getRoleName()
      Role name binds with this XML/A request.
      java.lang.String getSessionId()
      Returns the id of the session this request belongs to.
      java.lang.String getStatement()
      Statement of EXECUTE method.
      java.lang.String getUsername()
      The username to use to open the underlying olap4j connection.
      boolean isDrillThrough()
      Indicate whether statement is a drill through statement of EXECUTE method.
    • Method Detail

      • getProperties

        java.util.Map<java.lang.String,​java.lang.String> getProperties()
        Properties of XML/A request.
      • getRestrictions

        java.util.Map<java.lang.String,​java.lang.Object> getRestrictions()
        Restrictions of DISCOVER method.

        If the value is a list of strings, the restriction passes if the column has one of the values.

      • getStatement

        java.lang.String getStatement()
        Statement of EXECUTE method.
      • getRoleName

        java.lang.String getRoleName()
        Role name binds with this XML/A request. Maybe null.
      • getRequestType

        java.lang.String getRequestType()
        Request type of DISCOVER method.
      • isDrillThrough

        boolean isDrillThrough()
        Indicate whether statement is a drill through statement of EXECUTE method.
      • getUsername

        java.lang.String getUsername()
        The username to use to open the underlying olap4j connection. Can be null.
      • getPassword

        java.lang.String getPassword()
        The password to use to open the underlying olap4j connection. Can be null.
      • getSessionId

        java.lang.String getSessionId()
        Returns the id of the session this request belongs to.

        Not necessarily the same as the HTTP session: the SOAP request contains its own session information.

        The session id is used to retrieve existing olap connections. And username / password only need to be passed on the first request in a session.

        Returns:
        Id of the session