QueryLocalIterator (IBM WebSphere Application Server, Release 8.5)

Skip navigation links

IBM WebSphere Application Server^TM
Release 8.5

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.ibm.websphere.ejbquery.QueryLocalIterator

All Implemented Interfaces:

java.io.Serializable, java.util.Iterator
```
public class QueryLocalIterator
extends java.lang.Object
implements java.util.Iterator, java.io.Serializable
```
Iterator over a collection of IQueryTuple objects. This iterator is returned by the local interface of the Websphere dynamic ejb query service. The result collection belonging to this iterator may be demand driven depending on the nature of the ejb query statement. In general an ejb query will be demand driven unless it requires an in memory ordering, grouping or predicate evaluation. Any SQL resources belonging to this iterator will be freed when the iteration is completed, at garbage collection of the iterator or by calling the close( ) method.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

QueryLocalIterator(com.ibm.ObjectQuery.eval.DataEnumerator denum, java.util.ArrayList headings)

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` closes and frees the SQL cursor
`java.lang.Exception`	`getException()` used to obtain exception information about sql errors or ejb query execution errors.
`java.lang.Object`	`getFieldClassName(int field)` future
`java.lang.String`	`getFieldName(int field)` descriptive name for the nth field of the result set. n=1 is the first field.
`int`	`getFieldsCount()` number of fields in the result set.
`java.lang.Object`	`getFieldType(int field)` future
`boolean`	`hasNext()` returns TRUE if the iteration has more elements
`java.lang.Object`	`next()` returns the next IQueryTuple in the iteration
`void`	`remove()` no operation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueryLocalIterator
```
public QueryLocalIterator(com.ibm.ObjectQuery.eval.DataEnumerator denum,
                  java.util.ArrayList headings)
```
- Method Detail
  - next
```
public java.lang.Object next()
```
    returns the next IQueryTuple in the iteration
    
    Specified by:
    
    next in interface java.util.Iterator
  - hasNext
```
public boolean hasNext()
```
    returns TRUE if the iteration has more elements
    
    Specified by:
    
    hasNext in interface java.util.Iterator
  - remove
```
public void remove()
```
    no operation
    
    Specified by:
    
    remove in interface java.util.Iterator
  - close
```
public void close()
           throws QueryException
```
    closes and frees the SQL cursor
    
    Throws:
    
    QueryException
  - getException
```
public java.lang.Exception getException()
```
    used to obtain exception information about sql errors or ejb query execution errors.
  - getFieldType
```
public java.lang.Object getFieldType(int field)
```
    future
  - getFieldClassName
```
public java.lang.Object getFieldClassName(int field)
```
    future
  - getFieldName
```
public java.lang.String getFieldName(int field)
```
    descriptive name for the nth field of the result set. n=1 is the first field.
  - getFieldsCount
```
public int getFieldsCount()
```
    number of fields in the result set.