org.exolab.castor.jdo.engine

Class OQLQueryImpl.OQLEnumeration

java.lang.Object

org.exolab.castor.jdo.engine.OQLQueryImpl.OQLEnumeration

All Implemented Interfaces:

java.util.Enumeration, QueryResults

Enclosing class:

OQLQueryImpl

class OQLQueryImpl.OQLEnumeration
extends java.lang.Object
implements QueryResults, java.util.Enumeration

Enumeration implementation to traverse the result as returned by the execution of the OQL query.

Constructor Summary

Constructors

Constructor and Description
OQLEnumeration(QueryResults results)
OQLEnumeration(QueryResults results, java.util.Vector pathInfo, JDOClassDescriptor clsDesc) Creates an instance of this class.

Method Summary

Modifier and Type	Method and 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OQLEnumeration

OQLEnumeration(QueryResults results,
               java.util.Vector pathInfo,
               JDOClassDescriptor 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

See Also:

QueryResults.absolute(int)

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

See Also:

QueryResults.size()

hasMoreElements

public boolean hasMoreElements()

Specified by:

hasMoreElements in interface java.util.Enumeration

See Also:

Enumeration.hasMoreElements()

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

See Also:

QueryResults.hasMore()

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

Throws:

java.util.NoSuchElementException

See Also:

Enumeration.nextElement()

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

See Also:

QueryResults.next()

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

See Also:

QueryResults.close()