org.dspace.storage.rdbms

Class TableRowIterator

java.lang.Object

org.dspace.storage.rdbms.TableRowIterator

public class TableRowIterator
extends java.lang.Object

Represents the results of a database query

Version:

$Revision$

Author:

Peter Breton

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the Iterator and release any associated resources
protected void	finalize() Finalize -- this method is called when this object is GC-ed.
boolean	hasNext() Return true if there are more rows, false otherwise
TableRow	next() Deprecated. use next(org.dspace.core.Context) instead. Pass an existing database connection to this method to prevent opening a new one.
TableRow	next(Context context) Advance to the next row and return it.
void	setStatement(java.sql.Statement st) setStatement -- this method saves the statement used to do the query.
java.util.List<TableRow>	toList() Saves all the values returned by iterator into a list.

Methods inherited from class java.lang.Object

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

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Finalize -- this method is called when this object is GC-ed.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

setStatement

public void setStatement(java.sql.Statement st)

setStatement -- this method saves the statement used to do the query. We must keep this so that the statement can be closed when we are finished.

Parameters:

st - - The statement used to do the query that created this TableRowIterator

next

@Deprecated
public TableRow next()
              throws java.sql.SQLException

Deprecated. use next(org.dspace.core.Context) instead. Pass an existing database connection to this method to prevent opening a new one.

Advance to the next row and return it. Returns null if there are no more rows.

Returns:

- The next row, or null if no more rows

Throws:

java.sql.SQLException - - If a database error occurs while fetching values

next

public TableRow next(Context context)
              throws java.sql.SQLException

Advance to the next row and return it. Returns null if there are no more rows.

Parameters:

context - An existing database connection to reuse

Returns:

- The next row, or null if no more rows

Throws:

java.sql.SQLException - - If a database error occurs while fetching values

hasNext

public boolean hasNext()
                throws java.sql.SQLException

Return true if there are more rows, false otherwise

Returns:

- true if there are more rows, false otherwise

Throws:

java.sql.SQLException - - If a database error occurs while fetching values

toList

public java.util.List<TableRow> toList()
                                throws java.sql.SQLException

Saves all the values returned by iterator into a list. As a side effect the result set is closed and no more operations can be performed on this object.

Returns:

- A list of all the values returned by the iterator.

Throws:

java.sql.SQLException - - If a database error occurs while fetching values

close

public void close()

Close the Iterator and release any associated resources