|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IResultIterator
An iterator on a result set from a prepared and executed query.
Multiple IResultIterator
objects could be associated with
the same IQueryResults
object, such as in the case of an ODA data set
capable of producing multiple result sets.
Method Summary | |
---|---|
boolean |
findGroup(java.lang.Object[] groupKeyValues)
Move the current position of the iterator to the first element of the group with matching group key values. |
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 last row. |
java.lang.Integer |
getInteger(java.lang.String name)
Returns the value of a bound column as the Integer data type. |
IQueryResults |
getQueryResults()
Returns the IQueryResults
from which this result iterator is obtained. |
int |
getRowId()
Each row has its an ID associated with it, and this id will never be changed no matter when the query is running against a data set or against a report document. |
org.mozilla.javascript.Scriptable |
getScope()
Returns the JavaScript scope associated with this result iterator. |
IResultIterator |
getSecondaryIterator(java.lang.String subQueryName,
org.mozilla.javascript.Scriptable scope)
Returns the secondary result specified by a sub query that was defined in the prepared IQueryDefinition . |
int |
getStartingGroupLevel()
Returns the 1-based index of the outermost group in which the current row is the first row. |
java.lang.String |
getString(java.lang.String name)
Returns the value of a bound column as the String data type. |
boolean |
isBeforeFirst()
Retrieves whether the cursor is before the first row in this IResultIterator object. |
boolean |
isFirst()
Retrieves whether the cursor is on the first row of this IResultIterator object. |
void |
moveTo(int rowIndex)
Moves iterator to the row with given absolute index. |
void |
skipToEnd(int groupLevel)
Advances the iterator, skipping rows to the last row in the current group at the specified group level. |
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseResultIterator |
---|
close, getResultMetaData, getRowIndex, getValue, isEmpty, next |
Method Detail |
---|
IQueryResults getQueryResults()
IQueryResults
from which this result iterator is obtained. If this iterator
is that of a subquery, null is returned.
org.mozilla.javascript.Scriptable getScope()
IPreparedQuery.excute()
which produced this iterator's IQueryResults
.
int getRowId() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginejava.lang.Boolean getBoolean(java.lang.String name) throws org.eclipse.birt.core.exception.BirtException
name
- of bound column
org.eclipse.birt.core.exception.BirtException
java.lang.Integer getInteger(java.lang.String name) throws org.eclipse.birt.core.exception.BirtException
name
- of bound column
org.eclipse.birt.core.exception.BirtException
java.lang.Double getDouble(java.lang.String name) throws org.eclipse.birt.core.exception.BirtException
name
- of bound column
org.eclipse.birt.core.exception.BirtException
java.lang.String getString(java.lang.String name) throws org.eclipse.birt.core.exception.BirtException
name
- of bound column
org.eclipse.birt.core.exception.BirtException
java.math.BigDecimal getBigDecimal(java.lang.String name) throws org.eclipse.birt.core.exception.BirtException
name
- of bound column
org.eclipse.birt.core.exception.BirtException
java.util.Date getDate(java.lang.String name) throws org.eclipse.birt.core.exception.BirtException
name
- of bound column
org.eclipse.birt.core.exception.BirtException
java.sql.Blob getBlob(java.lang.String name) throws org.eclipse.birt.core.exception.BirtException
name
- of bound column
org.eclipse.birt.core.exception.BirtException
byte[] getBytes(java.lang.String name) throws org.eclipse.birt.core.exception.BirtException
name
- of bound column
org.eclipse.birt.core.exception.BirtException
void skipToEnd(int groupLevel) throws org.eclipse.birt.core.exception.BirtException
groupLevel
- An absolute value for group level.
A value of 0 applies to the whole result set.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Engineint getStartingGroupLevel() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
int getEndingGroupLevel() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
IResultIterator getSecondaryIterator(java.lang.String subQueryName, org.mozilla.javascript.Scriptable scope) throws org.eclipse.birt.core.exception.BirtException
IQueryDefinition
.
subQueryName
- name of sub query which defines the secondary result setscope
- Javascript scope to be associated with the secondary result set
DataException
- if error occurs in Data Engine
org.eclipse.birt.core.exception.BirtException
boolean findGroup(java.lang.Object[] groupKeyValues) throws org.eclipse.birt.core.exception.BirtException
groupKeyValues
- Values of group keys
DataException
org.eclipse.birt.core.exception.BirtException
boolean isFirst() throws org.eclipse.birt.core.exception.BirtException
IResultIterator
object.
true
if the cursor is on the first row;
false
otherwise
org.eclipse.birt.core.exception.BirtException
boolean isBeforeFirst() throws org.eclipse.birt.core.exception.BirtException
IResultIterator
object.
true
if the cursor is before the first row;
false
if the cursor is at any other position or the
result set contains no rows
org.eclipse.birt.core.exception.BirtException
void moveTo(int rowIndex) throws org.eclipse.birt.core.exception.BirtException
rowIndex,
- which index needs to advance to
BirtException,
- if rowIndex is invalid
org.eclipse.birt.core.exception.BirtException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |