OQLQueryImpl.OQLEnumeration (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.jdo.engine.OQLQueryImpl.OQLEnumeration

All Implemented Interfaces:

java.util.Enumeration<java.lang.Object>, QueryResults

Enclosing class:

OQLQueryImpl
```
class OQLQueryImpl.OQLEnumeration
extends java.lang.Object
implements QueryResults, java.util.Enumeration<java.lang.Object>
```
Enumeration implementation to traverse the result as returned by the execution of the OQL query.

Constructor Summary

Constructors
Constructor	Description
`OQLEnumeration(QueryResults results)`
`OQLEnumeration(QueryResults results, java.util.Vector<java.lang.String> pathInfo, ClassDescriptor clsDesc)`	Creates an instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`absolute(int row)`	moves the result of the query to the absolute position in the resultset.
`void`	`close()`	Closes the result set and releases all resources held by it.
`boolean`	`hasMore()`	Returns true if there are any more results in the result set.
`boolean`	`hasMore(boolean skipError)`
`boolean`	`hasMoreElements()`
`java.lang.Object`	`next()`	Returns the next result in the result set.
`java.lang.Object`	`nextElement()`
`int`	`size()`	Finds the size of the resulting resultset from the query.

Methods inherited from interface java.util.Enumeration
asIterator

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

- Constructor Detail
  - OQLEnumeration
```
OQLEnumeration(QueryResults results,
               java.util.Vector<java.lang.String> pathInfo,
               ClassDescriptor clsDesc)
```
    Creates an instance of this class.
    
    Parameters:
    
    results -
    
    pathInfo -
    
    clsDesc -
  - OQLEnumeration
```
OQLEnumeration(QueryResults results)
```
- Method Detail
  - absolute
```
public boolean absolute(int row)
                 throws PersistenceException
```
    Description copied from interface: QueryResults
    
    moves the result of the query to the absolute position in the resultset.
    
    Specified by:
    
    absolute in interface QueryResults
    
    Parameters:
    
    row - The row to move to
    
    Returns:
    
    ???
    
    Throws:
    
    PersistenceException - A persistence error occured
  - size
```
public int size()
         throws PersistenceException
```
    Description copied from interface: QueryResults
    
    Finds the size of the resulting resultset from the query.
    
    Specified by:
    
    size in interface QueryResults
    
    Returns:
    
    Size of the resulting result set.
    
    Throws:
    
    PersistenceException - A persistence error occured
  - hasMoreElements
```
public boolean hasMoreElements()
```
    Specified by:
    
    hasMoreElements in interface java.util.Enumeration<java.lang.Object>
  - hasMore
```
public boolean hasMore()
                throws PersistenceException
```
    Description copied from interface: QueryResults
    
    Returns true if there are any more results in the result set. If an error occured reading the last result, an exception will be thrown and the result set cannot be used further.
    
    Specified by:
    
    hasMore in interface QueryResults
    
    Returns:
    
    True if there are any more results in the result set
    
    Throws:
    
    PersistenceException - An error with the persistence engine
  - hasMore
```
public boolean hasMore(boolean skipError)
                throws PersistenceException
```
    Throws:
    
    PersistenceException
  - nextElement
```
public java.lang.Object nextElement()
                             throws java.util.NoSuchElementException
```
    Specified by:
    
    nextElement in interface java.util.Enumeration<java.lang.Object>
    
    Throws:
    
    java.util.NoSuchElementException
  - next
```
public java.lang.Object next()
                      throws PersistenceException,
                             java.util.NoSuchElementException
```
    Description copied from interface: QueryResults
    
    Returns the next result in the result set. If there are no more results (a previous cal to QueryResults.hasMore() returns false) this method will throw an exceptin. If an error occured reading the last result, an exception will be thrown and the result set cannot be used further.
    
    Specified by:
    
    next in interface QueryResults
    
    Returns:
    
    The next result in the result set
    
    Throws:
    
    PersistenceException - An error with the persistence engine
    
    java.util.NoSuchElementException - There are no more results in the result set
  - close
```
public void close()
```
    Description copied from interface: QueryResults
    
    Closes the result set and releases all resources held by it.
    
    Specified by:
    
    close in interface QueryResults

Class OQLQueryImpl.OQLEnumeration

Constructor Summary

Method Summary

Methods inherited from interface java.util.Enumeration

Methods inherited from class java.lang.Object

Constructor Detail

OQLEnumeration

OQLEnumeration

Method Detail

absolute

size

hasMoreElements

hasMore

hasMore

nextElement

next

close