com.sap.ip.bi.sdk.dac.result.model
Class BITableItem

java.lang.Object
  |
  +--com.sap.ip.bi.sdk.dac.result.model.BITableItem

public class BITableItem

extends Object

Provides cell information for BIDataSetTableModel, used by the BIDataSetTableModel.getValueAt(int, int) method.

This class includes four pieces of information:

1. section info (method getSection()):
   It identifies the different sections of the output table:
   • CELLS
   • COLUMN_HEADERS
   • ROW_HEADERS
   • CAPTION
2. cell item (method getItem()):
   It represents cell item as an object, and may the type of:
   • Member Cursor Object (IBIDimensionCursor)
   • Member Properties ( String )
   • Cell Data (BICellData)
   • "" for CAPTION section
3. minimum level (method getMinLevel()):
   minimal level of the dimension's member. This is used only for objects of row header and column header.
4. last dimension level(method getSection()):
   the sum of levels and property count for the dimension's member or property.

To get the String value of the BITableItem object, use the toString() method.

Since:

3.50

Constructor Summary

BITableItem(int section, Object item)
Creates the table item.

BITableItem(int section, Object item, int[] lvlInfo)
Creates the table item, with the specified level information.

Method Summary

int	getAccumulatedHeaderPositionCount() Gets the accumulated header position count.
int	getHeaderPositionCount() Gets the header position count.
Object	getItem() Gets the item.
int	getLevelCount() Gets the level count.
int	getMinLevel() Gets the minimum level.
int	getRelativeLevel() Returns the relative distance of the members level from the minimum level occurring for the same dimension in a data set.
int	getSection() Gets the section.
String	toString() Returns the formatted instance of the cell.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BITableItem

public BITableItem(int section,
                   Object item)

Creates the table item.

Parameters:

section - the section

item - the item

BITableItem

public BITableItem(int section,
                   Object item,
                   int[] lvlInfo)

Creates the table item, with the specified level information.

Parameters:

section - the section

item - the item

lvlInfo - array of level information

Method Detail

getSection

public int getSection()

Gets the section.

Returns:

the section

getItem

public Object getItem()

Gets the item.

Returns:

the item

getMinLevel

public int getMinLevel()

Gets the minimum level.

Returns:

the level

getLevelCount

public int getLevelCount()

Gets the level count.

Returns:

the level count

getHeaderPositionCount

public int getHeaderPositionCount()

Gets the header position count.

Returns:

the header position count

getAccumulatedHeaderPositionCount

public int getAccumulatedHeaderPositionCount()

Gets the accumulated header position count.

Returns:

the accumulated header position count

toString

public String toString()

Returns the formatted instance of the cell.

Overrides:

toString in class Object

Returns:

the formatted cell

getRelativeLevel

public int getRelativeLevel()

Returns the relative distance of the members level from the minimum level occurring for the same dimension in a data set. For example, if a member is on level 3, and the minimum level occurring in the data set is 2, this method returns 1.

Returns:

if the item is a PositionMember, the distance of the member's level from the minimum level for the same dimension occurring in the data set; otherwise, 0