com.essbase.api.datasource

Interface IEssMaxlResultSet

All Superinterfaces:

IEssBaseObject

public interface IEssMaxlResultSet
extends IEssBaseObject

A table of data representing a Essbase result set, which is usually generated by executing a statement that queries the Essbase.

A IEssMaxlResultSet object maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The next method moves the cursor to the next row, and because it returns false when there are no more rows in the IEssMaxlResultSet object, it can be used in a while loop to iterate through the result set.

Version:

2.0, 13 Feb 2005

Author:

Abhijeet Katariya, Balaji S

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(int columnIndex) Retrieves the value of the designated column in the current row of this ResultSet object as a boolean.
boolean	getBoolean(java.lang.String columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a boolean.
int	getColumnCount() Gives you the total no.
java.lang.String	getColumnName(int col) Gives the column name for given column index.
IEssValueAny.EEssDataType	getColumnType(int col) Returns the column type for given column index.
int	getColumnWidth(int col) Gives the column width for given column index.
double	getDouble(int columnIndex) Retrieves the value of the designated column in the current row of this ResultSet object as a double.
double	getDouble(java.lang.String columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a long.
long	getLong(int columnIndex) Retrieves the value of the designated column in the current row of this ResultSet object as a long.
long	getLong(java.lang.String columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a IEssValueAny object.
int	getOlapFileObjectType(int maxlFileObjType) Returns the OLAP file object type for a given maxl file object type.
java.lang.String	getString(int columnIndex) Retrieves the value of the designated column in the current row of this ResultSet object as a java.lang.String
java.lang.String	getString(java.lang.String columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a java.lang.String
IEssValueAny	getValue(int columnIndex) Retrieves the value of the designated column in the current row of this ResultSet object as a IEssValueAny object.
IEssValueAny	getValue(java.lang.String columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a IEssValueAny object.
boolean	next() Moves the cursor down one row from its current position.

Method Detail

next

boolean next()
      throws com.essbase.api.base.EssException

Moves the cursor down one row from its current position. A ResultSet cursor is initially positioned before the first row; the first call to the method next makes the first row the current row; the second call makes the second row the current row, and so on.

Returns:

true if there exits next record; otherwise false.

Throws:

com.essbase.api.base.EssException - if an internal error occurs.

getString

java.lang.String getString(int columnIndex)

Retrieves the value of the designated column in the current row of this ResultSet object as a java.lang.String

Parameters:

columnIndex - Column Index Number.

Returns:

Data cell Value

getString

java.lang.String getString(java.lang.String columnName)

Retrieves the value of the designated column in the current row of this ResultSet object as a java.lang.String

Parameters:

columnName - Column Name

Returns:

Data cell Value

getBoolean

boolean getBoolean(int columnIndex)

Retrieves the value of the designated column in the current row of this ResultSet object as a boolean.

Parameters:

columnIndex - Column Index Number.

Returns:

Data cell Value

getBoolean

boolean getBoolean(java.lang.String columnName)

Retrieves the value of the designated column in the current row of this ResultSet object as a boolean.

Parameters:

columnName - Column Name

Returns:

Data cell Value

getDouble

double getDouble(int columnIndex)

Retrieves the value of the designated column in the current row of this ResultSet object as a double.

Parameters:

columnIndex - Column Index Number.

Returns:

Data cell Value

getDouble

double getDouble(java.lang.String columnName)

Retrieves the value of the designated column in the current row of this ResultSet object as a long.

Parameters:

columnName - Column Name

Returns:

Data cell Value

getLong

long getLong(int columnIndex)

Retrieves the value of the designated column in the current row of this ResultSet object as a long.

Parameters:

columnIndex - Column Index Number.

Returns:

Data cell Value

getLong

long getLong(java.lang.String columnName)

Retrieves the value of the designated column in the current row of this ResultSet object as a IEssValueAny object.

Parameters:

columnName - Column Name

Returns:

Data cell Value

getValue

IEssValueAny getValue(int columnIndex)
               throws com.essbase.api.base.EssException

Retrieves the value of the designated column in the current row of this ResultSet object as a IEssValueAny object.

Parameters:

columnIndex - Column index number.

Returns:

Value of the specified column.

Throws:

com.essbase.api.base.EssException - if an internal error occurs.

getValue

IEssValueAny getValue(java.lang.String columnName)
               throws com.essbase.api.base.EssException

Retrieves the value of the designated column in the current row of this ResultSet object as a IEssValueAny object.

Parameters:

columnName - Column Name for which the value is needed.

Returns:

Value of the given column.

Throws:

com.essbase.api.base.EssException - if an internal error occurs.

getColumnCount

int getColumnCount()

Gives you the total no. of columns held by this resultset.

Returns:

Number of Columns

getColumnWidth

int getColumnWidth(int col)

Gives the column width for given column index.

Parameters:

col - Column Index Number

Returns:

Column width

getColumnName

java.lang.String getColumnName(int col)

Gives the column name for given column index.

Parameters:

col - Column Index Number

Returns:

Column name

getColumnType

IEssValueAny.EEssDataType getColumnType(int col)

Returns the column type for given column index.

Parameters:

col - Column Index Number

Returns:

Data type of the given column.

getOlapFileObjectType

int getOlapFileObjectType(int maxlFileObjType)
                   throws com.essbase.api.base.EssException

Returns the OLAP file object type for a given maxl file object type. For File object types that are part of a Base type, the base type value is returned. that is For Example:[1.IEssOlapFileObject.TYPE_BACKUP value is returned for both the Asci backup and binary backup file types as both are backup files 2.IEssOlapFileObject.TYPE_WORKSHEET value is returned for Excel,Lotus2,Lotus3, Lotus4 files types as all of them are worksheet files.]

Parameters:

maxlFileObjType - Represents the Fileobject type in MAXL

Returns:

olap file object type or -1 if the corresponding olap file object type is not found

Throws:

com.essbase.api.base.EssException - if an internal error occurs.