com.essbase.api.dataquery

Interface IEssOpMdxQuery

All Superinterfaces:

IEssBaseObject, IEssOperation

public interface IEssOpMdxQuery
extends IEssOperation

The IEssOpMdxQuery interface.

Version:

1.0, 04/09/2004

Author:

Abhijeet Katariya

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IEssOpMdxQuery.EEssMemberIdentifierType The EEssMemberIdentifierType class is an enumeration of member identifier types.

Nested classes/interfaces inherited from interface com.essbase.api.dataquery.IEssOperation

IEssOperation.EEssOperationType

Method Summary

Modifier and Type	Method and Description
IEssOpMdxQuery.EEssMemberIdentifierType	getMemberIdentifierType() Gets the MDX Member Identifier Type in query.
java.lang.String	getQuerySpec() Gets the MDX query specification.
boolean	isDataless() Checks if MDX query is dataless query.
boolean	isHideRestrictedData() Checks if restricted data is to be hidden.
boolean	isNeedCellAttributes() Checks if MDX query will return cell attributes for data cells.
boolean	isNeedFormatString() Returns true if the Format String corresponding to Date & Double type of cells are to be fetched(if any) while querying through MDX.
boolean	isNeedFormattedCellValue() Indicates if Formatted Cell Values are to retrieved while querying.
boolean	isNeedFormattedMissingCells() Deprecated. Replaced by isNeedProcessMissingCells()
boolean	isNeedMeaninglessCells() Indicates if Meaningless cells are to be returned.
boolean	isNeedProcessMissingCells() Indicates if color coding/Text Formatting is to be applied for #MISSING value based cells.
boolean	isNeedSmartlistName() Returns true if the Smartlist name corresponding to a smartlist type of cell is to be fetched while querying through MDX.
boolean	isURLDrillThrough() Indicates if URL drill through (color coding) information will be fetched.
boolean	isXMLAMode() To idenfify whether MDX Query Execution is set in XMLA Mode or not.
void	setDataless(boolean dataLess) Sets if MDX query is dataless query.
void	setHideRestrictedData(boolean hideData) If set, all the cells to which user does not have access to, will be returned as Missing cells.
void	setMemberIdentifierType(IEssOpMdxQuery.EEssMemberIdentifierType idtype) Sets the Member Identifier Type in query.
void	setNeedCellAttributes(boolean needCellAttributes) Sets if MDX query will return cell attributes for data cells.
void	setNeedFormatString(boolean needFmtString) To enable or disable retrieving of formatted cell text.
void	setNeedFormattedCellValue(boolean needFmtdCellVal) To enable or disable retrieving of formatted cell text.
void	setNeedFormattedMissingCells(boolean fmtMissingCells) Deprecated. Replaced by setNeedProcessMissingCells(boolean)
void	setNeedMeaninglessCells(boolean getMeaninglessCells) To enable or disable fetching of MEANINGLESS cells.
void	setNeedProcessMissingCells(boolean procMissingCells) To enable or disable color-coding/formatting of missing value cells.
void	setNeedSmartlistName(boolean needAssocdSmartlistName) To enable or disable retrieving of smartlist name associated with a smartlist type of cell.
void	setQuery(boolean dataLess, boolean hideRestrictedData, java.lang.String querySpec, boolean needCellStatus, IEssOpMdxQuery.EEssMemberIdentifierType idtype) Sets the MDX query specification and options relating to the MDX operation.
void	setQuery(boolean dataLess, java.lang.String querySpec, boolean needCellStatus, IEssOpMdxQuery.EEssMemberIdentifierType idtype) Sets the MDX query specification and options relating to the MDX operation.
void	setQuerySpec(java.lang.String querySpec) Sets the MDX query specification.
void	setURLDrillThrough(boolean needURLDrillThrough) To enable or disable retrieving of URL drill through (color coding) information.
void	setXMLAMode(boolean xmlaMode) This is to enable or disable XMLA-Mode for MDX Query operations.

Methods inherited from interface com.essbase.api.dataquery.IEssOperation

getOperationType

Method Detail

getMemberIdentifierType

IEssOpMdxQuery.EEssMemberIdentifierType getMemberIdentifierType()
                                                         throws com.essbase.api.base.EssException

Gets the MDX Member Identifier Type in query.

Returns:

The member identifier type that will be returned in query results.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setMemberIdentifierType

void setMemberIdentifierType(IEssOpMdxQuery.EEssMemberIdentifierType idtype)
                      throws com.essbase.api.base.EssException

Sets the Member Identifier Type in query. If the type is EEssMemberIdentifierType.NAME then the member (or dimension) identifiers returned in the query results are their actual names. If the type is EEssMemberIdentifierType.ALIAS then those identifiers will be alias names of the corresponding member (or dimension).

Parameters:

idtype - The member identifier type that will be returned in query results.

Throws:

com.essbase.api.base.EssException - if an error occurs.

isHideRestrictedData

boolean isHideRestrictedData()
                      throws com.essbase.api.base.EssException

Checks if restricted data is to be hidden.

Returns:

true if restricted data is hidden

Throws:

com.essbase.api.base.EssException - if an error occurs

setHideRestrictedData

void setHideRestrictedData(boolean hideData)
                    throws com.essbase.api.base.EssException

If set, all the cells to which user does not have access to, will be returned as Missing cells.

Parameters:

hideData - true to hide data

Throws:

com.essbase.api.base.EssException - if an error occurs

isDataless

boolean isDataless()
            throws com.essbase.api.base.EssException

Checks if MDX query is dataless query.

Returns:

true if dataless; false otherwise.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setDataless

void setDataless(boolean dataLess)
          throws com.essbase.api.base.EssException

Sets if MDX query is dataless query. If true, the query will not return any data values and all cell value and cell attribute functions in IEssMdDataSet interface will throw exception if invoked.

Parameters:

dataLess - true if dataless; false otherwise.

Throws:

com.essbase.api.base.EssException - if an error occurs.

isNeedCellAttributes

boolean isNeedCellAttributes()
                      throws com.essbase.api.base.EssException

Checks if MDX query will return cell attributes for data cells.

Returns:

true if cell attributes will be returned; false otherwise.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setNeedCellAttributes

void setNeedCellAttributes(boolean needCellAttributes)
                    throws com.essbase.api.base.EssException

Sets if MDX query will return cell attributes for data cells. If dataless option is true then this option is ignored and no cell attributes are returned. If dataless option is false, and this option is set to true, the returned cells in the query results will have attributes which can be queried using IEssMdDataSet interface functions isDynamicCalcCell(), isReadOnlyCell(), isCalcedMemberCell() and isLinkedCell().

Parameters:

needCellAttributes - true if cell attributes will be returned; false otherwise.

Throws:

com.essbase.api.base.EssException - if an error occurs.

isXMLAMode

boolean isXMLAMode()
            throws com.essbase.api.base.EssException

To idenfify whether MDX Query Execution is set in XMLA Mode or not.

Returns:

whether the mode is XMLA or not.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setXMLAMode

void setXMLAMode(boolean xmlaMode)
          throws com.essbase.api.base.EssException

This is to enable or disable XMLA-Mode for MDX Query operations. If XMLA Mode is set, and if you are connecting to Essbase version, 9.3 and above: Then, the Level and Generation MDX functions used in the MDX Query produce results according the XMLA Industry Standard definition for Level (and Generations). In addition, if the query uses DIMENSION PROPERTIES, then, in the XMLA Mode, Member Caption, Level number, Children count, Ancestor names, and Shared Flag properties are available by default. pre 9.3: If the MDX query uses DIMENSION PROPERTIES, then, in the XMLA Mode, "Level number" property is retrieved by default.

Parameters:

xmlaMode - true to run MDX query in XMLA Mode; false otherwise.

Throws:

com.essbase.api.base.EssException - if an error occurs.

isNeedFormattedCellValue

boolean isNeedFormattedCellValue()
                          throws com.essbase.api.base.EssException

Indicates if Formatted Cell Values are to retrieved while querying.

Returns:

true if Formatted text is to retrieved.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

setNeedFormattedCellValue

void setNeedFormattedCellValue(boolean needFmtdCellVal)
                        throws com.essbase.api.base.EssException

To enable or disable retrieving of formatted cell text.

By default, this option is not set for querying.

This option is applicable only in Essbase versions 11.1.1.0.0 and above.

Parameters:

needFmtdCellVal - true to fetch formatted text.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

isNeedSmartlistName

boolean isNeedSmartlistName()
                     throws com.essbase.api.base.EssException

Returns true if the Smartlist name corresponding to a smartlist type of cell is to be fetched while querying through MDX.

Returns:

true if the Smartlist Name has to be fetched.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

setNeedSmartlistName

void setNeedSmartlistName(boolean needAssocdSmartlistName)
                   throws com.essbase.api.base.EssException

To enable or disable retrieving of smartlist name associated with a smartlist type of cell.

By default, this option is not set for querying.

This option is applicable only in Essbase versions 11.1.1.0.0 and above.

Parameters:

needAssocdSmartlistName - true to fetch associated smartlist name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

isNeedFormatString

boolean isNeedFormatString()
                    throws com.essbase.api.base.EssException

Returns true if the Format String corresponding to Date & Double type of cells are to be fetched(if any) while querying through MDX.

Returns:

true if the Format String will be fetched.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

setNeedFormatString

void setNeedFormatString(boolean needFmtString)
                  throws com.essbase.api.base.EssException

To enable or disable retrieving of formatted cell text.

By default, this option is not set for querying.

This option is applicable only in Essbase versions 11.1.1.0.0 and above.

Parameters:

needFmtString - true to fetch format strings.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

isNeedFormattedMissingCells

boolean isNeedFormattedMissingCells()
                             throws com.essbase.api.base.EssException

Deprecated. Replaced by isNeedProcessMissingCells()

Indicates if Text Formatting is to be applied for #MISSING value based cells. This formatting will be applied only in case of Smartlist, Date or Format String based cells. This means, for normal double type of cells which dont have formatted string, formatting missing values will not be applicable.

Returns:

true if the Missing Cells are to be formatted.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

setNeedFormattedMissingCells

void setNeedFormattedMissingCells(boolean fmtMissingCells)
                           throws com.essbase.api.base.EssException

Deprecated. Replaced by setNeedProcessMissingCells(boolean)

To enable or disable formatting of missing value cells. If enabled, the Smartlist, Date and Format String based cells may return formatted text values for #MISSING values.

By default, this option is not set for querying.

This option is applicable only in Essbase versions 11.1.1.0.0 and above.

Parameters:

fmtMissingCells - true to format missing cells

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

isNeedProcessMissingCells

boolean isNeedProcessMissingCells()
                           throws com.essbase.api.base.EssException

Indicates if color coding/Text Formatting is to be applied for #MISSING value based cells. This color code/formatting will be applied only in case of URL drill through, Smartlist, Date or Format String based cells. This means, for normal double type of cells which dont have formatted string, formatting missing values will not be applicable.

Returns:

true if the Missing Cells are to be color-coded/formatted.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.3.0

setNeedProcessMissingCells

void setNeedProcessMissingCells(boolean procMissingCells)
                         throws com.essbase.api.base.EssException

To enable or disable color-coding/formatting of missing value cells. If enabled, the URL drill through, Smartlist, Date and Format String based cells will return color-coded/formatted values for #MISSING cells.

By default, this option is not set for querying.

This option is applicable only in Essbase versions 11.1.1.3.0 and above.

Parameters:

procMissingCells - true to process missing cells

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.3.0

isNeedMeaninglessCells

boolean isNeedMeaninglessCells()
                        throws com.essbase.api.base.EssException

Indicates if Meaningless cells are to be returned. If disabled, then, results of a query will indicate MISSING value instead of MEANINGLESS.

Returns:

true if need Meaningless is enabled

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

setNeedMeaninglessCells

void setNeedMeaninglessCells(boolean getMeaninglessCells)
                      throws com.essbase.api.base.EssException

To enable or disable fetching of MEANINGLESS cells.

If enabled, a cell may be identified a MEANIGLESS. This would usually happen in the domain of varying attributes, where a particular data cell is not applicable because there in valid association.

If disabled, MEANINGLESS cells will be returned as MISSING cells.

By default, this option is not set for querying.

This option is applicable only in Essbase versions 11.1.1.0.0 and above.

Parameters:

getMeaninglessCells - true to enable fetching meaningless cells

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.0.0

isURLDrillThrough

boolean isURLDrillThrough()
                   throws com.essbase.api.base.EssException

Indicates if URL drill through (color coding) information will be fetched.

By default, this option is not set for querying.

This option is applicable only in Essbase versions 11.1.1.3 and above.

Returns:

true if URL drill through information will be fetched.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.3

setURLDrillThrough

void setURLDrillThrough(boolean needURLDrillThrough)
                 throws com.essbase.api.base.EssException

To enable or disable retrieving of URL drill through (color coding) information.

By default, this option is not set for querying.

This option is applicable only in Essbase versions 11.1.1.3 and above. Essbase does not retrieve color code details for missing cells. If that is desired, additionally enable missing cells using setNeedProcessMissingCells(boolean)

Parameters:

needURLDrillThrough - true to fetch URL drill through information.

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1.3

getQuerySpec

java.lang.String getQuerySpec()
                       throws com.essbase.api.base.EssException

Gets the MDX query specification.

Returns:

The MDX query specification.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setQuerySpec

void setQuerySpec(java.lang.String querySpec)
           throws com.essbase.api.base.EssException

Sets the MDX query specification.

Parameters:

querySpec - The MDX query specification.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setQuery

void setQuery(boolean dataLess,
              java.lang.String querySpec,
              boolean needCellStatus,
              IEssOpMdxQuery.EEssMemberIdentifierType idtype)
       throws com.essbase.api.base.EssException

Sets the MDX query specification and options relating to the MDX operation.

Parameters:

dataLess - true if dataless; false otherwise.

querySpec - The MDX query specification.

needCellStatus - true if cell statuses will be returned; false otherwise.

idtype - The member id type that will be returned in query results.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setQuery

void setQuery(boolean dataLess,
              boolean hideRestrictedData,
              java.lang.String querySpec,
              boolean needCellStatus,
              IEssOpMdxQuery.EEssMemberIdentifierType idtype)
       throws com.essbase.api.base.EssException

Sets the MDX query specification and options relating to the MDX operation.

Parameters:

dataLess - true if dataless; false otherwise.

hideRestrictedData - If true, all the cells to which user does not have access to, will be returned as Missing cells.

querySpec - The MDX query specification.

needCellStatus - true if cell statuses will be returned; false otherwise.

idtype - The member id type that will be returned in query results.

Throws:

com.essbase.api.base.EssException - if an error occurs.