|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssMdDataSet
The IEssMdDataSet interface. It represents the multi-dimensional result of an MDX query operation performed on IEssCubeView interface.
Field Summary | |
---|---|
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 | |
---|---|
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 |
---|
static final int CELLTYPE_DOUBLE
static final int CELLTYPE_SMARTLIST
static final int CELLTYPE_DATE
static final int CELLINFO_MISSING
static final int CELLINFO_NOACCESS
static final int CELLINFO_MEANINGLESS
static final int CELLINFO_OUTOFRANGE
static final int CELLINFO_NOFMTSTR
static final int CELLINFO_GLDRILLTHROUGH
static final int CELLINFO_DRILLTHROUGH
Method Detail |
---|
IEssMdAxis[] getAllAxes() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getCellCount() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.double getCellValue(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell to get the value of.com.essbase.api.base.EssException
- if an error occurs.int getCellType(int cellOrdinal) throws com.essbase.api.base.EssException
IEssMdDataSet.CELLTYPE_DOUBLE IEssMdDataSet.CELLTYPE_SMARTLIST IEssMdDataSet.CELLTYPE_DATE
cellOrdinal
- ordinal to identify the cell for which you need type.com.essbase.api.base.EssException
- if an error occurs.int getCellInfo(int cellOrdinal) throws com.essbase.api.base.EssException
&
operator over these IEssMdDataSet.CELLINFO_*
constants.
Sample Usage: if ((getCellInfo(1) & IEssMdDataSet.CELLINFO_MEANINGLESS) > 0) { System.out.println("This cell is Meaningless"); }
cellOrdinal
- ordinal to identify the cell for which you need info.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getFormattedValue(int cellOrdinal) throws com.essbase.api.base.EssException
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.
cellOrdinal
- Ordinal of the cell to check for missing value.null
.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getFormatString(int cellOrdinal) throws com.essbase.api.base.EssException
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.
cellOrdinal
- Ordinal of the cell to get Format Stringnull
.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getSmartListName(int cellOrdinal) throws com.essbase.api.base.EssException
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.
cellOrdinal
- Ordinal of the cell to get Smartlist name.null
com.essbase.api.base.EssException
- if an error occurs.boolean isMissingCell(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell to check for missing value.com.essbase.api.base.EssException
- if an error occurs.boolean isNoAccessCell(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell to check for NoAccess.com.essbase.api.base.EssException
- if an error occurs.boolean isDynamicCalcCell(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell to check for DynCalc.com.essbase.api.base.EssException
- if an error occurs.boolean isReadOnlyCell(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell to check for ReadOnly.com.essbase.api.base.EssException
- if an error occurs.boolean isCalcedMemberCell(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell to check for CalcedMember.com.essbase.api.base.EssException
- if an error occurs.boolean isLinkedCell(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell to check for linked objects.com.essbase.api.base.EssException
- if an error occurs.boolean isMeaninglessCell(int cellOrdinal) throws com.essbase.api.base.EssException
IEssOpMdxQuery.setNeedMeaninglessCells(boolean)
method.cellOrdinal
- Ordinal of the cell to check for linked objects.com.essbase.api.base.EssException
- if an error occurs.IEssOpMdxQuery.setNeedMeaninglessCells(boolean)
boolean isDrillThrough(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell to check for drill through.com.essbase.api.base.EssException
- If an error occurs.IEssIterator getLinkedObjects(int cellOrdinal) throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isURLDrillThrough(int cellOrdinal) throws com.essbase.api.base.EssException
IEssOpMdxQuery.setNeedMeaninglessCells(boolean)
.cellOrdinal
- Ordinal of the cell to check for URL drill through.com.essbase.api.base.EssException
- if an error occurs.java.lang.String[] getURLDrillThrough(int cellOrdinal) throws com.essbase.api.base.EssException
cellOrdinal
- Ordinal of the cell whose URL drill through is to be retrieved.com.essbase.api.base.EssException
- if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |