Package com.appliedolap.essbase

Class EssMdxOptions

java.lang.Object
com.appliedolap.essbase.EssMdxOptions
public final class EssMdxOptions extends Object
How the server should present an MDX query's result: whether to include the data, and how to name the members.

Every option starts unset, and an unset option isn't sent, so the server applies its own default - which is what a query got before this class existed. defaults() is therefore exactly the plain query.

Only dataless and the member naming options have been checked against a server (26.1); the others pass the server's preference of the same name through as they are. The member naming options are the useful ones for reporting. Against Sample.Basic, memberIdentifierType(ALIAS) turns the row member 100-10 into Cola, and adding aliasTableName("Long Names") turns the column member Jan into January. Both the axes and the point of view are renamed; the dimension names in EssMdxGrid are not.

Since:
2.1.0

  • Constructor Details

    • EssMdxOptions

      public EssMdxOptions()

  • Method Details

    • defaults

      public static EssMdxOptions defaults()
      No options set: the server's defaults, as for a plain query.

    • dataless

      public EssMdxOptions dataless(boolean dataless)
      Whether to leave the data out and return only the members. The grid keeps its shape, with every data cell empty, which makes this a cheap way to resolve a member set.

    • hideRestrictedData

      public EssMdxOptions hideRestrictedData(boolean hideRestrictedData)
      Sets the server's hideRestrictedData preference.

    • cellAttributes

      public EssMdxOptions cellAttributes(boolean cellAttributes)
      Sets the server's cellAttributes preference.

    • formatString

      public EssMdxOptions formatString(boolean formatString)
      Sets the server's formatString preference.

    • formatValues

      public EssMdxOptions formatValues(boolean formatValues)
      Sets the server's formatValues preference.

    • meaninglessCells

      public EssMdxOptions meaninglessCells(boolean meaninglessCells)
      Sets the server's meaninglessCells preference.

    • textList

      public EssMdxOptions textList(boolean textList)
      Sets the server's textList preference.

    • urlDrillThrough

      public EssMdxOptions urlDrillThrough(boolean urlDrillThrough)
      Sets the server's urlDrillThrough preference.

    • memberIdentifierType

      public EssMdxOptions memberIdentifierType(EssCube.MdxIdentifierType memberIdentifierType)
      How to name the members in the result: by name (the server's default), by alias, or by unique name. Unique names only differ from names in an outline that allows duplicate member names.

    • aliasTableName

      public EssMdxOptions aliasTableName(String aliasTableName)
      Which alias table to take aliases from, when members are named by alias. Unset, the server uses the default table.

    • timeout

      public EssMdxOptions timeout(Duration timeout)
      How long to wait for the server's answer before giving up, which fails the query with an EssApiException caused by a HttpTimeoutException. This isn't sent to the server, which goes on with the query regardless. Unset, the query waits as long as the client's other requests do.

    • getDataless

      public Boolean getDataless()
      Returns:
      whether to leave the data out, or null to leave it to the server

    • getHideRestrictedData

      public Boolean getHideRestrictedData()
      Returns:
      the hideRestrictedData preference, or null to leave it to the server

    • getCellAttributes

      public Boolean getCellAttributes()
      Returns:
      the cellAttributes preference, or null to leave it to the server

    • getFormatString

      public Boolean getFormatString()
      Returns:
      the formatString preference, or null to leave it to the server

    • getFormatValues

      public Boolean getFormatValues()
      Returns:
      the formatValues preference, or null to leave it to the server

    • getMeaninglessCells

      public Boolean getMeaninglessCells()
      Returns:
      the meaninglessCells preference, or null to leave it to the server

    • getTextList

      public Boolean getTextList()
      Returns:
      the textList preference, or null to leave it to the server

    • getUrlDrillThrough

      public Boolean getUrlDrillThrough()
      Returns:
      the urlDrillThrough preference, or null to leave it to the server

    • getMemberIdentifierType

      public EssCube.MdxIdentifierType getMemberIdentifierType()
      Returns:
      how to name the members, or null to leave it to the server

    • getAliasTableName

      public String getAliasTableName()
      Returns:
      the alias table to take aliases from, or null for the default table

    • getTimeout

      public Duration getTimeout()
      Returns:
      how long to wait for the answer, or null to wait as long as other requests do

    • hasPreferences

      public boolean hasPreferences()
      Returns:
      whether any of the server's preferences is set; if none is, the query is sent without preferences, as a plain query is

    • isEmpty

      public boolean isEmpty()
      Returns:
      whether nothing is set at all: no preference and no timeout