|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssGridView
The IEssGridView is a grid view of the cube view.
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 |
---|
static final int CELL_TYPE_MEMBER
static final int CELL_TYPE_DATA
static final int CELL_TYPE_TEXT
static final int CELL_CONTENT_TYPE_STRING
static final int CELL_CONTENT_TYPE_DOUBLE
static final int CELL_CONTENT_TYPE_BLANK
static final int CELL_CONTENT_TYPE_ERROR
static final int CELL_CONTENT_TYPE_MISSING
static final int CELL_CONTENT_TYPE_ZERO
static final int CELL_CONTENT_TYPE_NOACCESS
static final int CELL_CONTENT_TYPE_MEMBER
static final int CELL_CONTENT_TYPE_MEMBEREX
static final int CELL_CONTENT_TYPE_STRINGEX
static final int CELL_CONTENT_TYPE_STRINGEXwFORMULA
static final int CELL_CONTENT_TYPE_FORMULAEX
static final int CELL_CONTENT_TYPE_HYBRID_MEMBER
static final int CELL_CONTENT_TYPE_MEMBERwKEY
static final int CELL_CONTENT_TYPE_FORMULA
static final int CELL_CONTENT_TYPE_ZEROwFORMULA
static final int CELL_CONTENT_TYPE_DOUBLEwFORMULA
static final int CELL_CONTENT_TYPE_BLANKwFORMULA
static final int CELL_CONTENT_TYPE_STRINGwFORMULA
static final int CELL_CONTENT_TYPE_MISSINGwFORMULA
static final int CELL_CONTENT_TYPE_NOACCESSwFORMULA
static final int CELL_CONTENT_TYPE_SMARTLIST
static final int CELL_CONTENT_TYPE_DATE
static final int DATA_CELL_ATTRIB_READ_ONLY
static final int DATA_CELL_ATTRIB_READ_WRITE
static final int DATA_CELL_ATTRIB_LINKED_OBJECT
static final int DATA_CELL_ATTRIB_LINKED_PARTITION
static final int DATA_CELL_ATTRIB_LINKED_CELL_NOTE
static final int DATA_CELL_ATTRIB_LINKED_WIN_APP
static final int DATA_CELL_ATTRIB_LINKED_URL
static final int DATA_CELL_ATTRIB_HIS_DT
static final int DATA_CELL_ATTRIB_BPM_LINKED_URL
static final int DATA_CELL_ATTRIB_BPM_DT
static final int DATA_CELL_ATTRIB_GL_DT
static final int DATA_CELL_ATTRIB_MISSINGCELL
static final int DATA_CELL_ATTRIB_OUTOFRANGE
static final int MEMBER_CELL_ATTRIB_DIMTOP
static final int MEMBER_CELL_ATTRIB_ZOOMINABLE
static final int MEMBER_CELL_ATTRIB_NEVERSHARE
static final int MEMBER_CELL_ATTRIB_LABELONLY
static final int MEMBER_CELL_ATTRIB_STOREDATA
static final int MEMBER_CELL_ATTRIB_EXPSHARE
static final int MEMBER_CELL_ATTRIB_IMPSHARE
static final int MEMBER_CELL_ATTRIB_DYNCALC
static final int MEMBER_CELL_ATTRIB_FORMULA
static final int MEMBER_CELL_ATTRIB_ATTRIBUTE
static final int MEMBER_CELL_ATTRIB_DIMNUMBITS
static final int MEMBER_CELL_ATTRIB_NONUNIQUE
static final int MEMBER_CELL_ATTRIB_BPM_LINKED_URL
static final int MEMBER_CELL_ATTRIB_BPM_DT
static final java.lang.String MEMBER_KEY_SEPARATOR
Method Detail |
---|
int getCountRows() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getCountColumns() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssCell.EEssCellType getCellType(int row, int column) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.com.essbase.api.base.EssException
- if an error occurs.int getCellContentType(int row, int column) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.com.essbase.api.base.EssException
- if an error occurs.byte[][] getAllCellContentTypes() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void setCellContentType(int row, int column, int type) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.type
- The cell content type. One of the IEssGridView.CELL_CONTENT_*.com.essbase.api.base.EssException
- if an error occurs.int getDataCellAttributes(int row, int column) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.com.essbase.api.base.EssException
- if an error occurs.int getMemberCellAttributes(int row, int column) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.com.essbase.api.base.EssException
- if an error occurs.int[][] getAllCellAttributes() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
java.lang.String getStringValue(int row, int column) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.com.essbase.api.base.EssException
java.lang.String[][] getAllStringValues() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setValue(int row, int column, java.lang.String value) throws com.essbase.api.base.EssException
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.
row
- The row id.column
- The column id.value
- The string value.com.essbase.api.base.EssException
- if an error occurs.void setValue(int row, int column, java.lang.String value, java.lang.String key) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.value
- The string value.key
- The string value.com.essbase.api.base.EssException
- if an error occurs.double getDoubleValue(int row, int column) throws com.essbase.api.base.EssException
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.
row
- The row id.column
- The column id.com.essbase.api.base.EssException
void setValue(int row, int column, double value) throws com.essbase.api.base.EssException
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.
row
- The row id.column
- The column id.value
- The double value.com.essbase.api.base.EssException
- if an error occurs.IEssValueAny getValue(int row, int column) throws com.essbase.api.base.EssException
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.
row
- The row id.column
- The column id.com.essbase.api.base.EssException
- if an error occurs.java.lang.String[] getValueAndKey(int row, int column) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.com.essbase.api.base.EssException
- if an error occurs.void setValue(int row, int column, IEssValueAny value) throws com.essbase.api.base.EssException
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.
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.com.essbase.api.base.EssException
- if an error occurs.IEssCell getCell(int row, int column) throws com.essbase.api.base.EssException
row
- The row id.column
- The column id.com.essbase.api.base.EssException
- if an error occurs.void setSize(int countRows, int countColumns) throws com.essbase.api.base.EssException
countRows
- The count of rows in the Grid.countColumns
- The count of columns in the Grid.com.essbase.api.base.EssException
- if an error occurs.java.lang.String[] getUnknownMemberNames() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
IEssGridRange createIEssGridRange() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssIterator getLinkedObjects(IEssGridRange[] ranges) throws com.essbase.api.base.EssException
ranges
- The cell ranges.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getFormattedValue(int row, int column) throws com.essbase.api.base.EssException
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 formattedVaues
must be set.
row
- The row Idcolumn
- The column Idcom.essbase.api.base.EssException
- If an error occurs.java.lang.String getSmartListName(int row, int column) throws com.essbase.api.base.EssException
row
- The row Idcolumn
- The column IdCELL_CONTENT_TYPE_SMARTLIST
. Returns the name of the SmasrtList. Otherwise throws an EssException.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 |