|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
void |
close()
Closes this result and any associated secondary result iterator(s), providing a hint that the consumer is done with this result, whose resources can be safely released as appropriate. |
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. |
IResultMetaData |
getResultMetaData()
Returns the metadata of this result set's detail row. |
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. |
int |
getRowIndex()
Each row has its own index, which indicates this row position in the result set. |
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. |
java.lang.Object |
getValue(java.lang.String name)
Returns the value of a bound column. |
boolean |
isEmpty()
Judges if the IResultSetIterator is empty or not |
void |
moveTo(int rowIndex)
Moves iterator to the row with given absolute index. |
boolean |
next()
Moves down one element from its current position of the iterator. |
void |
skipToEnd(int groupLevel)
Advances the iterator, skipping rows to the last row in the current group at the specified group level. |
Method Detail |
public IQueryResults getQueryResults()
IQueryResults
from which this result iterator is obtained. If this iterator
is that of a subquery, null is returned.
public org.mozilla.javascript.Scriptable getScope()
IPreparedQuery.excute()
which produced this iterator's IQueryResults
.
public IResultMetaData getResultMetaData() throws BirtException
BirtException
public boolean next() throws BirtException
BirtException
- if error occurs in Data Enginepublic int getRowId() throws BirtException
BirtException
- if error occurs in Data Enginepublic int getRowIndex() throws BirtException
BirtException
- if error occurs in Data Enginepublic void moveTo(int rowIndex) throws BirtException
BirtException,
- if rowIndex is invalid
BirtException
public java.lang.Object getValue(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public java.lang.Boolean getBoolean(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public java.lang.Integer getInteger(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public java.lang.Double getDouble(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public java.lang.String getString(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public java.math.BigDecimal getBigDecimal(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public java.util.Date getDate(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public java.sql.Blob getBlob(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public byte[] getBytes(java.lang.String name) throws BirtException
name
- of bound column
BirtException
public void skipToEnd(int groupLevel) throws BirtException
groupLevel
- An absolute value for group level.
A value of 0 applies to the whole result set.
BirtException
- if error occurs in Data Enginepublic int getStartingGroupLevel() throws BirtException
BirtException
public int getEndingGroupLevel() throws BirtException
BirtException
public IResultIterator getSecondaryIterator(java.lang.String subQueryName, org.mozilla.javascript.Scriptable scope) throws 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
BirtException
public void close() throws BirtException
BirtException
public boolean findGroup(java.lang.Object[] groupKeyValues) throws BirtException
groupKeyValues
- Values of group keys
DataException
BirtException
public boolean isEmpty() throws BirtException
BirtException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |