|
|||||||||||
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(IBaseExpression dataExpr)
Returns the value of a query result expression as a BigDecimal, by type casting the Object returned by getValue. |
java.sql.Blob |
getBlob(IBaseExpression dataExpr)
Returns the value of a query result expression representing Blob data. |
java.lang.Boolean |
getBoolean(IBaseExpression dataExpr)
Returns the value of a query result expression as a Boolean, by type casting the Object returned by getValue. |
byte[] |
getBytes(IBaseExpression dataExpr)
Returns the value of a query result expression representing Binary data. |
java.util.Date |
getDate(IBaseExpression dataExpr)
Returns the value of a query result expression as a Date, by type casting the Object returned by getValue. |
java.lang.Double |
getDouble(IBaseExpression dataExpr)
Returns the value of a query result expression as a Double, by type casting the Object returned by getValue. |
int |
getEndingGroupLevel()
Returns the 1-based index of the outermost group in which the current row is the last row. |
java.lang.Integer |
getInteger(IBaseExpression dataExpr)
Returns the value of a query result expression as an Integer, by type casting the Object returned by getValue. |
IQueryResults |
getQueryResults()
Returns the IQueryResults
from which this result iterator is obtained. |
IResultMetaData |
getResultMetaData()
Returns the metadata of this result set's detail row. |
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(IBaseExpression dataExpr)
Returns the value of a query result expression as a String, by type casting the Object returned by getValue. |
java.lang.Object |
getValue(IBaseExpression dataExpr)
Returns the value of a query result expression. |
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 org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
public boolean next() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic java.lang.Object getValue(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
Throws an exception if a result expression value is requested
out of sequence from the prepared IQueryDefinition
spec.
E.g. A group aggregation is defined to be after_last_row.
It would be out of sequence if requested before having
iterated/skipped to the last row of the group.
In future release, this could have intelligence to auto recover
and performs dependent operations to properly evaluate
any out-of-sequence result values.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic java.lang.Boolean getBoolean(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
DataException
is thrown at runtime.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic java.lang.Integer getInteger(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
DataException
is thrown at runtime.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic java.lang.Double getDouble(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
DataException
is thrown at runtime.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic java.lang.String getString(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
DataException
is thrown at runtime.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic java.math.BigDecimal getBigDecimal(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
DataException
is thrown at runtime.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic java.util.Date getDate(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
DataException
is thrown at runtime.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic java.sql.Blob getBlob(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
DataException
is thrown at runtime.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic byte[] getBytes(IBaseExpression dataExpr) throws org.eclipse.birt.core.exception.BirtException
DataException
is thrown at runtime.
dataExpr
- An IBaseExpression
object provided in
the IQueryDefinition
at the time of prepare.
org.eclipse.birt.core.exception.BirtException
- if error occurs in Data Enginepublic 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 Enginepublic int getStartingGroupLevel() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
public int getEndingGroupLevel() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
public 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
org.eclipse.birt.data.engine.core.DataException
- if error occurs in Data Engine
org.eclipse.birt.core.exception.BirtException
public void close() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
public boolean findGroup(java.lang.Object[] groupKeyValues) throws org.eclipse.birt.core.exception.BirtException
groupKeyValues
- Values of group keys
org.eclipse.birt.data.engine.core.DataException
org.eclipse.birt.core.exception.BirtException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |