Skip navigation links


com.essbase.api.dataquery
Interface IEssGridView

All Superinterfaces:
IEssBaseObject

public interface IEssGridView
extends IEssBaseObject

The IEssGridView is a grid view of the cube view.

Version:
1.0, 04/04/2002
Author:
Srini Ranga

Field Summary
static int CELL_CONTENT_TYPE_BLANK
           
static int CELL_CONTENT_TYPE_BLANKwFORMULA
           
static int CELL_CONTENT_TYPE_DATE
           
static int CELL_CONTENT_TYPE_DOUBLE
           
static int CELL_CONTENT_TYPE_DOUBLEwFORMULA
           
static int CELL_CONTENT_TYPE_ERROR
           
static int CELL_CONTENT_TYPE_FORMULA
           
static int CELL_CONTENT_TYPE_FORMULAEX
           
static int CELL_CONTENT_TYPE_HYBRID_MEMBER
           
static int CELL_CONTENT_TYPE_MEANINGLESS
           
static int CELL_CONTENT_TYPE_MEMBER
           
static int CELL_CONTENT_TYPE_MEMBEREX
           
static int CELL_CONTENT_TYPE_MEMBERwKEY
           
static int CELL_CONTENT_TYPE_MISSING
           
static int CELL_CONTENT_TYPE_MISSINGwFORMULA
           
static int CELL_CONTENT_TYPE_NOACCESS
           
static int CELL_CONTENT_TYPE_NOACCESSwFORMULA
           
static int CELL_CONTENT_TYPE_SMARTLIST
           
static int CELL_CONTENT_TYPE_STRING
           
static int CELL_CONTENT_TYPE_STRINGEX
           
static int CELL_CONTENT_TYPE_STRINGEXwFORMULA
           
static int CELL_CONTENT_TYPE_STRINGwFORMULA
           
static int CELL_CONTENT_TYPE_ZERO
           
static int CELL_CONTENT_TYPE_ZEROwFORMULA
           
static int CELL_TYPE_DATA
          Cell type: Data.
static int CELL_TYPE_MEMBER
          Cell type: Member.
static int CELL_TYPE_TEXT
          Cell type: Text (label/comment etc).
static int DATA_CELL_ATTRIB_BPM_DT
           
static int DATA_CELL_ATTRIB_BPM_LINKED_URL
           
static int DATA_CELL_ATTRIB_GL_DT
           
static int DATA_CELL_ATTRIB_HIS_DT
           
static int DATA_CELL_ATTRIB_LINKED_CELL_NOTE
           
static int DATA_CELL_ATTRIB_LINKED_OBJECT
           
static int DATA_CELL_ATTRIB_LINKED_PARTITION
           
static int DATA_CELL_ATTRIB_LINKED_URL
           
static int DATA_CELL_ATTRIB_LINKED_WIN_APP
           
static int DATA_CELL_ATTRIB_MISSINGCELL
           
static int DATA_CELL_ATTRIB_OUTOFRANGE
           
static int DATA_CELL_ATTRIB_READ_ONLY
           
static int DATA_CELL_ATTRIB_READ_WRITE
           
static int MEMBER_CELL_ATTRIB_ATTRIBUTE
           
static int MEMBER_CELL_ATTRIB_BPM_DT
           
static int MEMBER_CELL_ATTRIB_BPM_LINKED_URL
           
static int MEMBER_CELL_ATTRIB_DIMNUMBITS
           
static int MEMBER_CELL_ATTRIB_DIMTOP
           
static int MEMBER_CELL_ATTRIB_DYNCALC
           
static int MEMBER_CELL_ATTRIB_EXPSHARE
           
static int MEMBER_CELL_ATTRIB_FORMULA
           
static int MEMBER_CELL_ATTRIB_IMPSHARE
           
static int MEMBER_CELL_ATTRIB_LABELONLY
           
static int MEMBER_CELL_ATTRIB_NEVERSHARE
           
static int MEMBER_CELL_ATTRIB_NONUNIQUE
           
static int MEMBER_CELL_ATTRIB_STOREDATA
           
static int MEMBER_CELL_ATTRIB_ZOOMINABLE
           
static java.lang.String MEMBER_KEY_SEPARATOR
          Deprecated.  

 

Method Summary
 IEssGridRange createIEssGridRange()
          Creates an object for the interface IEssGridRange.
 int[][] getAllCellAttributes()
          Gets the attributes for all the cells in the grid view.
 byte[][] getAllCellContentTypes()
          Gets the types of the cell contents in the grid view.
 java.lang.String[][] getAllStringValues()
          Gets the string values for all the cell in the grid view.
 IEssCell getCell(int row, int column)
          Gets the cell at the specified row, column intersection.
 int getCellContentType(int row, int column)
          Gets the type of the cell content at the specifed row, column intersection.
 IEssCell.EEssCellType getCellType(int row, int column)
          Gets the type of the cell at the specifed row, column intersection.
 int getCountColumns()
          Gets the count of columns in the grid.
 int getCountRows()
          Gets the count of rows in the grid.
 int getDataCellAttributes(int row, int column)
          Gets the attributes of the data cell at the specified row, column intersection.
 double getDoubleValue(int row, int column)
          Gets the double value of the cell at the specified row, column intersection.
 java.lang.String getFormattedValue(int row, int column)
          Gets the formatted value for the cell specified by the row column intersection.
 IEssIterator getLinkedObjects(IEssGridRange[] ranges)
          Gets linked objects for a range of cells.
 int getMemberCellAttributes(int row, int column)
          Gets the attributes of the member cell at the specified row, column intersection.
 java.lang.String getSmartListName(int row, int column)
          Gets the Smartlist name for the cell specified by the row column intersection.
 java.lang.String getStringValue(int row, int column)
          Gets the string value of the cell at the specified row, column intersection.
 java.lang.String[] getUnknownMemberNames()
          Gets the unknown members in the grid from the last operation.
 IEssValueAny getValue(int row, int column)
          Gets the cell value at the specified row, column intersection.
 java.lang.String[] getValueAndKey(int row, int column)
          Gets the cell value at the specified row, column intersection.
 void setCellContentType(int row, int column, int type)
          Sets the type of the cell content at the specifed row, column intersection.
 void setSize(int countRows, int countColumns)
          Deletes the existing grid and creates a new empty grid with the specified number of rows and columns.
 void setValue(int row, int column, double value)
          Sets the cell value at the specified row, column intersection intersection.
 void setValue(int row, int column, IEssValueAny value)
          Sets the cell value at the specified row, column intersection.
 void setValue(int row, int column, java.lang.String value)
          Sets the cell value at the specified row, column intersection.
 void setValue(int row, int column, java.lang.String value, java.lang.String key)
          Sets the cell value at the specified row, column intersection.

 

Field Detail

CELL_TYPE_MEMBER

static final int CELL_TYPE_MEMBER
Cell type: Member.
See Also:
Constant Field Values

CELL_TYPE_DATA

static final int CELL_TYPE_DATA
Cell type: Data.
See Also:
Constant Field Values

CELL_TYPE_TEXT

static final int CELL_TYPE_TEXT
Cell type: Text (label/comment etc).
See Also:
Constant Field Values

CELL_CONTENT_TYPE_STRING

static final int CELL_CONTENT_TYPE_STRING
See Also:
Constant Field Values

CELL_CONTENT_TYPE_DOUBLE

static final int CELL_CONTENT_TYPE_DOUBLE
See Also:
Constant Field Values

CELL_CONTENT_TYPE_BLANK

static final int CELL_CONTENT_TYPE_BLANK
See Also:
Constant Field Values

CELL_CONTENT_TYPE_ERROR

static final int CELL_CONTENT_TYPE_ERROR
See Also:
Constant Field Values

CELL_CONTENT_TYPE_MISSING

static final int CELL_CONTENT_TYPE_MISSING
See Also:
Constant Field Values

CELL_CONTENT_TYPE_ZERO

static final int CELL_CONTENT_TYPE_ZERO
See Also:
Constant Field Values

CELL_CONTENT_TYPE_NOACCESS

static final int CELL_CONTENT_TYPE_NOACCESS
See Also:
Constant Field Values

CELL_CONTENT_TYPE_MEMBER

static final int CELL_CONTENT_TYPE_MEMBER
See Also:
Constant Field Values

CELL_CONTENT_TYPE_MEMBEREX

static final int CELL_CONTENT_TYPE_MEMBEREX
See Also:
Constant Field Values

CELL_CONTENT_TYPE_STRINGEX

static final int CELL_CONTENT_TYPE_STRINGEX
See Also:
Constant Field Values

CELL_CONTENT_TYPE_STRINGEXwFORMULA

static final int CELL_CONTENT_TYPE_STRINGEXwFORMULA
See Also:
Constant Field Values

CELL_CONTENT_TYPE_FORMULAEX

static final int CELL_CONTENT_TYPE_FORMULAEX
See Also:
Constant Field Values

CELL_CONTENT_TYPE_HYBRID_MEMBER

static final int CELL_CONTENT_TYPE_HYBRID_MEMBER
See Also:
Constant Field Values

CELL_CONTENT_TYPE_MEMBERwKEY

static final int CELL_CONTENT_TYPE_MEMBERwKEY
See Also:
Constant Field Values

CELL_CONTENT_TYPE_FORMULA

static final int CELL_CONTENT_TYPE_FORMULA
See Also:
Constant Field Values

CELL_CONTENT_TYPE_ZEROwFORMULA

static final int CELL_CONTENT_TYPE_ZEROwFORMULA
See Also:
Constant Field Values

CELL_CONTENT_TYPE_DOUBLEwFORMULA

static final int CELL_CONTENT_TYPE_DOUBLEwFORMULA
See Also:
Constant Field Values

CELL_CONTENT_TYPE_BLANKwFORMULA

static final int CELL_CONTENT_TYPE_BLANKwFORMULA
See Also:
Constant Field Values

CELL_CONTENT_TYPE_STRINGwFORMULA

static final int CELL_CONTENT_TYPE_STRINGwFORMULA
See Also:
Constant Field Values

CELL_CONTENT_TYPE_MISSINGwFORMULA

static final int CELL_CONTENT_TYPE_MISSINGwFORMULA
See Also:
Constant Field Values

CELL_CONTENT_TYPE_NOACCESSwFORMULA

static final int CELL_CONTENT_TYPE_NOACCESSwFORMULA
See Also:
Constant Field Values

CELL_CONTENT_TYPE_SMARTLIST

static final int CELL_CONTENT_TYPE_SMARTLIST
See Also:
Constant Field Values

CELL_CONTENT_TYPE_DATE

static final int CELL_CONTENT_TYPE_DATE
See Also:
Constant Field Values

CELL_CONTENT_TYPE_MEANINGLESS

static final int CELL_CONTENT_TYPE_MEANINGLESS
See Also:
Constant Field Values

DATA_CELL_ATTRIB_READ_ONLY

static final int DATA_CELL_ATTRIB_READ_ONLY
See Also:
Constant Field Values

DATA_CELL_ATTRIB_READ_WRITE

static final int DATA_CELL_ATTRIB_READ_WRITE
See Also:
Constant Field Values

DATA_CELL_ATTRIB_LINKED_OBJECT

static final int DATA_CELL_ATTRIB_LINKED_OBJECT
See Also:
Constant Field Values

DATA_CELL_ATTRIB_LINKED_PARTITION

static final int DATA_CELL_ATTRIB_LINKED_PARTITION
See Also:
Constant Field Values

DATA_CELL_ATTRIB_LINKED_CELL_NOTE

static final int DATA_CELL_ATTRIB_LINKED_CELL_NOTE
See Also:
Constant Field Values

DATA_CELL_ATTRIB_LINKED_WIN_APP

static final int DATA_CELL_ATTRIB_LINKED_WIN_APP
See Also:
Constant Field Values

DATA_CELL_ATTRIB_LINKED_URL

static final int DATA_CELL_ATTRIB_LINKED_URL
See Also:
Constant Field Values

DATA_CELL_ATTRIB_HIS_DT

static final int DATA_CELL_ATTRIB_HIS_DT
See Also:
Constant Field Values

DATA_CELL_ATTRIB_BPM_LINKED_URL

static final int DATA_CELL_ATTRIB_BPM_LINKED_URL
See Also:
Constant Field Values

DATA_CELL_ATTRIB_BPM_DT

static final int DATA_CELL_ATTRIB_BPM_DT
See Also:
Constant Field Values

DATA_CELL_ATTRIB_GL_DT

static final int DATA_CELL_ATTRIB_GL_DT
See Also:
Constant Field Values

DATA_CELL_ATTRIB_MISSINGCELL

static final int DATA_CELL_ATTRIB_MISSINGCELL
See Also:
Constant Field Values

DATA_CELL_ATTRIB_OUTOFRANGE

static final int DATA_CELL_ATTRIB_OUTOFRANGE
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_DIMTOP

static final int MEMBER_CELL_ATTRIB_DIMTOP
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_ZOOMINABLE

static final int MEMBER_CELL_ATTRIB_ZOOMINABLE
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_NEVERSHARE

static final int MEMBER_CELL_ATTRIB_NEVERSHARE
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_LABELONLY

static final int MEMBER_CELL_ATTRIB_LABELONLY
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_STOREDATA

static final int MEMBER_CELL_ATTRIB_STOREDATA
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_EXPSHARE

static final int MEMBER_CELL_ATTRIB_EXPSHARE
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_IMPSHARE

static final int MEMBER_CELL_ATTRIB_IMPSHARE
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_DYNCALC

static final int MEMBER_CELL_ATTRIB_DYNCALC
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_FORMULA

static final int MEMBER_CELL_ATTRIB_FORMULA
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_ATTRIBUTE

static final int MEMBER_CELL_ATTRIB_ATTRIBUTE
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_DIMNUMBITS

static final int MEMBER_CELL_ATTRIB_DIMNUMBITS
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_NONUNIQUE

static final int MEMBER_CELL_ATTRIB_NONUNIQUE
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_BPM_LINKED_URL

static final int MEMBER_CELL_ATTRIB_BPM_LINKED_URL
See Also:
Constant Field Values

MEMBER_CELL_ATTRIB_BPM_DT

static final int MEMBER_CELL_ATTRIB_BPM_DT
See Also:
Constant Field Values

MEMBER_KEY_SEPARATOR

static final java.lang.String MEMBER_KEY_SEPARATOR
Deprecated. 
Deprecated from 11.1.2.2 release.
See Also:
Constant Field Values

Method Detail

getCountRows

int getCountRows()
                 throws com.essbase.api.base.EssException
Gets the count of rows in the grid.
Returns:
The count of rows in the grid.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountColumns

int getCountColumns()
                    throws com.essbase.api.base.EssException
Gets the count of columns in the grid.
Returns:
The count of columns in the grid.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCellType

IEssCell.EEssCellType getCellType(int row,
                                  int column)
                                  throws com.essbase.api.base.EssException
Gets the type of the cell at the specifed row, column intersection.
Parameters:
row - The row id.
column - The column id.
Returns:
The cell type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCellContentType

int getCellContentType(int row,
                       int column)
                       throws com.essbase.api.base.EssException
Gets the type of the cell content at the specifed row, column intersection.
Parameters:
row - The row id.
column - The column id.
Returns:
The cell content type. One of the IEssGridView.CELL_CONTENT_*.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAllCellContentTypes

byte[][] getAllCellContentTypes()
                                throws com.essbase.api.base.EssException
Gets the types of the cell contents in the grid view.
Returns:
The cell content types. Values from IEssGridView.CELL_CONTENT_*.
Throws:
com.essbase.api.base.EssException

setCellContentType

void setCellContentType(int row,
                        int column,
                        int type)
                        throws com.essbase.api.base.EssException
Sets the type of the cell content at the specifed row, column intersection.
Parameters:
row - The row id.
column - The column id.
type - The cell content type. One of the IEssGridView.CELL_CONTENT_*.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDataCellAttributes

int getDataCellAttributes(int row,
                          int column)
                          throws com.essbase.api.base.EssException
Gets the attributes of the data cell at the specified row, column intersection.
Parameters:
row - The row id.
column - The column id.
Returns:
The data cell attributes. Combination of values from IEssGridView.DATA_CELL_*.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getMemberCellAttributes

int getMemberCellAttributes(int row,
                            int column)
                            throws com.essbase.api.base.EssException
Gets the attributes of the member cell at the specified row, column intersection.
Parameters:
row - The row id.
column - The column id.
Returns:
The member cell attributes. Combination of values from IEssGridView.MEMBER_CELL_*.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAllCellAttributes

int[][] getAllCellAttributes()
                             throws com.essbase.api.base.EssException
Gets the attributes for all the cells in the grid view.
Returns:
The attributes for all cells in the grid view. For member cells this will be combination of values from IEssGridView.MEMBER_CELL_*. For data cells this will be combination of values from IEssGridView.DATA_CELL_*.
Throws:
com.essbase.api.base.EssException

getStringValue

java.lang.String getStringValue(int row,
                                int column)
                                throws com.essbase.api.base.EssException
Gets the string value of the cell at the specified row, column intersection.
Parameters:
row - The row id.
column - The column id.
Returns:
The string value.
Throws:
com.essbase.api.base.EssException

getAllStringValues

java.lang.String[][] getAllStringValues()
                                        throws com.essbase.api.base.EssException
Gets the string values for all the cell in the grid view.
Returns:
The string values.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setValue

void setValue(int row,
              int column,
              java.lang.String value)
              throws com.essbase.api.base.EssException
Sets the cell value at the specified row, column intersection.

If value is being set for performing an update of a cell content type Smartlist, it must be one of the valid datatext value for that smartlist. If value is being set for performing an update of a cell content type Date, it can be formatted date value. If value is being set for performing an update of a cell having formatted string associated with it,it must be numeric value for that cell.

Parameters:
row - The row id.
column - The column id.
value - The string value.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setValue

void setValue(int row,
              int column,
              java.lang.String value,
              java.lang.String key)
              throws com.essbase.api.base.EssException
Sets the cell value at the specified row, column intersection. This call is required to set member name and key for non-unique outlines.
Parameters:
row - The row id.
column - The column id.
value - The string value.
key - The string value.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDoubleValue

double getDoubleValue(int row,
                      int column)
                      throws com.essbase.api.base.EssException
Gets the double value of the cell at the specified row, column intersection. If cell content type is smartlist, the enumeration identifier is returned. If cell content type is formatted date, the timestamp in seconds is returned.

If IEssCubeView property suppressNumValues is set, value returned for cell content type smartlist and formatted date is 0.0 If suppressNumValues is set,value returned for cell with formatted String is 0.0.

Parameters:
row - The row id.
column - The column id.
Returns:
The double value.
Throws:
com.essbase.api.base.EssException

setValue

void setValue(int row,
              int column,
              double value)
              throws com.essbase.api.base.EssException
Sets the cell value at the specified row, column intersection intersection.

If value is being set for performing an update of a cell having formatted string associated with it,it must be numeric value for that cell.

Parameters:
row - The row id.
column - The column id.
value - The double value.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getValue

IEssValueAny getValue(int row,
                      int column)
                      throws com.essbase.api.base.EssException
Gets the cell value at the specified row, column intersection.

For cell content type is Smartlist, Formatted Strings or Date, the value returned depends upon the IEssCubeView property formattedValues. if formattedValues is set, the value returned is formatted Value of specified cell otherwise it is the enumeration identifier for the cell content type smartlist and timestamp in seconds for the cell content type Date.

Parameters:
row - The row id.
column - The column id.
Returns:
The cell value at the intersection. Either a string value (for member and text cell) or a double value (for data cell) is returned.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getValueAndKey

java.lang.String[] getValueAndKey(int row,
                                  int column)
                                  throws com.essbase.api.base.EssException
Gets the cell value at the specified row, column intersection.
Parameters:
row - The row id.
column - The column id.
Returns:
String array with item at index 0 the member name and item at index 1 as key
Throws:
com.essbase.api.base.EssException - if an error occurs.

setValue

void setValue(int row,
              int column,
              IEssValueAny value)
              throws com.essbase.api.base.EssException
Sets the cell value at the specified row, column intersection.

If value is being set for performing an update of a cell content type Smartlist, it must be one of the valid datatext value for that smartlist. If value is being set for performing an update of a cell content type Date, it can be either a double value representing the timestamp in seconds or the formatted date value. If value is being set for performing an update of a cell having formatted string associated with it,it must be numeric value for that cell.

Parameters:
row - The row id.
column - The column id.
value - The cell value. Either a String value (for member and text cell) or a double value (for data cell) is allowed here.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCell

IEssCell getCell(int row,
                 int column)
                 throws com.essbase.api.base.EssException
Gets the cell at the specified row, column intersection.
Parameters:
row - The row id.
column - The column id.
Returns:
The cell at the intersection.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSize

void setSize(int countRows,
             int countColumns)
             throws com.essbase.api.base.EssException
Deletes the existing grid and creates a new empty grid with the specified number of rows and columns.
Parameters:
countRows - The count of rows in the Grid.
countColumns - The count of columns in the Grid.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUnknownMemberNames

java.lang.String[] getUnknownMemberNames()
                                         throws com.essbase.api.base.EssException
Gets the unknown members in the grid from the last operation. In order for this method to return unknown members, you need to make sure the cube view property to display unknown members is enabled by invoking the method IEssCubeView.setDisplayUnknownMembers(), before performing the cube view operation.
Returns:
The unknown member names.
Throws:
com.essbase.api.base.EssException

createIEssGridRange

IEssGridRange createIEssGridRange()
                                  throws com.essbase.api.base.EssException
Creates an object for the interface IEssGridRange.
Returns:
The grid range object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getLinkedObjects

IEssIterator getLinkedObjects(IEssGridRange[] ranges)
                              throws com.essbase.api.base.EssException
Gets linked objects for a range of cells.
Parameters:
ranges - The cell ranges.
Returns:
The linked objects.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getFormattedValue

java.lang.String getFormattedValue(int row,
                                   int column)
                                   throws com.essbase.api.base.EssException
Gets the formatted value for the cell specified by the row column intersection. If cell content type is CELL_CONTENT_TYPE_SMARTLIST returns the smartlist datatext.

For cell content type CELL_CONTENT_TYPE_DATE returns the formatted value of the date. If cell has a formatted string associated with it, it will be returned.

To get the formatted values, the IEssCubeView property formattedVauesmust be set.

Parameters:
row - The row Id
column - The column Id
Returns:
The formatted value of the cell.
Throws:
com.essbase.api.base.EssException - If an error occurs.

getSmartListName

java.lang.String getSmartListName(int row,
                                  int column)
                                  throws com.essbase.api.base.EssException
Gets the Smartlist name for the cell specified by the row column intersection.
Parameters:
row - The row Id
column - The column Id
Returns:
If the cell content type is CELL_CONTENT_TYPE_SMARTLIST. Returns the name of the SmasrtList. Otherwise throws an EssException.
Throws:
com.essbase.api.base.EssException - If an error occurs.

Skip navigation links