SAP BI Java SDK

com.sap.ip.bi.sdk.dac.result
Interface IBICursorColumn


public interface IBICursorColumn

Predefined mandatory columns for the different types of cursors. Mandatory columns have an index as well as a name; optional columns are specified by name only. All columns have associated type information.

Since:
3.50

Field Summary
static IBICursorColumn CAPTION
          Contains the caption of the attribute associated with this cell.
static IBICursorColumn CATALOG_NAME
          Contains the catalog name of the cube associated with this cell.
static IBICursorColumn CHILDREN_CARDINALITY
          Contains the number of children of the hierarchy and level associated with this cell.
static IBICursorColumn CUBE_NAME
          Contains the name of the cube associated with this cell.
static IBICursorColumn DATATYPE
          Contains the data type (see java.sql.Types) of this cell.
static IBICursorColumn DESCRIPTION
          Contains the description associated with this cell.
static IBICursorColumn DIMENSION_UNIQUE_NAME
          Contains the unique name of the dimension associated with this cell.
static IBICursorColumn DISPLAY_INFO
          Contains display information (encoded in an int) of this cell.
static IBICursorColumn FORMATTED_VALUE
          Contains the formatted value (String) of this cell.
static IBICursorColumn HIERARCHY_UNIQUE_NAME
          Contains the unique name of the hierarchy associated with this cell.
static IBICursorColumn LEVEL_NUMBER
          Contains the number of the level associated with this cell.
static IBICursorColumn LEVEL_UNIQUE_NAME
          Contains the unique name of the level associated with this cell.
static IBICursorColumn MEMBER_CAPTION
          Contains the caption of the member associated with this cell.
static IBICursorColumn MEMBER_DRILLED_DOWN
          Indicates whether the member associated with this cell is in a drill down state.
static IBICursorColumn MEMBER_GUID
          Contains the GUID of the member associated with this cell.
static IBICursorColumn MEMBER_NAME
          Contains the member name associated with this cell.
static IBICursorColumn MEMBER_TYPE
          Contains the type of the member associated with this cell.
static IBICursorColumn MEMBER_UNIQUE_NAME
          Contains the unique name of the member associated with this cell.
static IBICursorColumn NAME
          Contains the name of the attribute associated with this cell.
static IBICursorColumn PARENT_COUNT
          Contains the number of children of the parent node of the hierarchy and level associated with this cell.
static IBICursorColumn PARENT_LEVEL
          Contains the level name of the parent node of the hierarchy and level associated with this cell.
static IBICursorColumn PARENT_SAME_AS_PROV
          Indicates that the parent of this member is the same as the parent of the member immediately preceding it.
static IBICursorColumn PARENT_UNIQUE_NAME
          Contains the unique name of the parent node of the hierarchy associated with this cell.
static IBICursorColumn SCHEMA_NAME
          Contains the schema name of the cube associated with this cell.
static IBICursorColumn STATUS
          Contains the status (see IBICellStatus) of this cell.
static IBICursorColumn VALUE
          Contains the raw value of this cell.
 
Method Summary
 int getIndex()
          Retrieves the index of this column of the current cell.
 IBICursorColumnType getType()
          Retrieves the data type of this column.
 boolean isMandatory()
          Indicates whether this a mandatory column.
 String toString()
          Retrieves the name of this column.
 

Field Detail

VALUE

public static final IBICursorColumn VALUE
Contains the raw value of this cell.

DATATYPE

public static final IBICursorColumn DATATYPE
Contains the data type (see java.sql.Types) of this cell.

STATUS

public static final IBICursorColumn STATUS
Contains the status (see IBICellStatus) of this cell.

FORMATTED_VALUE

public static final IBICursorColumn FORMATTED_VALUE
Contains the formatted value (String) of this cell.

MEMBER_CAPTION

public static final IBICursorColumn MEMBER_CAPTION
Contains the caption of the member associated with this cell.

MEMBER_UNIQUE_NAME

public static final IBICursorColumn MEMBER_UNIQUE_NAME
Contains the unique name of the member associated with this cell.

LEVEL_UNIQUE_NAME

public static final IBICursorColumn LEVEL_UNIQUE_NAME
Contains the unique name of the level associated with this cell.

LEVEL_NUMBER

public static final IBICursorColumn LEVEL_NUMBER
Contains the number of the level associated with this cell.

DISPLAY_INFO

public static final IBICursorColumn DISPLAY_INFO
Contains display information (encoded in an int) of this cell.

MEMBER_NAME

public static final IBICursorColumn MEMBER_NAME
Contains the member name associated with this cell.

MEMBER_TYPE

public static final IBICursorColumn MEMBER_TYPE
Contains the type of the member associated with this cell.

MEMBER_GUID

public static final IBICursorColumn MEMBER_GUID
Contains the GUID of the member associated with this cell.

CATALOG_NAME

public static final IBICursorColumn CATALOG_NAME
Contains the catalog name of the cube associated with this cell.

SCHEMA_NAME

public static final IBICursorColumn SCHEMA_NAME
Contains the schema name of the cube associated with this cell.

CUBE_NAME

public static final IBICursorColumn CUBE_NAME
Contains the name of the cube associated with this cell.

DIMENSION_UNIQUE_NAME

public static final IBICursorColumn DIMENSION_UNIQUE_NAME
Contains the unique name of the dimension associated with this cell.

HIERARCHY_UNIQUE_NAME

public static final IBICursorColumn HIERARCHY_UNIQUE_NAME
Contains the unique name of the hierarchy associated with this cell.

CHILDREN_CARDINALITY

public static final IBICursorColumn CHILDREN_CARDINALITY
Contains the number of children of the hierarchy and level associated with this cell.

PARENT_UNIQUE_NAME

public static final IBICursorColumn PARENT_UNIQUE_NAME
Contains the unique name of the parent node of the hierarchy associated with this cell.

PARENT_LEVEL

public static final IBICursorColumn PARENT_LEVEL
Contains the level name of the parent node of the hierarchy and level associated with this cell.

PARENT_COUNT

public static final IBICursorColumn PARENT_COUNT
Contains the number of children of the parent node of the hierarchy and level associated with this cell.

DESCRIPTION

public static final IBICursorColumn DESCRIPTION
Contains the description associated with this cell.

MEMBER_DRILLED_DOWN

public static final IBICursorColumn MEMBER_DRILLED_DOWN
Indicates whether the member associated with this cell is in a drill down state.

PARENT_SAME_AS_PROV

public static final IBICursorColumn PARENT_SAME_AS_PROV
Indicates that the parent of this member is the same as the parent of the member immediately preceding it. This information can be useful for certain rendering algorithms, and allows a client application to look this information up without an expensive roundtrip to the server.

NAME

public static final IBICursorColumn NAME
Contains the name of the attribute associated with this cell.

CAPTION

public static final IBICursorColumn CAPTION
Contains the caption of the attribute associated with this cell.
Method Detail

toString

public String toString()
Retrieves the name of this column.
Overrides:
toString in class Object
Returns:
the name of this column

getType

public IBICursorColumnType getType()
Retrieves the data type of this column.
Returns:
the type

isMandatory

public boolean isMandatory()
Indicates whether this a mandatory column.
Returns:
true if this is a mandatory column; false otherwise

getIndex

public int getIndex()
Retrieves the index of this column of the current cell.
Returns:
0 if this is not a mandatory column; the index (1-based) otherwise

SAP BI Java SDK

Copyright © 2004-2006 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.