org.eclipse.birt.report.engine.extension
Interface IQueryResultSet

All Superinterfaces:

IBaseResultSet

public interface IQueryResultSet

extends IBaseResultSet

Field Summary

Fields inherited from interface org.eclipse.birt.report.engine.extension.IBaseResultSet

CUBE_RESULTSET, QUERY_RESULTSET

Method Summary

java.math.BigDecimal	getBigDecimal(java.lang.String name) Returns the value of a bound column as the BigDecimal data type.
java.sql.Blob	getBlob(java.lang.String name) Returns the value of a bound column as the Blob data type.
java.lang.Boolean	getBoolean(java.lang.String name) Returns the value of a bound column as the Boolean data type.
byte[]	getBytes(java.lang.String name) Returns the value of a bound column as the byte[] data type.
java.util.Date	getDate(java.lang.String name) Returns the value of a bound column as the Date data type.
java.lang.Double	getDouble(java.lang.String name) Returns the value of a bound column as the Double data type.
int	getEndingGroupLevel() Returns the 1-based index of the outermost group in which the current row is the first row.
java.lang.String	getGroupId(int groupLevel)
java.lang.Integer	getInteger(java.lang.String name) Returns the value of a bound column as the Integer data type.
org.eclipse.birt.data.engine.api.IResultIterator	getResultIterator()
org.eclipse.birt.data.engine.api.IResultMetaData	getResultMetaData() Returns the metadata of this result set's detail row.
long	getRowIndex()
int	getStartingGroupLevel() Returns the 1-based index of the outermost group in which the current row is the last row.
java.lang.String	getString(java.lang.String name) Returns the value of a bound column as the String data type.
java.lang.Object	getValue(java.lang.String name) Returns the value of a bound column.
boolean	isEmpty() Judges if the IResultSet is empty or not.
boolean	next()
boolean	skipTo(long rowIndex)

Methods inherited from interface org.eclipse.birt.report.engine.extension.IBaseResultSet

close, evaluate, evaluate, getID, getParent, getQueryResults, getRawID, getType

Method Detail

getResultIterator

public org.eclipse.birt.data.engine.api.IResultIterator getResultIterator()

getRowIndex

public long getRowIndex()

skipTo

public boolean skipTo(long rowIndex)
               throws org.eclipse.birt.core.exception.BirtException

Throws:

org.eclipse.birt.core.exception.BirtException

next

public boolean next()
             throws org.eclipse.birt.core.exception.BirtException

Throws:

org.eclipse.birt.core.exception.BirtException

getGroupId

public java.lang.String getGroupId(int groupLevel)

getStartingGroupLevel

public int getStartingGroupLevel()
                          throws org.eclipse.birt.core.exception.BirtException

Returns the 1-based index of the outermost group in which the current row is the last row. For example, if a query contain N groups (group with index 1 being the outermost group, and group with index N being the innermost group), and this function returns a value M, it indicates that the current row is the last row in groups with indexes (M, M+1, ..., N ). -1 represents current row is a detail row. 0 represents the end of whole resultset

Returns:

1-based index of the outermost group in which the current row is the first row; (N+1) if the current row is not at the start of any group; 0 if the result set has no groups.

Throws:

org.eclipse.birt.core.exception.BirtException

getEndingGroupLevel

public int getEndingGroupLevel()
                        throws org.eclipse.birt.core.exception.BirtException

Returns the 1-based index of the outermost group in which the current row is the first row. For example, if a query contain N groups (group with index 1 being the outermost group, and group with index N being the innermost group), and this function returns a value M, it indicates that the current row is the first row in groups with indexes (M, M+1, ..., N ).

Returns:

1-based index of the outermost group in which the current row is the first row; (N+1) if the current row is not at the start of any group; 0 if the result set has no groups.

Throws:

org.eclipse.birt.core.exception.BirtException

getResultMetaData

public org.eclipse.birt.data.engine.api.IResultMetaData getResultMetaData()
                                                                   throws org.eclipse.birt.core.exception.BirtException

Returns the metadata of this result set's detail row.

Returns:

The result metadata of a detail row.

Throws:

org.eclipse.birt.core.exception.BirtException

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)
                             throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column as the Boolean data type. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

getInteger

public java.lang.Integer getInteger(java.lang.String name)
                             throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column as the Integer data type. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

getDouble

public java.lang.Double getDouble(java.lang.String name)
                           throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column as the Double data type. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

getString

public java.lang.String getString(java.lang.String name)
                           throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column as the String data type. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String name)
                                   throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column as the BigDecimal data type. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

getDate

public java.util.Date getDate(java.lang.String name)
                       throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column as the Date data type. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

getBlob

public java.sql.Blob getBlob(java.lang.String name)
                      throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column as the Blob data type. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

getBytes

public byte[] getBytes(java.lang.String name)
                throws org.eclipse.birt.core.exception.BirtException

Returns the value of a bound column as the byte[] data type. Currently it is only a dummy implementation.

Parameters:

name - of bound column

Returns:

value of bound column

Throws:

org.eclipse.birt.core.exception.BirtException

isEmpty

public boolean isEmpty()
                throws org.eclipse.birt.core.exception.BirtException

Judges if the IResultSet is empty or not.

Returns:

true if IResultSet is empty. false if it is not empty.

Throws:

org.eclipse.birt.core.exception.BirtException