IEssMdDataSet (Oracle Essbase Java API Reference)

All Superinterfaces:

IEssBaseObject
```
public interface IEssMdDataSet
extends IEssBaseObject
```
The IEssMdDataSet interface. It represents the multi-dimensional result of an MDX query operation performed on IEssCubeView interface.

Version:

1.0, 04/09/2004

Author:

Abhijeet Katariya

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CELLINFO_DRILLTHROUGH` Bitmask for identifying cell with drill through report
`static int`	`CELLINFO_GLDRILLTHROUGH` Bitmask for identifying cell with GL URL Drill Through
`static int`	`CELLINFO_MEANINGLESS` Bitmask for identifying MEANINGLESS cell
`static int`	`CELLINFO_MISSING` Bitmask for identifying MISSING cell
`static int`	`CELLINFO_NOACCESS` Bitmask for identifying if a cell is NO-ACCESS
`static int`	`CELLINFO_NOFMTSTR` Bitmask for identifying cell with no format string
`static int`	`CELLINFO_OUTOFRANGE` Bitmask for identifying OUTOFRANGE cell
`static int`	`CELLTYPE_DATE` Cell Type for identifying Date Type of data
`static int`	`CELLTYPE_DOUBLE` Cell Type for identifying Double Type of data
`static int`	`CELLTYPE_SMARTLIST` Cell Type for identifying Smartlist Type of data

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IEssMdAxis[]`	`getAllAxes()` Get all the axes in the data set.
`int`	`getCellCount()` Get the count of cells in the data set.
`int`	`getCellInfo(int cellOrdinal)` Returns the bitmasked cell information and this information can be identified by using `&` operator over these `IEssMdDataSet.CELLINFO_*` constants.
`int`	`getCellType(int cellOrdinal)` Returns the Type of cell which could one the below.
`double`	`getCellValue(int cellOrdinal)` Gets the value of a cell at given ordinal.
`java.lang.String`	`getFormatString(int cellOrdinal)` Gets the format string corresponding to the cell asked for.
`java.lang.String`	`getFormattedValue(int cellOrdinal)` Returns formatted text value.
`IEssIterator`	`getLinkedObjects(int cellOrdinal)` Gets the linked objects in the cell at the given ordinal.
`java.lang.String`	`getSmartListName(int cellOrdinal)` Gets the smartlist name corresponding, if the cell specified by `cellOrdinal` is of Smartlist type of cell.
`java.lang.String[]`	`getURLDrillThrough(int cellOrdinal)` Gets the drill through reports associated with a data cell as an array of Strings containing XML for the cells member combination.
`boolean`	`isCalcedMemberCell(int cellOrdinal)` Checks if the cell at a given ordinal is a CalcedMember cell.
`boolean`	`isDrillThrough(int cellOrdinal)` Checks if the cell at a given ordinal has drill through reports associated with it.
`boolean`	`isDynamicCalcCell(int cellOrdinal)` Checks if the cell at a given ordinal is a Dynamic Calc cell.
`boolean`	`isLinkedCell(int cellOrdinal)` Checks if the cell at a given ordinal has linked objects.
`boolean`	`isMeaninglessCell(int cellOrdinal)` Checks if the cell at a given ordinal is Meaningless Cell.
`boolean`	`isMissingCell(int cellOrdinal)` Checks if the cell at a given ordinal is a missing value cell.
`boolean`	`isNoAccessCell(int cellOrdinal)` Checks if the cell at a given ordinal is a NoAccess cell.
`boolean`	`isReadOnlyCell(int cellOrdinal)` Checks if the cell at a given ordinal is a ReadOnly cell.
`boolean`	`isURLDrillThrough(int cellOrdinal)` Checks if the cell at a given ordinal has URL drill through reports associated with it.

- Field Detail
  - CELLTYPE_DOUBLE
```
static final int CELLTYPE_DOUBLE
```
    Cell Type for identifying Double Type of data
    
    See Also:
    
    Constant Field Values
  - CELLTYPE_SMARTLIST
```
static final int CELLTYPE_SMARTLIST
```
    Cell Type for identifying Smartlist Type of data
    
    See Also:
    
    Constant Field Values
  - CELLTYPE_DATE
```
static final int CELLTYPE_DATE
```
    Cell Type for identifying Date Type of data
    
    See Also:
    
    Constant Field Values
  - CELLINFO_MISSING
```
static final int CELLINFO_MISSING
```
    Bitmask for identifying MISSING cell
    
    See Also:
    
    Constant Field Values
  - CELLINFO_NOACCESS
```
static final int CELLINFO_NOACCESS
```
    Bitmask for identifying if a cell is NO-ACCESS
    
    See Also:
    
    Constant Field Values
  - CELLINFO_MEANINGLESS
```
static final int CELLINFO_MEANINGLESS
```
    Bitmask for identifying MEANINGLESS cell
    
    See Also:
    
    Constant Field Values
  - CELLINFO_OUTOFRANGE
```
static final int CELLINFO_OUTOFRANGE
```
    Bitmask for identifying OUTOFRANGE cell
    
    See Also:
    
    Constant Field Values
  - CELLINFO_NOFMTSTR
```
static final int CELLINFO_NOFMTSTR
```
    Bitmask for identifying cell with no format string
    
    See Also:
    
    Constant Field Values
  - CELLINFO_GLDRILLTHROUGH
```
static final int CELLINFO_GLDRILLTHROUGH
```
    Bitmask for identifying cell with GL URL Drill Through
    
    See Also:
    
    Constant Field Values
  - CELLINFO_DRILLTHROUGH
```
static final int CELLINFO_DRILLTHROUGH
```
    Bitmask for identifying cell with drill through report
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAllAxes
```
IEssMdAxis[] getAllAxes()
                 throws com.essbase.api.base.EssException
```
    Get all the axes in the data set.
    
    Returns:
    
    An array of all the axes including slicer axis if present. If slicer axis is present in the result set, it will be the first axis in this array.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getCellCount
```
int getCellCount()
          throws com.essbase.api.base.EssException
```
    Get the count of cells in the data set. This method will return 0 if you set the dataless option in IEssOpMdxQuery as true before performing the MDX query operation.
    
    Returns:
    
    Total number of cells in the data set.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getCellValue
```
double getCellValue(int cellOrdinal)
             throws com.essbase.api.base.EssException
```
    Gets the value of a cell at given ordinal. This method will throw an exception if you set the dataless option in IEssOpMdxQuery as true before performing the MDX query operation.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to get the value of.
    
    Returns:
    
    The value of a cell at given cell ordinal.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - getCellType
```
int getCellType(int cellOrdinal)
         throws com.essbase.api.base.EssException
```
    Returns the Type of cell which could one the below.
    IEssMdDataSet.CELLTYPE_DOUBLE IEssMdDataSet.CELLTYPE_SMARTLIST IEssMdDataSet.CELLTYPE_DATE
    
    Parameters:
    
    cellOrdinal - ordinal to identify the cell for which you need type.
    
    Returns:
    
    Cell Type
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
    
    Since:
    
    11.1.1.0.0
  - getCellInfo
```
int getCellInfo(int cellOrdinal)
         throws com.essbase.api.base.EssException
```
    Returns the bitmasked cell information and this information can be identified by using & operator over these IEssMdDataSet.CELLINFO_* constants.
    Sample Usage: if ((getCellInfo(1) & IEssMdDataSet.CELLINFO_MEANINGLESS) > 0) { System.out.println("This cell is Meaningless"); }
    
    Parameters:
    
    cellOrdinal - ordinal to identify the cell for which you need info.
    
    Returns:
    
    Bitmask holding the cell information.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
    
    Since:
    
    11.1.1.0.0
  - getFormattedValue
```
java.lang.String getFormattedValue(int cellOrdinal)
                            throws com.essbase.api.base.EssException
```
    Returns formatted text value.
    This value will be fetched & returned only if you have set an option to fetch formatted cell values while querying. In other words, make sure to do this: IEssOpMdxQuery.setNeedFormattedCellValue(true) to fetch this.
    In case of Smartlist type of cell, it returns the text based cell value.
    In case of Date type of cell, it returns the formatted date value.
    If the cell has a format string defined, then, it returns the formatted text value for this cell.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for missing value.
    
    Returns:
    
    Formatted text value, if any, otherwise null.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
    
    Since:
    
    11.1.1.0.0
  - getFormatString
```
java.lang.String getFormatString(int cellOrdinal)
                          throws com.essbase.api.base.EssException
```
    Gets the format string corresponding to the cell asked for. This is the string that Essbase uses internally decode and give you the formatted text value.
    This method is provided to clients as an optional so that, if required, they can format the numeric cell value using this format string.
    This value will be fetched & returned only if you have set an option to fetch format strings while querying. In other words, make sure to do this: IEssOpMdxQuery.setNeedFormatString(true) to fetch this.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to get Format String
    
    Returns:
    
    format string if any, otherwise null.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
    
    Since:
    
    11.1.1.0.0
  - getSmartListName
```
java.lang.String getSmartListName(int cellOrdinal)
                           throws com.essbase.api.base.EssException
```
    Gets the smartlist name corresponding, if the cell specified by cellOrdinal is of Smartlist type of cell.
    This value will be fetched & returned only if you have set an option to fetch smartlist name while querying. In other words, make sure to do this: IEssOpMdxQuery.setNeedSmartlistName(true) to fetch this.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to get Smartlist name.
    
    Returns:
    
    smartlist name, if applicable. Otherwise, null
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
    
    Since:
    
    11.1.1.0.0
  - isMissingCell
```
boolean isMissingCell(int cellOrdinal)
               throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal is a missing value cell. This method will throw an exception if you set the dataless option in IEssOpMdxQuery as true before performing the MDX query operation.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for missing value.
    
    Returns:
    
    True if the cell is missing, false otherwise.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isNoAccessCell
```
boolean isNoAccessCell(int cellOrdinal)
                throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal is a NoAccess cell. This method will throw an exception if you set the dataless option in IEssOpMdxQuery as true before performing the MDX query operation.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for NoAccess.
    
    Returns:
    
    True if the cell is NoAccess, false otherwise.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isDynamicCalcCell
```
boolean isDynamicCalcCell(int cellOrdinal)
                   throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal is a Dynamic Calc cell. This method will throw an exception if either dataless option is true or needCellAttributes option is false in IEssOpMdxQuery before performing the MDX query operation.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for DynCalc.
    
    Returns:
    
    True if the cell is Dynamic Calc, false otherwise.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isReadOnlyCell
```
boolean isReadOnlyCell(int cellOrdinal)
                throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal is a ReadOnly cell. This method will throw an exception if either dataless option is true or needCellAttributes option is false in IEssOpMdxQuery before performing the MDX query operation.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for ReadOnly.
    
    Returns:
    
    True if the cell is ReadOnly, false otherwise.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isCalcedMemberCell
```
boolean isCalcedMemberCell(int cellOrdinal)
                    throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal is a CalcedMember cell. This method will throw an exception if either dataless option is true or needCellAttributes option is false in IEssOpMdxQuery before performing the MDX query operation.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for CalcedMember.
    
    Returns:
    
    True if the cell is CalcedMember, false otherwise.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isLinkedCell
```
boolean isLinkedCell(int cellOrdinal)
              throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal has linked objects. This method will throw an exception if either dataless option is true or needCellAttributes option is false in IEssOpMdxQuery before performing the MDX query operation.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for linked objects.
    
    Returns:
    
    True if the cell has linked objects, false otherwise.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isMeaninglessCell
```
boolean isMeaninglessCell(int cellOrdinal)
                   throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal is Meaningless Cell. Essbase would return meaningless cells only if while querying, you enabled to option to fetch meaningless cells using the IEssOpMdxQuery.setNeedMeaninglessCells(boolean) method.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for linked objects.
    
    Returns:
    
    True if the cell is a Meaningless Cell, false otherwise.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
    
    See Also:
    
    IEssOpMdxQuery.setNeedMeaninglessCells(boolean)
  - isDrillThrough
```
boolean isDrillThrough(int cellOrdinal)
                throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal has drill through reports associated with it.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for drill through.
    
    Returns:
    
    True if the cell has drill through reports associated with it, false otherwise.
    
    Throws:
    
    com.essbase.api.base.EssException - If an error occurs.
  - getLinkedObjects
```
IEssIterator getLinkedObjects(int cellOrdinal)
                       throws com.essbase.api.base.EssException
```
    Gets the linked objects in the cell at the given ordinal. Use this to get drill through associated with the cell.
    
    Parameters:
    
    cellOrdinal - the cell ordinal
    
    Returns:
    
    The linked objects (each of type IEssLinkedObject).
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
  - isURLDrillThrough
```
boolean isURLDrillThrough(int cellOrdinal)
                   throws com.essbase.api.base.EssException
```
    Checks if the cell at a given ordinal has URL drill through reports associated with it. Essbase does not retrieve URL Drill through (color code) details for missing cells. If that is desired, enable it using IEssOpMdxQuery.setNeedMeaninglessCells(boolean).
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell to check for URL drill through.
    
    Returns:
    
    true if URL drill report is associated, else false.
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
    
    Since:
    
    11.1.1.3
  - getURLDrillThrough
```
java.lang.String[] getURLDrillThrough(int cellOrdinal)
                               throws com.essbase.api.base.EssException
```
    Gets the drill through reports associated with a data cell as an array of Strings containing XML for the cells member combination.
    
    Parameters:
    
    cellOrdinal - Ordinal of the cell whose URL drill through is to be retrieved.
    
    Returns:
    
    the String array containing the URL XMLs
    
    Throws:
    
    com.essbase.api.base.EssException - if an error occurs.
    
    Since:
    
    11.1.1.3

Interface IEssMdDataSet

Field Summary

Method Summary

Field Detail

CELLTYPE_DOUBLE

CELLTYPE_SMARTLIST

CELLTYPE_DATE

CELLINFO_MISSING

CELLINFO_NOACCESS

CELLINFO_MEANINGLESS

CELLINFO_OUTOFRANGE

CELLINFO_NOFMTSTR

CELLINFO_GLDRILLTHROUGH

CELLINFO_DRILLTHROUGH

Method Detail

getAllAxes

getCellCount

getCellValue

getCellType

getCellInfo

getFormattedValue

getFormatString

getSmartListName

isMissingCell

isNoAccessCell

isDynamicCalcCell

isReadOnlyCell

isCalcedMemberCell

isLinkedCell

isMeaninglessCell

isDrillThrough

getLinkedObjects

isURLDrillThrough

getURLDrillThrough